/usr/include/trilinos/Thyra_DefaultSpmdMultiVectorFileIO.hpp is in libtrilinos-thyra-dev 12.4.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 | // @HEADER
// ***********************************************************************
//
// Thyra: Interfaces and Support for Abstract Numerical Algorithms
// Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.gov)
//
// ***********************************************************************
// @HEADER
#ifndef THYRA_DEFAULT_SPMD_MULTI_VECTOR_FILE_IO_HPP
#define THYRA_DEFAULT_SPMD_MULTI_VECTOR_FILE_IO_HPP
#include "Thyra_MultiVectorFileIOBase.hpp"
#include "Thyra_SpmdMultiVectorSerializer.hpp"
#include "Teuchos_Utils.hpp"
namespace Thyra {
/** \brief Concrete implementation of <tt>MultiVectorFileIO</tt> that reads
* and writes SPMD-based (multi)vectors to and from files.
*
* The file accessed by each process process is
* <tt>fileNameBase.extentionTagName.numProcs.procRank</tt>. If
* <tt>extentionTagName==""</tt> then the file with the name
* <tt>fileNameBase.numProcs.procRank</tt> is accessed in each process. By
* setting up different file name extension information (see
* <tt>setFileNameExtension()</tt>), the client can carefully control how file
* base names are mapped into actual sets of files.
*
* ToDo: This implementation will have to be refactored once I refactor how
* SPMD-based vectors and multi-vectors can be accessed in a general way.
*
* \ingroup Thyra_Op_Vec_adapters_Spmd_concrete_std_grp
*/
template<class Scalar>
class DefaultSpmdMultiVectorFileIO
: public MultiVectorFileIOBase<Scalar>
{
public:
/** \name Constructors/initializers/accessors */
//@{
/** \brief Construct with file extension information (calls
* <tt>setFileNameExtension()</tt>).
*/
DefaultSpmdMultiVectorFileIO(
const std::string &extensionTagName = ""
,const int numProcs = -1
,const int procRank = -1
);
/** \brief Set file name extension information to disambiguate files on
* different processes and from other files.
*
* \param extensionTagName
* [in] An extension name string that will be appended the beginning
* of full file extension. Default is "".
* \param numProcs
* [in] The total number of processes in the communicator.
* Default value is <tt>-1</tt>.
* \param procRank
* [in] The rank of this process.
* Default value is <tt>-1</tt>.
*
* If <tt>numProcs < 0</tt> then <tt>procRank</tt> and <tt>numProcs</tt>
* will be determined from <tt>Teuchos::GlobalMPISession</tt>.
*/
void setFileNameExtension(
const std::string &extensionTagName = ""
,const int numProcs = -1
,const int procRank = -1
);
/** brief Return the file name that is used in this process. */
std::string getLocalFileName( const std::string &fileNameBase ) const;
//@}
/** \name Overridden from MultiVectorFileIOBase */
//@{
/** \brief . */
bool isCompatible( const MultiVectorBase<Scalar> &mv ) const;
/** \brief . */
void readMultiVectorFromFile(
const std::string &fileNameBase
,Thyra::MultiVectorBase<Scalar> *mv
) const;
/** \brief . */
void writeMultiVectorToFile(
const Thyra::MultiVectorBase<Scalar> &mv
,const std::string &fileNameBase
) const;
//@}
private:
std::string localFileNameExtension_;
bool useBinaryMode_;
mutable SpmdMultiVectorSerializer<Scalar> mvSerializer_;
};
// ///////////////////////////
// Implementations
template<class Scalar>
DefaultSpmdMultiVectorFileIO<Scalar>::DefaultSpmdMultiVectorFileIO(
const std::string &extensionTagName
,const int numProcs
,const int procRank
)
:useBinaryMode_(false) // ToDo: Make this adjustable!
,mvSerializer_(useBinaryMode_)
{
setFileNameExtension(extensionTagName,numProcs,procRank);
}
template<class Scalar>
void DefaultSpmdMultiVectorFileIO<Scalar>::setFileNameExtension(
const std::string &extensionTagName
,const int numProcs
,const int procRank
)
{
const std::string
endExtension = Teuchos::Utils::getParallelExtension(procRank,numProcs);
if(extensionTagName.length())
localFileNameExtension_ = extensionTagName+"."+endExtension;
else
localFileNameExtension_ = endExtension;
}
template<class Scalar>
std::string
DefaultSpmdMultiVectorFileIO<Scalar>::getLocalFileName(
const std::string &fileNameBase
) const
{
std::ostringstream parallelFileName;
parallelFileName << fileNameBase;
if(localFileNameExtension_.length())
parallelFileName << "." << localFileNameExtension_;
return parallelFileName.str();
}
template<class Scalar>
bool DefaultSpmdMultiVectorFileIO<Scalar>::isCompatible(
const MultiVectorBase<Scalar> &mv
) const
{
return mvSerializer_.isCompatible(mv);
}
template<class Scalar>
void DefaultSpmdMultiVectorFileIO<Scalar>::readMultiVectorFromFile(
const std::string &fileNameBase
,Thyra::MultiVectorBase<Scalar> *mv
) const
{
TEUCHOS_TEST_FOR_EXCEPT(!mv);
const std::string fileName = getLocalFileName(fileNameBase);
std::ifstream in_file(fileName.c_str());
TEUCHOS_TEST_FOR_EXCEPTION(
in_file.eof(), std::logic_error
,"Error, the file \""<<fileName<<"\" could not be opened for input!"
);
mvSerializer_.binaryMode(useBinaryMode_);
mvSerializer_.deserialize(in_file,mv);
}
template<class Scalar>
void DefaultSpmdMultiVectorFileIO<Scalar>::writeMultiVectorToFile(
const Thyra::MultiVectorBase<Scalar> &mv
,const std::string &fileNameBase
) const
{
const std::string fileName = getLocalFileName(fileNameBase);
std::ofstream out_file(fileName.c_str());
mvSerializer_.binaryMode(useBinaryMode_);
mvSerializer_.serialize(mv,out_file);
}
} // namespace Thyra
#endif // THYRA_DEFAULT_SPMD_MULTI_VECTOR_FILE_IO_HPP
|