AbstractHdf5Converter< ELEMENT_DIM, SPACE_DIM > Class Template Reference

#include <AbstractHdf5Converter.hpp>

Inherited by Hdf5ToCmguiConverter< ELEMENT_DIM, SPACE_DIM >, Hdf5ToMeshalyzerConverter< ELEMENT_DIM, SPACE_DIM >, Hdf5ToTxtConverter< ELEMENT_DIM, SPACE_DIM >, and Hdf5ToVtkConverter< ELEMENT_DIM, SPACE_DIM >.

Collaboration diagram for AbstractHdf5Converter< ELEMENT_DIM, SPACE_DIM >:

[legend]

List of all members.

Public Member Functions
	AbstractHdf5Converter (std::string inputDirectory, std::string fileBaseName, AbstractTetrahedralMesh< ELEMENT_DIM, SPACE_DIM > *pMesh, std::string subdirectoryName)
	~AbstractHdf5Converter ()
std::string	GetSubdirectory ()
Protected Attributes
Hdf5DataReader *	mpReader
unsigned	mNumVariables
std::string	mFileBaseName
AbstractTetrahedralMesh < ELEMENT_DIM, SPACE_DIM > *	mpMesh
OutputFileHandler *	mpOutputFileHandler
std::string	mRelativeSubdirectory

Detailed Description

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

The derived children of this class convert output from Hdf5 format to a range of other formats for postprocessing.

Definition at line 42 of file AbstractHdf5Converter.hpp.

Constructor & Destructor Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

AbstractHdf5Converter< ELEMENT_DIM, SPACE_DIM >::AbstractHdf5Converter	(	std::string	inputDirectory,
		std::string	fileBaseName,
		AbstractTetrahedralMesh< ELEMENT_DIM, SPACE_DIM > *	pMesh,
		std::string	subdirectoryName
	)			`[inline]`

Constructor, which does the conversion and writes the .info file.

Note:: This method is collective, and must be called by al processes.

Parameters:

	inputDirectory	The input directory, relative to CHASTE_TEST_OUTPUT, where the .h5 file has been written
	fileBaseName	The base name of the data file.
	pMesh	Pointer to the mesh.
	subdirectoryName	name for the output directory to be created (relative to inputDirectory)

Definition at line 33 of file AbstractHdf5Converter.cpp.

References PetscTools::AmMaster(), DOUBLE_UNSET, EXCEPTION, Hdf5DataReader::GetNumberOfRows(), ChasteBuildInfo::GetProvenanceString(), Hdf5DataReader::GetUnlimitedDimensionValues(), Hdf5DataReader::GetVariableNames(), AbstractHdf5Converter< ELEMENT_DIM, SPACE_DIM >::mFileBaseName, AbstractHdf5Converter< ELEMENT_DIM, SPACE_DIM >::mNumVariables, AbstractHdf5Converter< ELEMENT_DIM, SPACE_DIM >::mpMesh, AbstractHdf5Converter< ELEMENT_DIM, SPACE_DIM >::mpOutputFileHandler, AbstractHdf5Converter< ELEMENT_DIM, SPACE_DIM >::mpReader, AbstractHdf5Converter< ELEMENT_DIM, SPACE_DIM >::mRelativeSubdirectory, and OutputFileHandler::OpenOutputFile().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

AbstractHdf5Converter< ELEMENT_DIM, SPACE_DIM >::~AbstractHdf5Converter ( ) [inline]

Destructor.

Definition at line 82 of file AbstractHdf5Converter.cpp.

References AbstractHdf5Converter< ELEMENT_DIM, SPACE_DIM >::mpOutputFileHandler, and AbstractHdf5Converter< ELEMENT_DIM, SPACE_DIM >::mpReader.

Member Function Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

std::string AbstractHdf5Converter< ELEMENT_DIM, SPACE_DIM >::GetSubdirectory ( ) [inline]

Get the relative path of the subdirectory in which the converted output is stored.

Definition at line 89 of file AbstractHdf5Converter.cpp.

References AbstractHdf5Converter< ELEMENT_DIM, SPACE_DIM >::mRelativeSubdirectory.

Referenced by AbstractCardiacProblem< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::CloseFilesAndPostProcess().

Member Data Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

std::string AbstractHdf5Converter< ELEMENT_DIM, SPACE_DIM >::mFileBaseName [protected]

Base name for the files: [basename].vtu, [basename].dat etc.

Definition at line 53 of file AbstractHdf5Converter.hpp.

Referenced by AbstractHdf5Converter< ELEMENT_DIM, SPACE_DIM >::AbstractHdf5Converter(), Hdf5ToMeshalyzerConverter< ELEMENT_DIM, SPACE_DIM >::Write(), Hdf5ToCmguiConverter< ELEMENT_DIM, SPACE_DIM >::Write(), and Hdf5ToCmguiConverter< ELEMENT_DIM, SPACE_DIM >::WriteCmguiScript().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

unsigned AbstractHdf5Converter< ELEMENT_DIM, SPACE_DIM >::mNumVariables [protected]

Number of variables to output. Read from the reader.

Definition at line 50 of file AbstractHdf5Converter.hpp.

Referenced by AbstractHdf5Converter< ELEMENT_DIM, SPACE_DIM >::AbstractHdf5Converter(), Hdf5ToTxtConverter< ELEMENT_DIM, SPACE_DIM >::Hdf5ToTxtConverter(), and Hdf5ToVtkConverter< ELEMENT_DIM, SPACE_DIM >::Hdf5ToVtkConverter().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

AbstractTetrahedralMesh<ELEMENT_DIM,SPACE_DIM>* AbstractHdf5Converter< ELEMENT_DIM, SPACE_DIM >::mpMesh [protected]

Pointer to a mesh.

Definition at line 56 of file AbstractHdf5Converter.hpp.

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

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

OutputFileHandler* AbstractHdf5Converter< ELEMENT_DIM, SPACE_DIM >::mpOutputFileHandler [protected]

Initialised as the directory in which to store the results.

Definition at line 59 of file AbstractHdf5Converter.hpp.

Referenced by AbstractHdf5Converter< ELEMENT_DIM, SPACE_DIM >::AbstractHdf5Converter(), Hdf5ToMeshalyzerConverter< ELEMENT_DIM, SPACE_DIM >::Write(), Hdf5ToCmguiConverter< ELEMENT_DIM, SPACE_DIM >::Write(), Hdf5ToCmguiConverter< ELEMENT_DIM, SPACE_DIM >::WriteCmguiScript(), and AbstractHdf5Converter< ELEMENT_DIM, SPACE_DIM >::~AbstractHdf5Converter().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

Hdf5DataReader* AbstractHdf5Converter< ELEMENT_DIM, SPACE_DIM >::mpReader [protected]

Pointer to reader of the file to be converted.

Definition at line 47 of file AbstractHdf5Converter.hpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

std::string AbstractHdf5Converter< ELEMENT_DIM, SPACE_DIM >::mRelativeSubdirectory [protected]

Get the subdirectory in which the converted output is stored, relative to the input directory.

Definition at line 65 of file AbstractHdf5Converter.hpp.

Referenced by AbstractHdf5Converter< ELEMENT_DIM, SPACE_DIM >::AbstractHdf5Converter(), AbstractHdf5Converter< ELEMENT_DIM, SPACE_DIM >::GetSubdirectory(), Hdf5ToMeshalyzerConverter< ELEMENT_DIM, SPACE_DIM >::Hdf5ToMeshalyzerConverter(), Hdf5ToTxtConverter< ELEMENT_DIM, SPACE_DIM >::Hdf5ToTxtConverter(), and Hdf5ToVtkConverter< ELEMENT_DIM, SPACE_DIM >::Hdf5ToVtkConverter().

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

pde/src/postprocessing/AbstractHdf5Converter.hpp
pde/src/postprocessing/AbstractHdf5Converter.cpp

AbstractHdf5Converter< ELEMENT_DIM, SPACE_DIM > Class Template Reference

Public Member Functions

Protected Attributes

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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