Thyra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Thyra_MultiVectorFileIOBase.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Thyra: Interfaces and Support for Abstract Numerical Algorithms
5 // Copyright (2004) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef THYRA_MULTI_VECTOR_FILE_IO_BASE_HPP
43 #define THYRA_MULTI_VECTOR_FILE_IO_BASE_HPP
44 
45 #include "Thyra_OperatorVectorTypes.hpp"
46 #include "Teuchos_ParameterListAcceptor.hpp"
47 #include "Teuchos_VerboseObject.hpp"
48 
49 
50 namespace Thyra {
51 
52 
81 template<class Scalar>
83  : virtual public Teuchos::VerboseObject<MultiVectorFileIOBase<Scalar> >
84 {
85 public:
86 
89  virtual bool isCompatible( const MultiVectorBase<Scalar> &mv ) const = 0;
90 
107  virtual void readMultiVectorFromFile(
108  const std::string &fileNameBase,
110  ) const = 0;
111 
123  virtual void writeMultiVectorToFile(
125  const std::string &fileNameBase
126  ) const = 0;
127 
129 
130 };
131 
132 
138 template<class Scalar>
141  const MultiVectorFileIOBase<Scalar> &fileIO,
142  const std::string &fileNameBase,
143  const VectorSpaceBase<Scalar> &vecSpc
144  )
145 {
146  Teuchos::RCP<VectorBase<Scalar> > v = createMember(vecSpc);
147  fileIO.readMultiVectorFromFile(fileNameBase,&*v);
148  return v;
149 }
150 
151 
152 } // namespace Thyra
153 
154 
155 #endif // THYRA_MULTI_VECTOR_FILE_IO_BASE_HPP
virtual bool isCompatible(const MultiVectorBase< Scalar > &mv) const =0
Return if the given multi-vector is compatible with this implementation.
Abstract interface for objects that represent a space for vectors.
Interface for a collection of column vectors called a multi-vector.
virtual void writeMultiVectorToFile(const Thyra::MultiVectorBase< Scalar > &mv, const std::string &fileNameBase) const =0
Write a (multi)vector to a file given the file base name.
Abstract strategy interface for reading and writing (multi)vector objects to and from files...
virtual void readMultiVectorFromFile(const std::string &fileNameBase, Thyra::MultiVectorBase< Scalar > *mv) const =0
Read a (multi)vector from a file given the file base name.
Teuchos::RCP< VectorBase< Scalar > > readVectorFromFile(const MultiVectorFileIOBase< Scalar > &fileIO, const std::string &fileNameBase, const VectorSpaceBase< Scalar > &vecSpc)
Read a vector from file(s) given the file base name and a vector space.