#include <datacollection.hpp>

Inheritance diagram for mfem::DataCollection:

Collaboration diagram for mfem::DataCollection:

Public Types
enum	Format { SERIAL_FORMAT = 0, PARALLEL_FORMAT = 1 }
	Format constants to be used with SetFormat(). More...

enum	{ NO_ERROR = 0, READ_ERROR = 1, WRITE_ERROR = 2 }
	Errors returned by Error() More...

typedef GFieldMap::MapType	FieldMapType

typedef GFieldMap::iterator	FieldMapIterator

typedef GFieldMap::const_iterator	FieldMapConstIterator

typedef QFieldMap::MapType	QFieldMapType

typedef QFieldMap::iterator	QFieldMapIterator

typedef QFieldMap::const_iterator	QFieldMapConstIterator

Public Member Functions
	DataCollection (const std::string &collection_name, Mesh *mesh_=NULL)
	Initialize the collection with its name and Mesh. More...

virtual void	RegisterField (const std::string &field_name, GridFunction *gf)
	Add a grid function to the collection. More...

virtual void	DeregisterField (const std::string &field_name)
	Remove a grid function from the collection. More...

virtual void	RegisterQField (const std::string &q_field_name, QuadratureFunction *qf)
	Add a QuadratureFunction to the collection. More...

virtual void	DeregisterQField (const std::string &field_name)
	Remove a QuadratureFunction from the collection. More...

bool	HasField (const std::string &field_name) const
	Check if a grid function is part of the collection. More...

GridFunction *	GetField (const std::string &field_name)
	Get a pointer to a grid function in the collection. More...

MPI_Comm	GetComm () const
	Return the associated MPI communicator or MPI_COMM_NULL. More...

ParGridFunction *	GetParField (const std::string &field_name)
	Get a pointer to a parallel grid function in the collection. More...

bool	HasQField (const std::string &q_field_name) const
	Check if a QuadratureFunction with the given name is in the collection. More...

QuadratureFunction *	GetQField (const std::string &q_field_name)
	Get a pointer to a QuadratureFunction in the collection. More...

const FieldMapType &	GetFieldMap () const
	Get a const reference to the internal field map. More...

const QFieldMapType &	GetQFieldMap () const
	Get a const reference to the internal q-field map. More...

Mesh *	GetMesh ()
	Get a pointer to the mesh in the collection. More...

virtual void	SetMesh (Mesh *new_mesh)
	Set/change the mesh associated with the collection. More...

virtual void	SetMesh (MPI_Comm comm, Mesh *new_mesh)
	Set/change the mesh associated with the collection. More...

void	SetCycle (int c)
	Set time cycle (for time-dependent simulations) More...

void	SetTime (double t)
	Set physical time (for time-dependent simulations) More...

void	SetTimeStep (double ts)
	Set the simulation time step (for time-dependent simulations) More...

int	GetCycle () const
	Get time cycle (for time-dependent simulations) More...

double	GetTime () const
	Get physical time (for time-dependent simulations) More...

double	GetTimeStep () const
	Get the simulation time step (for time-dependent simulations) More...

const std::string &	GetCollectionName () const
	Get the name of the collection. More...

void	SetOwnData (bool o)
	Set the ownership of collection data. More...

void	SetPrecision (int prec)
	Set the precision (number of digits) used for the text output of doubles. More...

virtual void	SetPadDigits (int digits)
	Set the number of digits used for both the cycle and the MPI rank. More...

virtual void	SetPadDigitsCycle (int digits)
	Set the number of digits used for the cycle. More...

virtual void	SetPadDigitsRank (int digits)
	Set the number of digits used for the MPI rank in filenames. More...

virtual void	SetFormat (int fmt)
	Set the desired output mesh and data format. More...

virtual void	SetCompression (bool comp)
	Set the flag for use of gz compressed files. More...

void	SetPrefixPath (const std::string &prefix)
	Set the path where the DataCollection will be saved. More...

const std::string &	GetPrefixPath () const
	Get the path where the DataCollection will be saved. More...

virtual void	Save ()
	Save the collection to disk. More...

virtual void	SaveMesh ()
	Save the mesh, creating the collection directory. More...

virtual void	SaveField (const std::string &field_name)
	Save one field, assuming the collection directory already exists. More...

virtual void	SaveQField (const std::string &q_field_name)
	Save one q-field, assuming the collection directory already exists. More...

virtual void	Load (int cycle_=0)
	Load the collection. Not implemented in the base class DataCollection. More...

virtual	~DataCollection ()
	Delete the mesh and fields if owned by the collection. More...

int	Error () const
	Get the current error state. More...

void	ResetError (int err_state=NO_ERROR)
	Reset the error state. More...

Protected Member Functions
void	DeleteData ()
	Delete data owned by the DataCollection keeping field information. More...

void	DeleteAll ()
	Delete data owned by the DataCollection including field information. More...

std::string	GetMeshShortFileName () const

std::string	GetMeshFileName () const

std::string	GetFieldFileName (const std::string &field_name) const

void	SaveOneField (const FieldMapIterator &it)
	Save one field to disk, assuming the collection directory exists. More...

void	SaveOneQField (const QFieldMapIterator &it)
	Save one q-field to disk, assuming the collection directory exists. More...

Static Protected Member Functions
static int	create_directory (const std::string &dir_name, const Mesh *mesh, int myid)

Protected Attributes
std::string	name
	Name of the collection, used as a directory name when saving. More...

std::string	prefix_path
	A path where the directory with results is saved. If not empty, it has '/' at the end. More...

GFieldMap	field_map

QFieldMap	q_field_map

Mesh *	mesh
	The (common) mesh for the collected fields. More...

int	cycle
	Time cycle; for time-dependent simulations cycle >= 0, otherwise = -1. More...

double	time
	Physical time (for time-dependent simulations) More...

double	time_step
	Time step i.e. delta_t (for time-dependent simulations) More...

bool	serial
	Serial or parallel run? False iff mesh is a ParMesh. More...

bool	appendRankToFileName
	Append rank to any output file names. More...

int	myid
	MPI rank (in parallel) More...

int	num_procs
	Number of MPI ranks (in parallel) More...

MPI_Comm	m_comm
	Associated MPI communicator. More...

int	precision
	Precision (number of digits) used for the text output of doubles. More...

int	pad_digits_cycle
	Number of digits used for the cycle and MPI rank in filenames. More...

int	pad_digits_rank

int	format
	Output mesh format: see the Format enumeration. More...

int	compression

bool	own_data
	Should the collection delete its mesh and fields. More...

int	error
	Error state. More...

Static Protected Attributes
static const int	precision_default = 6
	Default value for precision. More...

static const int	pad_digits_default = 6
	Default value for pad_digits_*. More...

Friends
class	ParMesh

Detailed Description

A class for collecting finite element data that is part of the same simulation. Currently, this class groups together grid functions (fields), quadrature functions (q-fields), and the mesh that they are defined on.

Definition at line 128 of file datacollection.hpp.

Member Typedef Documentation

typedef GFieldMap::const_iterator mfem::DataCollection::FieldMapConstIterator

Definition at line 139 of file datacollection.hpp.

typedef GFieldMap::iterator mfem::DataCollection::FieldMapIterator

Definition at line 138 of file datacollection.hpp.

typedef GFieldMap::MapType mfem::DataCollection::FieldMapType

Definition at line 137 of file datacollection.hpp.

typedef QFieldMap::const_iterator mfem::DataCollection::QFieldMapConstIterator

Definition at line 143 of file datacollection.hpp.

typedef QFieldMap::iterator mfem::DataCollection::QFieldMapIterator

Definition at line 142 of file datacollection.hpp.

typedef QFieldMap::MapType mfem::DataCollection::QFieldMapType

Definition at line 141 of file datacollection.hpp.

Member Enumeration Documentation

anonymous enum

Errors returned by Error()

Enumerator
NO_ERROR
READ_ERROR
WRITE_ERROR

Definition at line 381 of file datacollection.hpp.

enum mfem::DataCollection::Format

Format constants to be used with SetFormat().

Derived classes can define their own format enumerations and override the method SetFormat() to perform input validation.

Enumerator
SERIAL_FORMAT	MFEM's serial ascii format, using the methods Mesh::Print() / ParMesh::Print(), and GridFunction::Save() / ParGridFunction::Save().
PARALLEL_FORMAT	MFEM's parallel ascii format, using the methods ParMesh::ParPrint() and GridFunction::Save() / ParGridFunction::Save().

Definition at line 148 of file datacollection.hpp.

Constructor & Destructor Documentation

mfem::DataCollection::DataCollection	(	const std::string &	collection_name,
		Mesh *	mesh_ = `NULL`
	)

explicit

Initialize the collection with its name and Mesh.

When mesh_ is NULL, then the real mesh can be set with SetMesh().

Definition at line 75 of file datacollection.cpp.

mfem::DataCollection::~DataCollection ( )

virtual

Delete the mesh and fields if owned by the collection.

Definition at line 338 of file datacollection.cpp.

Member Function Documentation

int mfem::DataCollection::create_directory	(	const std::string &	dir_name,
		const Mesh *	mesh,
		int	myid
	)

staticprotected

Definition at line 34 of file datacollection.cpp.

void mfem::DataCollection::DeleteAll ( )

protected

Delete data owned by the DataCollection including field information.

Definition at line 331 of file datacollection.cpp.

void mfem::DataCollection::DeleteData ( )

protected

Delete data owned by the DataCollection keeping field information.

Definition at line 321 of file datacollection.cpp.

virtual void mfem::DataCollection::DeregisterField ( const std::string & field_name )

inlinevirtual

Remove a grid function from the collection.

Reimplemented in mfem::SidreDataCollection.

Definition at line 248 of file datacollection.hpp.

virtual void mfem::DataCollection::DeregisterQField ( const std::string & field_name )

inlinevirtual

Remove a QuadratureFunction from the collection.

Definition at line 258 of file datacollection.hpp.

int mfem::DataCollection::Error ( ) const

inline

Get the current error state.

Definition at line 384 of file datacollection.hpp.

const std::string& mfem::DataCollection::GetCollectionName ( ) const

inline

Get the name of the collection.

Definition at line 334 of file datacollection.hpp.

MPI_Comm mfem::DataCollection::GetComm ( ) const

inline

Return the associated MPI communicator or MPI_COMM_NULL.

Definition at line 272 of file datacollection.hpp.

int mfem::DataCollection::GetCycle ( ) const

inline

Get time cycle (for time-dependent simulations)

Definition at line 327 of file datacollection.hpp.

GridFunction* mfem::DataCollection::GetField ( const std::string & field_name )

inline

Get a pointer to a grid function in the collection.

Returns NULL if field_name is not in the collection.

Definition at line 267 of file datacollection.hpp.

std::string mfem::DataCollection::GetFieldFileName ( const std::string & field_name ) const

protected

Definition at line 261 of file datacollection.cpp.

const FieldMapType& mfem::DataCollection::GetFieldMap ( ) const

inline

Get a const reference to the internal field map.

The keys in the map are the field names and the values are pointers to GridFunctions.

Definition at line 294 of file datacollection.hpp.

Mesh* mfem::DataCollection::GetMesh ( )

inline

Get a pointer to the mesh in the collection.

Definition at line 304 of file datacollection.hpp.

std::string mfem::DataCollection::GetMeshFileName ( ) const

protected

Definition at line 256 of file datacollection.cpp.

std::string mfem::DataCollection::GetMeshShortFileName ( ) const

protected

Definition at line 251 of file datacollection.cpp.

ParGridFunction* mfem::DataCollection::GetParField ( const std::string & field_name )

inline

Get a pointer to a parallel grid function in the collection.

Returns NULL if field_name is not in the collection.

Note: The GridFunction pointer stored in the collection is statically cast to ParGridFunction pointer.

Definition at line 278 of file datacollection.hpp.

const std::string& mfem::DataCollection::GetPrefixPath ( ) const

inline

Get the path where the DataCollection will be saved.

Definition at line 360 of file datacollection.hpp.

QuadratureFunction* mfem::DataCollection::GetQField ( const std::string & q_field_name )

inline

Get a pointer to a QuadratureFunction in the collection.

Returns NULL if field_name is not in the collection.

Definition at line 288 of file datacollection.hpp.

const QFieldMapType& mfem::DataCollection::GetQFieldMap ( ) const

inline

Get a const reference to the internal q-field map.

The keys in the map are the q-field names and the values are pointers to QuadratureFunctions.

Definition at line 300 of file datacollection.hpp.

double mfem::DataCollection::GetTime ( ) const

inline

Get physical time (for time-dependent simulations)

Definition at line 329 of file datacollection.hpp.

double mfem::DataCollection::GetTimeStep ( ) const

inline

Get the simulation time step (for time-dependent simulations)

Definition at line 331 of file datacollection.hpp.

bool mfem::DataCollection::HasField ( const std::string & field_name ) const

inline

Check if a grid function is part of the collection.

Definition at line 262 of file datacollection.hpp.

bool mfem::DataCollection::HasQField ( const std::string & q_field_name ) const

inline

Check if a QuadratureFunction with the given name is in the collection.

Definition at line 283 of file datacollection.hpp.

void mfem::DataCollection::Load ( int cycle_ = 0 )

virtual

Load the collection. Not implemented in the base class DataCollection.

Reimplemented in mfem::ParaViewDataCollection, mfem::VisItDataCollection, mfem::SidreDataCollection, mfem::ConduitDataCollection, and mfem::FMSDataCollection.

Definition at line 191 of file datacollection.cpp.

virtual void mfem::DataCollection::RegisterField	(	const std::string &	field_name,
		GridFunction *	gf
	)

inlinevirtual

Add a grid function to the collection.

Reimplemented in mfem::VisItDataCollection, and mfem::SidreDataCollection.

Definition at line 244 of file datacollection.hpp.

virtual void mfem::DataCollection::RegisterQField	(	const std::string &	q_field_name,
		QuadratureFunction *	qf
	)

inlinevirtual

Add a QuadratureFunction to the collection.

Reimplemented in mfem::VisItDataCollection.

Definition at line 252 of file datacollection.hpp.

void mfem::DataCollection::ResetError ( int err_state = NO_ERROR )

inline

Reset the error state.

Definition at line 386 of file datacollection.hpp.

void mfem::DataCollection::Save ( )

virtual

Save the collection to disk.

By default, everything is saved in the "prefix_path" directory with subdirectory name "collection_name" or "collection_name_cycle" for time-dependent simulations.

Reimplemented in mfem::ParaViewDataCollection, mfem::VisItDataCollection, mfem::SidreDataCollection, mfem::ConduitDataCollection, mfem::ADIOS2DataCollection, and mfem::FMSDataCollection.

Definition at line 196 of file datacollection.cpp.

void mfem::DataCollection::SaveField ( const std::string & field_name )

virtual

Save one field, assuming the collection directory already exists.

Definition at line 303 of file datacollection.cpp.

void mfem::DataCollection::SaveMesh ( )

virtual

Save the mesh, creating the collection directory.

Definition at line 215 of file datacollection.cpp.

void mfem::DataCollection::SaveOneField ( const FieldMapIterator & it )

protected

Save one field to disk, assuming the collection directory exists.

Definition at line 277 of file datacollection.cpp.

void mfem::DataCollection::SaveOneQField ( const QFieldMapIterator & it )

protected

Save one q-field to disk, assuming the collection directory exists.

Definition at line 290 of file datacollection.cpp.

void mfem::DataCollection::SaveQField ( const std::string & q_field_name )

virtual

Save one q-field, assuming the collection directory already exists.

Definition at line 312 of file datacollection.cpp.

void mfem::DataCollection::SetCompression ( bool comp )

virtual

Set the flag for use of gz compressed files.

Reimplemented in mfem::ParaViewDataCollection.

Definition at line 167 of file datacollection.cpp.

void mfem::DataCollection::SetCycle ( int c )

inline

Set time cycle (for time-dependent simulations)

Definition at line 319 of file datacollection.hpp.

void mfem::DataCollection::SetFormat ( int fmt )

virtual

Set the desired output mesh and data format.

See the enumeration Format for valid options. Derived classes can define their own format enumerations and override this method to perform input validation.

Definition at line 154 of file datacollection.cpp.

void mfem::DataCollection::SetMesh ( Mesh * new_mesh )

virtual

Set/change the mesh associated with the collection.

When passed a Mesh, assumes the serial case: MPI rank id is set to 0 and MPI num_procs is set to 1. When passed a ParMesh, MPI info from the ParMesh is used to set the DataCollection's MPI rank and num_procs.

Reimplemented in mfem::VisItDataCollection, and mfem::SidreDataCollection.

Definition at line 117 of file datacollection.cpp.

void mfem::DataCollection::SetMesh	(	MPI_Comm	comm,
		Mesh *	new_mesh
	)

virtual

Set/change the mesh associated with the collection.

For this case, comm is used to set the DataCollection's MPI rank id and MPI num_procs, which influences the how files are saved for domain decomposed meshes.

Reimplemented in mfem::VisItDataCollection, and mfem::SidreDataCollection.

Definition at line 141 of file datacollection.cpp.

void mfem::DataCollection::SetOwnData ( bool o )

inline

Set the ownership of collection data.

Definition at line 336 of file datacollection.hpp.

virtual void mfem::DataCollection::SetPadDigits ( int digits )

inlinevirtual

Set the number of digits used for both the cycle and the MPI rank.

Reimplemented in mfem::VisItDataCollection.

Definition at line 341 of file datacollection.hpp.

virtual void mfem::DataCollection::SetPadDigitsCycle ( int digits )

inlinevirtual

Set the number of digits used for the cycle.

Definition at line 344 of file datacollection.hpp.

virtual void mfem::DataCollection::SetPadDigitsRank ( int digits )

inlinevirtual

Set the number of digits used for the MPI rank in filenames.

Definition at line 346 of file datacollection.hpp.

void mfem::DataCollection::SetPrecision ( int prec )

inline

Set the precision (number of digits) used for the text output of doubles.

Definition at line 339 of file datacollection.hpp.

void mfem::DataCollection::SetPrefixPath ( const std::string & prefix )

Set the path where the DataCollection will be saved.

Definition at line 175 of file datacollection.cpp.

void mfem::DataCollection::SetTime ( double t )

inline

Set physical time (for time-dependent simulations)

Definition at line 321 of file datacollection.hpp.

void mfem::DataCollection::SetTimeStep ( double ts )

inline

Set the simulation time step (for time-dependent simulations)

Definition at line 324 of file datacollection.hpp.

Friends And Related Function Documentation

friend class ParMesh

friend

Definition at line 389 of file datacollection.hpp.

Member Data Documentation

bool mfem::DataCollection::appendRankToFileName

protected

Append rank to any output file names.

Definition at line 187 of file datacollection.hpp.

int mfem::DataCollection::compression

protected

Definition at line 210 of file datacollection.hpp.

int mfem::DataCollection::cycle

protected

Time cycle; for time-dependent simulations cycle >= 0, otherwise = -1.

When cycle >= 0, it is appended to directory names.

Definition at line 177 of file datacollection.hpp.

int mfem::DataCollection::error

protected

Error state.

Definition at line 216 of file datacollection.hpp.

GFieldMap mfem::DataCollection::field_map

protected

A FieldMap mapping registered field names to GridFunction pointers.

Definition at line 167 of file datacollection.hpp.

int mfem::DataCollection::format

protected

Output mesh format: see the Format enumeration.

Definition at line 209 of file datacollection.hpp.

MPI_Comm mfem::DataCollection::m_comm

protected

Associated MPI communicator.

Definition at line 195 of file datacollection.hpp.

Mesh* mfem::DataCollection::mesh

protected

The (common) mesh for the collected fields.

Definition at line 173 of file datacollection.hpp.

int mfem::DataCollection::myid

protected

MPI rank (in parallel)

Definition at line 190 of file datacollection.hpp.

std::string mfem::DataCollection::name

protected

Name of the collection, used as a directory name when saving.

Definition at line 160 of file datacollection.hpp.

int mfem::DataCollection::num_procs

protected

Number of MPI ranks (in parallel)

Definition at line 192 of file datacollection.hpp.

bool mfem::DataCollection::own_data

protected

Should the collection delete its mesh and fields.

Definition at line 213 of file datacollection.hpp.

int mfem::DataCollection::pad_digits_cycle

protected

Number of digits used for the cycle and MPI rank in filenames.

Definition at line 201 of file datacollection.hpp.

const int mfem::DataCollection::pad_digits_default = 6

staticprotected

Default value for pad_digits_*.

Definition at line 206 of file datacollection.hpp.

int mfem::DataCollection::pad_digits_rank

protected

Definition at line 201 of file datacollection.hpp.

int mfem::DataCollection::precision

protected

Precision (number of digits) used for the text output of doubles.

Definition at line 199 of file datacollection.hpp.

const int mfem::DataCollection::precision_default = 6

staticprotected

Default value for precision.

Definition at line 204 of file datacollection.hpp.

std::string mfem::DataCollection::prefix_path

protected

A path where the directory with results is saved. If not empty, it has '/' at the end.

Definition at line 164 of file datacollection.hpp.

QFieldMap mfem::DataCollection::q_field_map

protected

A FieldMap mapping registered names to QuadratureFunction pointers.

Definition at line 170 of file datacollection.hpp.

bool mfem::DataCollection::serial

protected

Serial or parallel run? False iff mesh is a ParMesh.

Definition at line 185 of file datacollection.hpp.

double mfem::DataCollection::time

protected

Physical time (for time-dependent simulations)

Definition at line 179 of file datacollection.hpp.

double mfem::DataCollection::time_step

protected

Time step i.e. delta_t (for time-dependent simulations)

Definition at line 182 of file datacollection.hpp.

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

fem/datacollection.hpp
fem/datacollection.cpp

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation