MeshSourceBase provides the internal interface for mesh sources, i.e., objects such as mesh generators and file readers that can produce a mesh object. More...

Inheritance diagram for Sundance::MeshSourceBase:

Public Member Functions
	MeshSourceBase (const MeshType &meshType, const MPIComm &comm)
	Construct with a mesh type and MPI communicator.
	MeshSourceBase (const ParameterList &params)
	Construct from a parameter list.
virtual	~MeshSourceBase ()
	virtual dtor
Mesh	getMesh () const
	Get a mesh from the source.
Extraction of attributes
void	getAttributes (RCP< Array< Array< double > > > &nodeAttributes, RCP< Array< Array< double > > > &elemAttributes) const
Printable interface
virtual void	print (std::ostream &os) const
	Print to a stream.
Describable interface
virtual std::string	description () const
	Print to a stream.
const MPIComm &	comm () const
	access to the MPI communicator
Protected Member Functions
int	myRank () const
	Get processor rank.
int	nProc () const
	Get number of processors.
virtual Mesh	fillMesh () const =0
	Fill a mesh object with data from the source.
Mesh	createMesh (int dim) const
	createMesh() physically allocates the mesh object
RCP< Array< Array< double > > > &	nodeAttributes () const
	internal access to the node attributes
RCP< Array< Array< double > > > &	elemAttributes () const
	internal access to the element attributes
Private Attributes
Mesh	cachedMesh_
bool	hasCachedMesh_
MeshType	meshType_
MPIComm	comm_
RCP< Array< Array< double > > >	elemAttributes_
RCP< Array< Array< double > > >	nodeAttributes_

Detailed Description

MeshSourceBase provides the internal interface for mesh sources, i.e., objects such as mesh generators and file readers that can produce a mesh object.

The action of a mesh source should be independent of the internal mesh representation used. To allow user-level specification of the type of internal mesh representation to be used, a MeshSourceBase is constructed with a MeshType object which acts as a factory to produce empty meshes.

Mesh sources are constructed with a MPI communicator. If the communicator has more than one processor, the mesh created will be distributed.

Writing your own MeshSourceBase subtype

The only method you will need to override is

virtual Mesh fillMesh() const

which is where you fill in a mesh object and return it. This method should usually physically create the mesh with a call to createMesh(), ensuring that the correct mesh representation type is created using the MeshType factory with which the source was constructed.

See the PartitionedLineMesher source code for a very simple example of how to write a mesh source subtype.

Optionally, you can override the description() method to provide more informative descriptive output than the std::string "MeshSourceBase[unknown subtype]".

Definition at line 79 of file SundanceMeshSourceBase.hpp.

Constructor & Destructor Documentation

MeshSourceBase::MeshSourceBase	(	const MeshType &	meshType,
		const MPIComm &	comm
	)

Construct with a mesh type and MPI communicator.

Definition at line 13 of file SundanceMeshSourceBase.cpp.

MeshSourceBase::MeshSourceBase ( const ParameterList & params )

Construct from a parameter list.

Definition at line 24 of file SundanceMeshSourceBase.cpp.

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

virtual dtor

Definition at line 94 of file SundanceMeshSourceBase.hpp.

Member Function Documentation

const MPIComm& Sundance::MeshSourceBase::comm ( ) const [inline]

access to the MPI communicator

Definition at line 121 of file SundanceMeshSourceBase.hpp.

References comm_.

Referenced by Sundance::PartitionedLineMesher::fillMesh(), myRank(), and nProc().

Mesh MeshSourceBase::createMesh ( int dim ) const [protected]

virtual std::string Sundance::MeshSourceBase::description ( ) const [inline, virtual]

Print to a stream.

Reimplemented in Sundance::BamgMeshReader, Sundance::ExodusMeshReader, Sundance::ExodusNetCDFMeshReader, Sundance::HNMesher2D, Sundance::HNMesher3D, Sundance::OneTriangleMesher, Sundance::OneTetMesher, Sundance::PartitionedLineMesher, Sundance::PartitionedRectangleMesher, Sundance::PeanoMesher2D, Sundance::PeanoMesher3D, Sundance::PeriodicLineMesher, and Sundance::TriangleMeshReader.

Definition at line 117 of file SundanceMeshSourceBase.hpp.

Referenced by print().

RCP<Array<Array<double> > >& Sundance::MeshSourceBase::elemAttributes ( ) const [inline, protected]

internal access to the element attributes

Definition at line 146 of file SundanceMeshSourceBase.hpp.

References elemAttributes_.

Referenced by Sundance::ExodusMeshReader::fillMesh(), Sundance::TriangleMeshReader::readElems(), and Sundance::BamgMeshReader::readMesh().

virtual Mesh Sundance::MeshSourceBase::fillMesh ( ) const [protected, pure virtual]

Fill a mesh object with data from the source.

Subclass implementors will need to provide a fillMesh() for their subclass. Implementors should use the createMesh() method for the allocation of the new mesh.

Implemented in Sundance::BamgMeshReader, Sundance::ExodusMeshReader, Sundance::ExodusNetCDFMeshReader, Sundance::HNMesher2D, Sundance::HNMesher3D, Sundance::OneTriangleMesher, Sundance::OneTetMesher, Sundance::PartitionedLineMesher, Sundance::PartitionedRectangleMesher, Sundance::PeanoMesher2D, Sundance::PeanoMesher3D, Sundance::PeriodicLineMesher, and Sundance::TriangleMeshReader.