Public Member Functions | |
FieldWriterBase (const std::string &filename) | |
virtual | ~FieldWriterBase () |
void | addMesh (const Mesh &mesh) |
virtual void | addCommentLine (const std::string &line) |
virtual void | addField (const std::string &name, const RCP< FieldBase > &field) |
virtual void | write () const =0 |
virtual void | impersonateParallelProc (int nProc, int rank) |
void | setUndefinedValue (const double &x) |
Protected Member Functions | |
double | undefinedValue () const |
int | nProc () const |
int | myRank () const |
const std::string & | filename () const |
const Mesh & | mesh () const |
virtual bool | supportsSpecializedVectors () const |
const Array< string > & | comments () const |
Array< string > & | comments () |
const Array< RCP< FieldBase > > & | pointScalarFields () const |
Array< RCP< FieldBase > > & | pointScalarFields () |
const Array< RCP< FieldBase > > & | cellScalarFields () const |
Array< RCP< FieldBase > > & | cellScalarFields () |
const Array< string > & | pointScalarNames () const |
Array< string > & | pointScalarNames () |
const Array< string > & | cellScalarNames () const |
Array< string > & | cellScalarNames () |
const Array< RCP< FieldBase > > & | pointVectorFields () const |
Array< RCP< FieldBase > > & | pointVectorFields () |
const Array< RCP< FieldBase > > & | cellVectorFields () const |
Array< RCP< FieldBase > > & | cellVectorFields () |
const Array< string > & | pointVectorNames () const |
Array< string > & | pointVectorNames () |
const Array< string > & | cellVectorNames () const |
Array< string > & | cellVectorNames () |
virtual void | writeCommentLine (const std::string &line) const |
Private Attributes | |
std::string | filename_ |
Mesh | mesh_ |
int | nProc_ |
int | myRank_ |
int | meshID_ |
Array< string > | comments_ |
Array< RCP< FieldBase > > | pointScalarFields_ |
Array< RCP< FieldBase > > | cellScalarFields_ |
Array< RCP< FieldBase > > | pointVectorFields_ |
Array< RCP< FieldBase > > | cellVectorFields_ |
Array< string > | pointScalarNames_ |
Array< string > | cellScalarNames_ |
Array< string > | pointVectorNames_ |
Array< string > | cellVectorNames_ |
double | undefinedValue_ |
Definition at line 46 of file SundanceFieldWriterBase.hpp.
FieldWriterBase::FieldWriterBase | ( | const std::string & | filename | ) |
Definition at line 43 of file SundanceFieldWriterBase.cpp.
virtual Sundance::FieldWriterBase::~FieldWriterBase | ( | ) | [inline, virtual] |
virtual dtor
Definition at line 54 of file SundanceFieldWriterBase.hpp.
void FieldWriterBase::addCommentLine | ( | const std::string & | line | ) | [virtual] |
void FieldWriterBase::addField | ( | const std::string & | name, | |
const RCP< FieldBase > & | field | |||
) | [virtual] |
add a field, tagging it with the given std::string as a name
Definition at line 97 of file SundanceFieldWriterBase.cpp.
References cellScalarFields_, cellScalarNames_, cellVectorFields_, cellVectorNames_, pointScalarFields_, pointScalarNames_, pointVectorFields_, and pointVectorNames_.
void FieldWriterBase::addMesh | ( | const Mesh & | mesh | ) |
Definition at line 83 of file SundanceFieldWriterBase.cpp.
References Sundance::Mesh::id(), mesh_, and meshID_.
Array<RCP<FieldBase> >& Sundance::FieldWriterBase::cellScalarFields | ( | ) | [inline, protected] |
const Array<RCP<FieldBase> >& Sundance::FieldWriterBase::cellScalarFields | ( | ) | const [inline, protected] |
Definition at line 104 of file SundanceFieldWriterBase.hpp.
References cellScalarFields_.
Referenced by Sundance::ExodusWriter::findBlocks(), Sundance::VTKWriter::writeCellData(), Sundance::TriangleWriter::writeCells(), and Sundance::ExodusWriter::writeFields().
Array<string>& Sundance::FieldWriterBase::cellScalarNames | ( | ) | [inline, protected] |
const Array<string>& Sundance::FieldWriterBase::cellScalarNames | ( | ) | const [inline, protected] |
Definition at line 110 of file SundanceFieldWriterBase.hpp.
References cellScalarNames_.
Referenced by Sundance::VTKWriter::writeCellData(), Sundance::ExodusWriter::writeFields(), and Sundance::TriangleWriter::writeHeader().
Array<RCP<FieldBase> >& Sundance::FieldWriterBase::cellVectorFields | ( | ) | [inline, protected] |
const Array<RCP<FieldBase> >& Sundance::FieldWriterBase::cellVectorFields | ( | ) | const [inline, protected] |
Definition at line 116 of file SundanceFieldWriterBase.hpp.
References cellVectorFields_.
Referenced by Sundance::VTKWriter::writeCellData().
Array<string>& Sundance::FieldWriterBase::cellVectorNames | ( | ) | [inline, protected] |
const Array<string>& Sundance::FieldWriterBase::cellVectorNames | ( | ) | const [inline, protected] |
Definition at line 122 of file SundanceFieldWriterBase.hpp.
References cellVectorNames_.
Referenced by Sundance::VTKWriter::writeCellData().
Array<string>& Sundance::FieldWriterBase::comments | ( | ) | [inline, protected] |
const Array<string>& Sundance::FieldWriterBase::comments | ( | ) | const [inline, protected] |
Definition at line 98 of file SundanceFieldWriterBase.hpp.
References comments_.
Referenced by Sundance::VTKWriter::lowLevelWrite(), Sundance::TriangleWriter::writeCells(), Sundance::TriangleWriter::writeEdges(), Sundance::TriangleWriter::writeFaces(), Sundance::TriangleWriter::writeHeader(), Sundance::TriangleWriter::writeParallelInfo(), Sundance::ExodusWriter::writeParallelInfo(), and Sundance::TriangleWriter::writePoints().
const std::string& Sundance::FieldWriterBase::filename | ( | ) | const [inline, protected] |
Definition at line 87 of file SundanceFieldWriterBase.hpp.
References filename_.
Referenced by Sundance::VTKWriter::write(), Sundance::VerboseFieldWriter::write(), Sundance::TriangleWriter::write(), Sundance::MatlabWriter::write(), Sundance::ExodusWriter::write(), Sundance::DSVWriter::write(), and Sundance::ExodusWriter::writeMesh().
void FieldWriterBase::impersonateParallelProc | ( | int | nProc, | |
int | rank | |||
) | [virtual] |
const Mesh& Sundance::FieldWriterBase::mesh | ( | ) | const [inline, protected] |
Definition at line 90 of file SundanceFieldWriterBase.hpp.
References mesh_.
Referenced by Sundance::ExodusWriter::findBlocks(), Sundance::ExodusWriter::findNodeSets(), Sundance::VTKWriter::lowLevelWrite(), myRank(), nProc(), Sundance::VerboseFieldWriter::write(), Sundance::TriangleWriter::write(), Sundance::MatlabWriter::write(), Sundance::DSVWriter::write(), Sundance::VTKWriter::writeCells(), Sundance::TriangleWriter::writeCells(), Sundance::VTKWriter::writeDataArray(), Sundance::TriangleWriter::writeEdges(), Sundance::TriangleWriter::writeFaces(), Sundance::ExodusWriter::writeFields(), Sundance::ExodusWriter::writeMesh(), Sundance::TriangleWriter::writeParallelInfo(), Sundance::ExodusWriter::writeParallelInfo(), Sundance::VTKWriter::writePoints(), and Sundance::TriangleWriter::writePoints().
int FieldWriterBase::myRank | ( | ) | const [protected] |
Definition at line 74 of file SundanceFieldWriterBase.cpp.
References Sundance::Mesh::comm(), Playa::MPIComm::getRank(), mesh(), and myRank_.
Referenced by Sundance::VTKWriter::lowLevelWrite(), Sundance::VTKWriter::write(), Sundance::VerboseFieldWriter::write(), Sundance::TriangleWriter::write(), Sundance::ExodusWriter::write(), Sundance::TriangleWriter::writeParallelInfo(), and Sundance::ExodusWriter::writeParallelInfo().
int FieldWriterBase::nProc | ( | ) | const [protected] |
Definition at line 68 of file SundanceFieldWriterBase.cpp.
References Sundance::Mesh::comm(), Playa::MPIComm::getNProc(), mesh(), and nProc_.
Referenced by Sundance::VTKWriter::lowLevelWrite(), Sundance::VTKWriter::write(), Sundance::VerboseFieldWriter::write(), Sundance::TriangleWriter::write(), Sundance::ExodusWriter::write(), Sundance::TriangleWriter::writeHeader(), Sundance::TriangleWriter::writeParallelInfo(), and Sundance::ExodusWriter::writeParallelInfo().
Array<RCP<FieldBase> >& Sundance::FieldWriterBase::pointScalarFields | ( | ) | [inline, protected] |
const Array<RCP<FieldBase> >& Sundance::FieldWriterBase::pointScalarFields | ( | ) | const [inline, protected] |
Definition at line 101 of file SundanceFieldWriterBase.hpp.
References pointScalarFields_.
Referenced by Sundance::ExodusWriter::findNodeSets(), Sundance::MatlabWriter::write(), Sundance::DSVWriter::write(), Sundance::ExodusWriter::writeFields(), Sundance::VTKWriter::writePointData(), and Sundance::TriangleWriter::writePoints().
Array<string>& Sundance::FieldWriterBase::pointScalarNames | ( | ) | [inline, protected] |
const Array<string>& Sundance::FieldWriterBase::pointScalarNames | ( | ) | const [inline, protected] |
Definition at line 107 of file SundanceFieldWriterBase.hpp.
References pointScalarNames_.
Referenced by Sundance::ExodusWriter::writeFields(), Sundance::TriangleWriter::writeHeader(), and Sundance::VTKWriter::writePointData().
Array<RCP<FieldBase> >& Sundance::FieldWriterBase::pointVectorFields | ( | ) | [inline, protected] |
const Array<RCP<FieldBase> >& Sundance::FieldWriterBase::pointVectorFields | ( | ) | const [inline, protected] |
Definition at line 113 of file SundanceFieldWriterBase.hpp.
References pointVectorFields_.
Referenced by Sundance::VTKWriter::writePointData().
Array<string>& Sundance::FieldWriterBase::pointVectorNames | ( | ) | [inline, protected] |
const Array<string>& Sundance::FieldWriterBase::pointVectorNames | ( | ) | const [inline, protected] |
Definition at line 119 of file SundanceFieldWriterBase.hpp.
References pointVectorNames_.
Referenced by Sundance::VTKWriter::writePointData().
void Sundance::FieldWriterBase::setUndefinedValue | ( | const double & | x | ) | [inline] |
set the numerical value to be written at cells on which a field is undefined.
Definition at line 74 of file SundanceFieldWriterBase.hpp.
References undefinedValue_.
virtual bool Sundance::FieldWriterBase::supportsSpecializedVectors | ( | ) | const [inline, protected, virtual] |
Indicate whether the given writer subtype does anything special for vector fields. Default is false, in which case vectors are simply written as a list of scalars.
Definition at line 96 of file SundanceFieldWriterBase.hpp.
double Sundance::FieldWriterBase::undefinedValue | ( | ) | const [inline, protected] |
Definition at line 79 of file SundanceFieldWriterBase.hpp.
References undefinedValue_.
Referenced by Sundance::VTKWriter::writeDataArray().
virtual void Sundance::FieldWriterBase::write | ( | ) | const [pure virtual] |
virtual void Sundance::FieldWriterBase::writeCommentLine | ( | const std::string & | line | ) | const [inline, protected, virtual] |
Definition at line 125 of file SundanceFieldWriterBase.hpp.
Array<RCP<FieldBase> > Sundance::FieldWriterBase::cellScalarFields_ [private] |
Definition at line 141 of file SundanceFieldWriterBase.hpp.
Referenced by addField(), and cellScalarFields().
Array<string> Sundance::FieldWriterBase::cellScalarNames_ [private] |
Definition at line 145 of file SundanceFieldWriterBase.hpp.
Referenced by addField(), and cellScalarNames().
Array<RCP<FieldBase> > Sundance::FieldWriterBase::cellVectorFields_ [private] |
Definition at line 143 of file SundanceFieldWriterBase.hpp.
Referenced by addField(), and cellVectorFields().
Array<string> Sundance::FieldWriterBase::cellVectorNames_ [private] |
Definition at line 147 of file SundanceFieldWriterBase.hpp.
Referenced by addField(), and cellVectorNames().
Array<string> Sundance::FieldWriterBase::comments_ [private] |
Definition at line 138 of file SundanceFieldWriterBase.hpp.
Referenced by addCommentLine(), and comments().
std::string Sundance::FieldWriterBase::filename_ [private] |
Mesh Sundance::FieldWriterBase::mesh_ [private] |
int Sundance::FieldWriterBase::meshID_ [private] |
int Sundance::FieldWriterBase::myRank_ [private] |
Definition at line 134 of file SundanceFieldWriterBase.hpp.
Referenced by impersonateParallelProc(), and myRank().
int Sundance::FieldWriterBase::nProc_ [private] |
Definition at line 132 of file SundanceFieldWriterBase.hpp.
Referenced by impersonateParallelProc(), and nProc().
Array<RCP<FieldBase> > Sundance::FieldWriterBase::pointScalarFields_ [private] |
Definition at line 140 of file SundanceFieldWriterBase.hpp.
Referenced by addField(), and pointScalarFields().
Array<string> Sundance::FieldWriterBase::pointScalarNames_ [private] |
Definition at line 144 of file SundanceFieldWriterBase.hpp.
Referenced by addField(), and pointScalarNames().
Array<RCP<FieldBase> > Sundance::FieldWriterBase::pointVectorFields_ [private] |
Definition at line 142 of file SundanceFieldWriterBase.hpp.
Referenced by addField(), and pointVectorFields().
Array<string> Sundance::FieldWriterBase::pointVectorNames_ [private] |
Definition at line 146 of file SundanceFieldWriterBase.hpp.
Referenced by addField(), and pointVectorNames().
double Sundance::FieldWriterBase::undefinedValue_ [private] |
Definition at line 149 of file SundanceFieldWriterBase.hpp.
Referenced by setUndefinedValue(), and undefinedValue().