Chaste Commit::f2ff7ee04e70ac9d06c57344df8d017dbb12b97b
Public Member Functions | Protected Attributes | List of all members
AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM > Class Template Referenceabstract

#include <AbstractMeshWriter.hpp>

+ Inheritance diagram for AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >:
+ Collaboration diagram for AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >:

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 GetNumCableElements ()
 
virtual std::vector< double > GetNextNode ()
 
virtual ElementData GetNextElement ()
 
virtual ElementData GetNextBoundaryElement ()
 
virtual ElementData GetNextCableElement ()
 
virtual void WriteFiles ()=0
 
void WriteFilesUsingMeshReader (AbstractMeshReader< ELEMENT_DIM, SPACE_DIM > &rMeshReader)
 

Protected Attributes

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

Detailed Description

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

An abstract mesh writer class.

Definition at line 50 of file AbstractMeshWriter.hpp.

Constructor & Destructor Documentation

◆ AbstractMeshWriter()

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 
)

Constructor.

Parameters
rDirectorythe directory in which to write the mesh to file
rBaseNamethe base name of the files in which to write the mesh data
clearOutputDirwhether to clean the directory (defaults to true)

Definition at line 41 of file AbstractMeshWriter.cpp.

References AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::mpOutputFileHandler.

◆ ~AbstractMeshWriter()

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

Destructor.

Definition at line 51 of file AbstractMeshWriter.cpp.

Member Function Documentation

◆ GetNextBoundaryElement()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
ElementData AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNextBoundaryElement ( )
virtual
Returns
the data (indices/attributes) of the next face to be written to file

Reimplemented in AbstractTetrahedralMeshWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 101 of file AbstractMeshWriter.cpp.

Referenced by AbstractTetrahedralMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNextBoundaryElement().

◆ GetNextCableElement()

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

Reimplemented in AbstractTetrahedralMeshWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 108 of file AbstractMeshWriter.cpp.

Referenced by AbstractTetrahedralMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNextCableElement().

◆ GetNextElement()

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

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

Definition at line 94 of file AbstractMeshWriter.cpp.

Referenced by PottsMeshWriter< SPACE_DIM >::GetNextElement(), VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNextElement(), and AbstractTetrahedralMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNextElement().

◆ GetNextNode()

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

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

Definition at line 87 of file AbstractMeshWriter.cpp.

Referenced by PottsMeshWriter< SPACE_DIM >::GetNextNode(), ImmersedBoundaryMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNextNode(), VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNextNode(), and AbstractTetrahedralMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNextNode().

◆ GetNumBoundaryFaces()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
unsigned AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNumBoundaryFaces ( )
Returns
the number of boundary elements in the mesh.

Definition at line 75 of file AbstractMeshWriter.cpp.

◆ GetNumCableElements()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
unsigned AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNumCableElements ( )
Returns
the number of cable elements in the mesh.

Definition at line 81 of file AbstractMeshWriter.cpp.

◆ GetNumElements()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
unsigned AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNumElements ( )
Returns
the number of elements in the mesh.

Definition at line 69 of file AbstractMeshWriter.cpp.

◆ GetNumNodes()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
unsigned AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNumNodes ( )
virtual
Returns
the number of nodes in the mesh.

Reimplemented in CmguiDeformedSolutionsWriter< DIM >.

Definition at line 63 of file AbstractMeshWriter.cpp.

◆ GetOutputDirectory()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
std::string AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetOutputDirectory ( )
Returns
the full path to the directory where meshes will be written.

Definition at line 57 of file AbstractMeshWriter.cpp.

◆ WriteFiles()

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 PottsMeshWriter< SPACE_DIM >, ImmersedBoundaryMeshWriter< ELEMENT_DIM, SPACE_DIM >, TrapezoidEdgeVertexMeshWriter< ELEMENT_DIM, SPACE_DIM >, VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >, CmguiMeshWriter< ELEMENT_DIM, SPACE_DIM >, CmguiMeshWriter< DIM, DIM >, MeshalyzerMeshWriter< ELEMENT_DIM, SPACE_DIM >, TrianglesMeshWriter< ELEMENT_DIM, SPACE_DIM >, VtkMeshWriter< ELEMENT_DIM, SPACE_DIM >, and XdmfMeshWriter< ELEMENT_DIM, SPACE_DIM >.

◆ WriteFilesUsingMeshReader()

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

Read in a mesh and write it to file.

Parameters
rMeshReaderthe mesh reader

Definition at line 115 of file AbstractMeshWriter.cpp.

Referenced by Hdf5ToCmguiConverter< ELEMENT_DIM, SPACE_DIM >::Hdf5ToCmguiConverter(), Hdf5ToMeshalyzerConverter< ELEMENT_DIM, SPACE_DIM >::Hdf5ToMeshalyzerConverter(), and Hdf5ToVtkConverter< ELEMENT_DIM, SPACE_DIM >::Hdf5ToVtkConverter().

Member Data Documentation

◆ mBaseName

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 55 of file AbstractMeshWriter.hpp.

Referenced by CmguiMeshWriter< ELEMENT_DIM, SPACE_DIM >::CmguiMeshWriter().

◆ mNumBoundaryElements

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
unsigned AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::mNumBoundaryElements
protected

Total number of boundary elements in mesh/mesh-reader

Definition at line 61 of file AbstractMeshWriter.hpp.

◆ mNumCableElements

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
unsigned AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::mNumCableElements
protected

Total number of cable elements in mesh/mesh-reader

Definition at line 62 of file AbstractMeshWriter.hpp.

◆ mNumElements

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 60 of file AbstractMeshWriter.hpp.

◆ mNumNodes

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 59 of file AbstractMeshWriter.hpp.

◆ mpMeshReader

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 57 of file AbstractMeshWriter.hpp.

◆ mpOutputFileHandler

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

Output file handler

Definition at line 54 of file AbstractMeshWriter.hpp.

Referenced by AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::AbstractMeshWriter().

The documentation for this class was generated from the following files: