Inheritance diagram for Sundance::FieldWriterBase:

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_

Detailed Description

FieldWriterBase is a base class for objects that write fields and/or meshes to a stream.

Definition at line 57 of file SundanceFieldWriterBase.hpp.

Constructor & Destructor Documentation

FieldWriterBase::FieldWriterBase ( const std::string & filename )

Definition at line 54 of file SundanceFieldWriterBase.cpp.

virtual Sundance::FieldWriterBase::~FieldWriterBase ( ) [inline, virtual]

virtual dtor

Definition at line 65 of file SundanceFieldWriterBase.hpp.

Member Function Documentation

void FieldWriterBase::addCommentLine ( const std::string & line ) [virtual]

add a comment

Definition at line 146 of file SundanceFieldWriterBase.cpp.

References comments_.

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 108 of file SundanceFieldWriterBase.cpp.

References cellScalarFields_, cellScalarNames_, cellVectorFields_, cellVectorNames_, pointScalarFields_, pointScalarNames_, pointVectorFields_, and pointVectorNames_.

void FieldWriterBase::addMesh ( const Mesh & mesh )

Definition at line 94 of file SundanceFieldWriterBase.cpp.

References Sundance::Mesh::id(), mesh(), mesh_, and meshID_.

const Array<RCP<FieldBase> >& Sundance::FieldWriterBase::cellScalarFields ( ) const [inline, protected]

Definition at line 115 of file SundanceFieldWriterBase.hpp.

References cellScalarFields_.

Referenced by Sundance::VTKWriter::writeCellData(), and Sundance::TriangleWriter::writeCells().

Array<RCP<FieldBase> >& Sundance::FieldWriterBase::cellScalarFields ( ) [inline, protected]

Definition at line 116 of file SundanceFieldWriterBase.hpp.

References cellScalarFields_.

const Array<string>& Sundance::FieldWriterBase::cellScalarNames ( ) const [inline, protected]

Definition at line 121 of file SundanceFieldWriterBase.hpp.

References cellScalarNames_.

Referenced by Sundance::VTKWriter::writeCellData(), and Sundance::TriangleWriter::writeHeader().

Array<string>& Sundance::FieldWriterBase::cellScalarNames ( ) [inline, protected]

Definition at line 122 of file SundanceFieldWriterBase.hpp.

References cellScalarNames_.

const Array<RCP<FieldBase> >& Sundance::FieldWriterBase::cellVectorFields ( ) const [inline, protected]

Definition at line 127 of file SundanceFieldWriterBase.hpp.

References cellVectorFields_.

Referenced by Sundance::VTKWriter::writeCellData().

Array<RCP<FieldBase> >& Sundance::FieldWriterBase::cellVectorFields ( ) [inline, protected]

Definition at line 128 of file SundanceFieldWriterBase.hpp.

References cellVectorFields_.

const Array<string>& Sundance::FieldWriterBase::cellVectorNames ( ) const [inline, protected]

Definition at line 133 of file SundanceFieldWriterBase.hpp.

References cellVectorNames_.

Referenced by Sundance::VTKWriter::writeCellData().

Array<string>& Sundance::FieldWriterBase::cellVectorNames ( ) [inline, protected]

Definition at line 134 of file SundanceFieldWriterBase.hpp.

References cellVectorNames_.

const Array<string>& Sundance::FieldWriterBase::comments ( ) const [inline, protected]

Definition at line 109 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(), and Sundance::TriangleWriter::writePoints().

Array<string>& Sundance::FieldWriterBase::comments ( ) [inline, protected]

Definition at line 110 of file SundanceFieldWriterBase.hpp.

References comments_.

const std::string& Sundance::FieldWriterBase::filename ( ) const [inline, protected]

Definition at line 98 of file SundanceFieldWriterBase.hpp.

References filename_.

Referenced by Sundance::VTKWriter::lowLevelWrite(), Sundance::VTKWriter::write(), Sundance::VerboseFieldWriter::write(), Sundance::MatlabWriter::write(), Sundance::TriangleWriter::write(), and Sundance::DSVWriter::write().

void FieldWriterBase::impersonateParallelProc	(	int	nProc,
		int	rank
	)		`[virtual]`

Definition at line 73 of file SundanceFieldWriterBase.cpp.

References myRank_, nProc(), and nProc_.

int FieldWriterBase::myRank ( ) const [protected]

Definition at line 85 of file SundanceFieldWriterBase.cpp.

References Sundance::Mesh::comm(), Playa::MPIComm::getRank(), mesh(), and myRank_.

Referenced by Sundance::VTKWriter::lowLevelWrite(), Sundance::VTKWriter::write(), Sundance::TriangleWriter::write(), Sundance::VerboseFieldWriter::write(), and Sundance::TriangleWriter::writeParallelInfo().

int FieldWriterBase::nProc ( ) const [protected]

Definition at line 79 of file SundanceFieldWriterBase.cpp.

References Sundance::Mesh::comm(), Playa::MPIComm::getNProc(), mesh(), and nProc_.

Referenced by impersonateParallelProc(), Sundance::VTKWriter::lowLevelWrite(), Sundance::VTKWriter::write(), Sundance::VerboseFieldWriter::write(), Sundance::TriangleWriter::write(), Sundance::TriangleWriter::writeHeader(), and Sundance::TriangleWriter::writeParallelInfo().

const Array<RCP<FieldBase> >& Sundance::FieldWriterBase::pointScalarFields ( ) const [inline, protected]

Definition at line 112 of file SundanceFieldWriterBase.hpp.

References pointScalarFields_.

Referenced by Sundance::MatlabWriter::write(), Sundance::DSVWriter::write(), Sundance::VTKWriter::writePointData(), and Sundance::TriangleWriter::writePoints().

Array<RCP<FieldBase> >& Sundance::FieldWriterBase::pointScalarFields ( ) [inline, protected]

Definition at line 113 of file SundanceFieldWriterBase.hpp.

References pointScalarFields_.

const Array<string>& Sundance::FieldWriterBase::pointScalarNames ( ) const [inline, protected]

Definition at line 118 of file SundanceFieldWriterBase.hpp.

References pointScalarNames_.

Referenced by Sundance::TriangleWriter::writeHeader(), and Sundance::VTKWriter::writePointData().

Array<string>& Sundance::FieldWriterBase::pointScalarNames ( ) [inline, protected]

Definition at line 119 of file SundanceFieldWriterBase.hpp.

References pointScalarNames_.

const Array<RCP<FieldBase> >& Sundance::FieldWriterBase::pointVectorFields ( ) const [inline, protected]

Definition at line 124 of file SundanceFieldWriterBase.hpp.

References pointVectorFields_.

Referenced by Sundance::VTKWriter::writePointData().

Array<RCP<FieldBase> >& Sundance::FieldWriterBase::pointVectorFields ( ) [inline, protected]

Definition at line 125 of file SundanceFieldWriterBase.hpp.

References pointVectorFields_.

const Array<string>& Sundance::FieldWriterBase::pointVectorNames ( ) const [inline, protected]

Definition at line 130 of file SundanceFieldWriterBase.hpp.

References pointVectorNames_.

Referenced by Sundance::VTKWriter::writePointData().

Array<string>& Sundance::FieldWriterBase::pointVectorNames ( ) [inline, protected]

Definition at line 131 of file SundanceFieldWriterBase.hpp.

References pointVectorNames_.

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 85 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 107 of file SundanceFieldWriterBase.hpp.

double Sundance::FieldWriterBase::undefinedValue ( ) const [inline, protected]

Definition at line 90 of file SundanceFieldWriterBase.hpp.

References undefinedValue_.

Referenced by Sundance::VTKWriter::writeDataArray().

virtual void Sundance::FieldWriterBase::write ( ) const [pure virtual]

Implemented in Sundance::DSVWriter, Sundance::ExodusWriter, Sundance::MatlabWriter, Sundance::TriangleWriter, Sundance::VerboseFieldWriter, and Sundance::VTKWriter.

virtual void Sundance::FieldWriterBase::writeCommentLine ( const std::string & line ) const [inline, protected, virtual]

Definition at line 136 of file SundanceFieldWriterBase.hpp.