VertexMeshWriter< ELEMENT_DIM, SPACE_DIM > Class Template Reference

#include <VertexMeshWriter.hpp>

Inheritance diagram for VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >:

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

Collaboration graph
[legend]

List of all members.

Public Member Functions

 VertexMeshWriter (const std::string &rDirectory, const std::string &rBaseName, const bool clearOutputDir=true)
 ~VertexMeshWriter ()
void WriteFilesUsingMesh (VertexMesh< ELEMENT_DIM, SPACE_DIM > &rMesh)
void WriteVtkUsingMesh (VertexMesh< ELEMENT_DIM, SPACE_DIM > &rMesh, std::string stamp="")
void AddCellData (std::string dataName, std::vector< double > dataPayload)
void AddPointData (std::string dataName, std::vector< double > dataPayload)
std::vector< double > GetNextNode ()
ElementData GetNextElement ()
VertexElementData GetNextElementWithFaces ()
void WriteFiles ()

Private Attributes

VertexMesh< ELEMENT_DIM,
SPACE_DIM > * 
mpMesh
MeshWriterIterators
< ELEMENT_DIM, SPACE_DIM > * 
mpIters
NodeMapmpNodeMap
unsigned mNodeMapCurrentIndex
vtkUnstructuredGrid * mpVtkUnstructedMesh


Detailed Description

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

A mesh writer class for vertex-based meshes.

Definition at line 64 of file VertexMeshWriter.hpp.


Constructor & Destructor Documentation

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

Constructor.

Parameters:
rDirectory reference to the output directory, relative to where Chaste output is stored
rBaseName reference to the base name for results files
clearOutputDir whether to clear the output directory prior to writing files

Definition at line 49 of file VertexMeshWriter.cpp.

References VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::mpIters, and VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::mpVtkUnstructedMesh.

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


Member Function Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFilesUsingMesh ( VertexMesh< ELEMENT_DIM, SPACE_DIM > &  rMesh  )  [inline]

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteVtkUsingMesh ( VertexMesh< ELEMENT_DIM, SPACE_DIM > &  rMesh,
std::string  stamp = "" 
) [inline]

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::AddCellData ( std::string  dataName,
std::vector< double >  dataPayload 
) [inline]

Add data to a future VTK file.

Parameters:
dataName a tag to go into the VTK file
dataPayload a pay-load of length (number of elements)

Definition at line 266 of file VertexMeshWriter.cpp.

References VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::mpVtkUnstructedMesh.

Referenced by VertexBasedCellPopulation< DIM >::WriteVtkResultsToFile(), MeshBasedCellPopulationWithGhostNodes< DIM >::WriteVtkResultsToFile(), and MeshBasedCellPopulation< DIM >::WriteVtkResultsToFile().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::AddPointData ( std::string  dataName,
std::vector< double >  dataPayload 
) [inline]

Add data to a future VTK file.

Parameters:
dataName a tag to go into the VTK file
dataPayload a pay-load of length (number of nodes)

Definition at line 284 of file VertexMeshWriter.cpp.

References VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::mpVtkUnstructedMesh.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
std::vector< double > VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNextNode (  )  [inline, virtual]

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
ElementData VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNextElement (  )  [inline, virtual]

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
VertexElementData VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetNextElementWithFaces (  )  [inline]

Returns:
the data (indices/attributes) of the next element to be written to file, including its faces. This method should only be called in 3D.

Todo:
Store face orientations? (#1076/#1377)

Todo:
set attribute (#1076)

Definition at line 118 of file VertexMeshWriter.cpp.

References ElementData::AttributeValue, NodeMap::GetNewIndex(), AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::mNumElements, VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::mpIters, VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::mpMesh, VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::mpNodeMap, and ElementData::NodeIndices.

Referenced by VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFiles().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFiles (  )  [inline, virtual]


Member Data Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
VertexMesh<ELEMENT_DIM,SPACE_DIM>* VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::mpMesh [private]

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
MeshWriterIterators<ELEMENT_DIM,SPACE_DIM>* VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::mpIters [private]

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
NodeMap* VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::mpNodeMap [private]

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
unsigned VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::mNodeMapCurrentIndex [private]

What was the last index written to mpNodeMap ?

Definition at line 79 of file VertexMeshWriter.hpp.

Referenced by VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFilesUsingMesh().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
vtkUnstructuredGrid* VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::mpVtkUnstructedMesh [private]


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

Generated on Mon Apr 18 11:38:06 2011 for Chaste by  doxygen 1.5.5