AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM > Class Template Reference

#include <AbstractMeshWriter.hpp>

Inherited by AbstractTetrahedralMeshWriter< ELEMENT_DIM, SPACE_DIM >, and VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >.

Collaboration diagram for AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 AbstractMeshWriter (const std::string &rDirectory, const std::string &rBaseName, const bool clearOutputDir=true)
virtual ~AbstractMeshWriter ()
std::string GetOutputDirectory ()
virtual unsigned GetNumNodes ()
unsigned GetNumElements ()
unsigned GetNumBoundaryFaces ()
unsigned GetNumBoundaryEdges ()
virtual std::vector< double > GetNextNode ()
virtual ElementData GetNextElement ()
void SetNextBoundaryFace (std::vector< unsigned > nextFace)
virtual void WriteFiles ()=0
void WriteFilesUsingMeshReader (AbstractMeshReader< ELEMENT_DIM, SPACE_DIM > &rMeshReader)

Protected Attributes

OutputFileHandler * mpOutputFileHandler
std::string mBaseName
std::vector< std::vector
< unsigned > > 		mBoundaryFaceData
AbstractMeshReader
< ELEMENT_DIM, SPACE_DIM > * 		mpMeshReader
unsigned mNumNodes
unsigned mNumElements

Detailed Description

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
class AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >

An abstract mesh writer class.

Definition at line 43 of file AbstractMeshWriter.hpp.

Constructor & Destructor Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::AbstractMeshWriter ( const std::string &  rDirectory,
const std::string &  rBaseName,
const bool  clearOutputDir = true 
) [inline]

Constructor.

Parameters:
rDirectory the directory in which to write the mesh to file
rBaseName the base name of the files in which to write the mesh data
clearOutputDir whether to clean the directory (defaults to true)

Definition at line 38 of file AbstractMeshWriter.cpp.

References AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::mpOutputFileHandler.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::~AbstractMeshWriter (  )  [inline, virtual]

Destructor.

Definition at line 48 of file AbstractMeshWriter.cpp.

References AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::mpOutputFileHandler.

Member Function Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
ElementData AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNextElement (  )  [inline, virtual]
Returns:
the data (indices/attributes) of the next element to be written to file

Reimplemented in VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >, and AbstractTetrahedralMeshWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 92 of file AbstractMeshWriter.cpp.

References AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::mpMeshReader.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
std::vector< double > AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNextNode (  )  [inline, virtual]
Returns:
the coordinates of the next node to be written to file

Reimplemented in VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >, and AbstractTetrahedralMeshWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 85 of file AbstractMeshWriter.cpp.

References AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::mpMeshReader.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
unsigned AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNumBoundaryEdges (  )  [inline]

Get the number of boundary faces in the mesh.

Definition at line 78 of file AbstractMeshWriter.cpp.

References AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::mBoundaryFaceData.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
unsigned AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNumBoundaryFaces (  )  [inline]

Get the number of boundary elements in the mesh.

Definition at line 72 of file AbstractMeshWriter.cpp.

References AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::mBoundaryFaceData.

Referenced by TrianglesMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFacesAsEdges(), TrianglesMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFiles(), and MeshalyzerMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFiles().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
unsigned AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNumElements (  )  [inline]

Get the number of elements in the mesh.

Definition at line 66 of file AbstractMeshWriter.cpp.

References AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::mNumElements.

Referenced by TrianglesMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteElementsAsFaces(), TrianglesMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFiles(), MeshalyzerMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFiles(), CmguiMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFiles(), and VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFiles().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
unsigned AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNumNodes (  )  [inline, virtual]

Get the number of nodes in the mesh.

Reimplemented in CmguiDeformedSolutionsWriter< DIM >.

Definition at line 60 of file AbstractMeshWriter.cpp.

References AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::mNumNodes.

Referenced by TrianglesMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFiles(), MeshalyzerMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFiles(), CmguiMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFiles(), and VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFiles().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
std::string AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetOutputDirectory (  )  [inline]

Return the full path to the directory where meshes will be written.

Definition at line 54 of file AbstractMeshWriter.cpp.

References OutputFileHandler::GetOutputDirectoryFullPath(), and AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::mpOutputFileHandler.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::SetNextBoundaryFace ( std::vector< unsigned >  nextFace  )  [inline]

Add an entry to mBoundaryFaceData.

Parameters:
nextFace array of the nodes on the boundary face to add

Definition at line 99 of file AbstractMeshWriter.cpp.

References AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::mBoundaryFaceData.

Referenced by AbstractTetrahedralMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFilesUsingMesh(), AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFilesUsingMeshReader(), and AbstractTetrahedralMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFilesUsingParallelMesh().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
virtual void AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFiles (  )  [pure virtual]

Write mesh data to files. This method must be overridden in concrete classes.

Implemented in VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >, CmguiMeshWriter< ELEMENT_DIM, SPACE_DIM >, MeshalyzerMeshWriter< ELEMENT_DIM, SPACE_DIM >, TrianglesMeshWriter< ELEMENT_DIM, SPACE_DIM >, and CmguiMeshWriter< DIM, DIM >.

Referenced by AbstractTetrahedralMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFilesUsingMesh(), AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFilesUsingMeshReader(), and AbstractTetrahedralMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFilesUsingParallelMesh().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFilesUsingMeshReader ( AbstractMeshReader< ELEMENT_DIM, SPACE_DIM > &  rMeshReader  )  [inline]

Read in a mesh and write it to file.

Parameters:
rMeshReader the mesh reader

Definition at line 105 of file AbstractMeshWriter.cpp.

References PetscTools::AmMaster(), AbstractMeshReader< ELEMENT_DIM, SPACE_DIM >::GetNextFaceData(), AbstractMeshReader< ELEMENT_DIM, SPACE_DIM >::GetNumFaces(), AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::mNumElements, AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::mNumNodes, AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::mpMeshReader, ElementData::NodeIndices, AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::SetNextBoundaryFace(), and AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFiles().

Member Data Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
std::string AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::mBaseName [protected]

Base name for the input files

Definition at line 48 of file AbstractMeshWriter.hpp.

Referenced by CmguiMeshWriter< ELEMENT_DIM, SPACE_DIM >::CmguiMeshWriter(), CmguiDeformedSolutionsWriter< DIM >::WriteCmguiScript(), CmguiDeformedSolutionsWriter< DIM >::WriteDeformationPositions(), TrianglesMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteElementsAsFaces(), TrianglesMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFacesAsEdges(), TrianglesMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFiles(), MeshalyzerMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFiles(), CmguiMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFiles(), VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFiles(), CmguiDeformedSolutionsWriter< DIM >::WriteInitialMesh(), and VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteVtkUsingMesh().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
std::vector< std::vector<unsigned> > AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::mBoundaryFaceData [protected]

Is an array of the nodes on each boundary face ((i,j)th entry is the jth node of face i)

Definition at line 50 of file AbstractMeshWriter.hpp.

Referenced by AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNumBoundaryEdges(), AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNumBoundaryFaces(), AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::SetNextBoundaryFace(), TrianglesMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFacesAsEdges(), TrianglesMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFiles(), and MeshalyzerMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFiles().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
unsigned AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::mNumElements [protected]

Total number of elements in mesh/mesh-reader

Definition at line 55 of file AbstractMeshWriter.hpp.

Referenced by AbstractTetrahedralMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNextElement(), VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNextElement(), AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNumElements(), AbstractTetrahedralMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFilesUsingMesh(), VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFilesUsingMesh(), and AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFilesUsingMeshReader().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
unsigned AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::mNumNodes [protected]

Total number of nodes in mesh/mesh-reader

Definition at line 54 of file AbstractMeshWriter.hpp.

Referenced by AbstractTetrahedralMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNextElement(), VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNextNode(), AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNumNodes(), AbstractTetrahedralMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFilesUsingMesh(), VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFilesUsingMesh(), AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFilesUsingMeshReader(), and AbstractTetrahedralMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFilesUsingParallelMesh().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
AbstractMeshReader<ELEMENT_DIM,SPACE_DIM>* AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::mpMeshReader [protected]

Writer by default writes from a reader (for conversion). If this pointer is non-null, data can be copied straight across

Definition at line 52 of file AbstractMeshWriter.hpp.

Referenced by AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNextElement(), AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNextNode(), AbstractTetrahedralMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFilesUsingMesh(), VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFilesUsingMesh(), and AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFilesUsingMeshReader().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
OutputFileHandler* AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::mpOutputFileHandler [protected]

Output file handler

Definition at line 47 of file AbstractMeshWriter.hpp.

Referenced by AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::AbstractMeshWriter(), AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetOutputDirectory(), CmguiDeformedSolutionsWriter< DIM >::WriteCmguiScript(), CmguiDeformedSolutionsWriter< DIM >::WriteDeformationPositions(), TrianglesMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteElementsAsFaces(), TrianglesMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFacesAsEdges(), TrianglesMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFiles(), MeshalyzerMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFiles(), CmguiMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFiles(), VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFiles(), VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteVtkUsingMesh(), and AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::~AbstractMeshWriter().

The documentation for this class was generated from the following files:
Generated by  doxygen 1.6.2