Data collection that uses FMS. More...

#include <fmsdatacollection.hpp>

Inheritance diagram for mfem::FMSDataCollection:

Collaboration diagram for mfem::FMSDataCollection:

Public Member Functions
	FMSDataCollection (const std::string &collection_name, Mesh *mesh=NULL)
	Constructor. The collection name is used when saving the data.

	FMSDataCollection (MPI_Comm comm, const std::string &collection_name, Mesh *mesh=NULL)
	Construct a parallel FMSDataCollection.

virtual	~FMSDataCollection ()
	We will delete the mesh and fields if we own them.

void	SetProtocol (const std::string &protocol)
	Set the FMS relay i/o protocol to use.

virtual void	Save ()
	Save the collection and a FMS blueprint root file.

virtual void	Load (int cycle=0)
	Load the collection based blueprint data.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	SetTime (real_t t)
	Set physical time (for time-dependent simulations)

void	SetTimeStep (real_t ts)
	Set the simulation time step (for time-dependent simulations)

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

real_t	GetTime () const
	Get physical time (for time-dependent simulations)

real_t	GetTimeStep () const
	Get the simulation time step (for time-dependent simulations)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

int	Error () const
	Get the current error state.

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

Protected Member Functions
std::string	RootFileName ()
	Returns file name for the current cycle.

Protected Member Functions inherited from mfem::DataCollection
void	DeleteData ()
	Delete data owned by the DataCollection keeping field information.

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

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.

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

Protected Attributes
std::string	fms_protocol

Protected Attributes inherited from mfem::DataCollection
std::string	name
	Name of the collection, used as a directory name when saving.

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

GFieldMap	field_map

QFieldMap	q_field_map

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

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

real_t	time
	Physical time (for time-dependent simulations)

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

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

bool	appendRankToFileName
	Append rank to any output file names.

int	myid
	MPI rank (in parallel)

int	num_procs
	Number of MPI ranks (in parallel)

MPI_Comm	m_comm
	Associated MPI communicator.

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

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

int	pad_digits_rank

int	format
	Output mesh format: see the Format enumeration.

int	compression

bool	own_data
	Should the collection delete its mesh and fields.

int	error
	Error state.

Additional Inherited Members
Public Types inherited from mfem::DataCollection
enum	Format { SERIAL_FORMAT = 0 , PARALLEL_FORMAT = 1 }
	Format constants to be used with SetFormat(). More...

enum	{ NO_ERROR = 0 , 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

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

Static Protected Attributes inherited from mfem::DataCollection
static const int	precision_default = 6
	Default value for precision.

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

Detailed Description

Data collection that uses FMS.

FMSDataCollection lets MFEM read/write data using FMS.

For more information, see:

FMS project, https://ceed.exascaleproject.org/fms/ Data collection with FMS I/O routines

Definition at line 33 of file fmsdatacollection.hpp.

Constructor & Destructor Documentation

◆ FMSDataCollection() [1/2]

mfem::FMSDataCollection::FMSDataCollection	(	const std::string &	collection_name,
		Mesh *	mesh = NULL )

Constructor. The collection name is used when saving the data.

If mesh is NULL, then the mesh can be set later by calling either SetMesh() or Load(). The latter works only in serial.

Definition at line 29 of file fmsdatacollection.cpp.

◆ FMSDataCollection() [2/2]

mfem::FMSDataCollection::FMSDataCollection	(	MPI_Comm	comm,
		const std::string &	collection_name,
		Mesh *	mesh = NULL )

Construct a parallel FMSDataCollection.

Definition at line 40 of file fmsdatacollection.cpp.

◆ ~FMSDataCollection()

mfem::FMSDataCollection::~FMSDataCollection ( )

virtual

We will delete the mesh and fields if we own them.

Definition at line 55 of file fmsdatacollection.cpp.

Member Function Documentation

◆ Load()

void mfem::FMSDataCollection::Load ( int cycle = 0 )

virtual

Load the collection based blueprint data.

Reimplemented from mfem::DataCollection.

Definition at line 81 of file fmsdatacollection.cpp.

◆ RootFileName()

std::string mfem::FMSDataCollection::RootFileName ( )

protected

Returns file name for the current cycle.

Definition at line 149 of file fmsdatacollection.cpp.

◆ Save()

void mfem::FMSDataCollection::Save ( )

virtual

Save the collection and a FMS blueprint root file.

Reimplemented from mfem::DataCollection.

Definition at line 60 of file fmsdatacollection.cpp.

◆ SetProtocol()

void mfem::FMSDataCollection::SetProtocol ( const std::string & protocol )

Set the FMS relay i/o protocol to use.

Supported options: ascii (default), json, yaml, hdf5

Definition at line 144 of file fmsdatacollection.cpp.

Member Data Documentation

◆ fms_protocol

std::string mfem::FMSDataCollection::fms_protocol

protected

Definition at line 42 of file fmsdatacollection.hpp.

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

fem/fmsdatacollection.hpp
fem/fmsdatacollection.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FMSDataCollection() [1/2]

◆ FMSDataCollection() [2/2]

◆ ~FMSDataCollection()

Member Function Documentation

◆ Load()

◆ RootFileName()

◆ Save()

◆ SetProtocol()

Member Data Documentation

◆ fms_protocol