Writer for ParaView visualization (PVD and VTU format) More...

#include <datacollection.hpp>

Inheritance diagram for mfem::ParaViewDataCollection:

Collaboration diagram for mfem::ParaViewDataCollection:

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

const CoeffFieldMap::MapType &	GetCoeffFieldMap () const
	Get a const reference to the internal coefficient-field map.

const VCoeffFieldMap::MapType &	GetVCoeffFieldMap () const

void	RegisterCoeffField (const std::string &field_name, Coefficient *coeff)
	Add a Coefficient or VectorCoefficient to the collection.

void	RegisterVCoeffField (const std::string &field_name, VectorCoefficient *vcoeff)

void	DeregisterCoeffField (const std::string &field_name)
	Remove a Coefficient or VectorCoefficient from the collection.

void	DeregisterVCoeffField (const std::string &field_name)

void	Save () override

Public Member Functions inherited from mfem::ParaViewDataCollectionBase
	ParaViewDataCollectionBase (const std::string &name, Mesh *mesh)

void	SetLevelsOfDetail (int levels_of_detail_)
	Set the refinement level.

void	SetCompressionLevel (int compression_level_)
	Set the zlib compression level.

void	SetHighOrderOutput (bool high_order_output_)
	Sets whether or not to output the data as high-order elements (false by default).

void	SetBoundaryOutput (bool bdr_output_)
	Configures collection to save only fields evaluated on boundaries of the mesh.

int	GetCompressionLevel () const
	If compression is enabled, return the compression level, else return 0.

void	SetDataFormat (VTKFormat fmt)
	Set the data format for the ParaView output files.

bool	IsBinaryFormat () const
	Returns true if the output format is BINARY or BINARY32, false if ASCII.

void	UseRestartMode (bool restart_mode_)
	Enable or disable restart mode.

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 &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 &field_name) const
	Check if a QuadratureFunction with the given name is in the collection.

QuadratureFunction *	GetQField (const std::string &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 &field_name)
	Save one q-field, assuming the collection directory already exists.

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

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
void	WritePVTUHeader (std::ostream &out)

void	WritePVTUFooter (std::ostream &out, const std::string &vtu_prefix)

void	SaveDataVTU (std::ostream &out, int ref)

void	SaveGFieldVTU (std::ostream &out, int ref_, const FieldMapIterator &it)

void	SaveCoeffFieldVTU (std::ostream &out, int ref_, const std::string &name, Coefficient &coeff)

void	SaveVCoeffFieldVTU (std::ostream &out, int ref_, const std::string &name, VectorCoefficient &coeff)

const char *	GetDataFormatString () const

const char *	GetDataTypeString () const

std::string	GenerateCollectionPath ()

std::string	GenerateVTUFileName (const std::string &prefix, int rank)

std::string	GenerateVTUPath ()

std::string	GeneratePVDFileName ()

std::string	GeneratePVTUFileName (const std::string &prefix)

std::string	GeneratePVTUPath ()

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.

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)

Protected Attributes inherited from mfem::ParaViewDataCollectionBase
int	levels_of_detail = 1

int	compression_level = -1

bool	high_order_output = false

bool	restart_mode = false

bool	bdr_output = false

VTKFormat	pv_data_format = VTKFormat::BINARY

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.

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

Writer for ParaView visualization (PVD and VTU format)

Definition at line 584 of file datacollection.hpp.

Constructor & Destructor Documentation

◆ ParaViewDataCollection()

mfem::ParaViewDataCollection::ParaViewDataCollection	(	const std::string &	collection_name,
		Mesh *	mesh_ = nullptr )

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

If mesh_ is NULL, then the mesh can be set later by calling SetMesh(). Before saving the data collection, some parameters in the collection can be adjusted, e.g. SetPadDigits(), SetPrefixPath(), etc.

Definition at line 851 of file datacollection.cpp.

Member Function Documentation

◆ DeregisterCoeffField()

void mfem::ParaViewDataCollection::DeregisterCoeffField ( const std::string & field_name )

inline

Remove a Coefficient or VectorCoefficient from the collection.

Definition at line 638 of file datacollection.hpp.

◆ DeregisterVCoeffField()

void mfem::ParaViewDataCollection::DeregisterVCoeffField ( const std::string & field_name )

inline

Definition at line 640 of file datacollection.hpp.

◆ GenerateCollectionPath()

std::string mfem::ParaViewDataCollection::GenerateCollectionPath ( )

protected

Definition at line 855 of file datacollection.cpp.

◆ GeneratePVDFileName()

std::string mfem::ParaViewDataCollection::GeneratePVDFileName ( )

protected

Definition at line 870 of file datacollection.cpp.

◆ GeneratePVTUFileName()

std::string mfem::ParaViewDataCollection::GeneratePVTUFileName ( const std::string & prefix )

protected

Definition at line 875 of file datacollection.cpp.

◆ GeneratePVTUPath()

std::string mfem::ParaViewDataCollection::GeneratePVTUPath ( )

protected

Definition at line 860 of file datacollection.cpp.

◆ GenerateVTUFileName()

std::string mfem::ParaViewDataCollection::GenerateVTUFileName	(	const std::string &	prefix,
		int	rank )

protected

Definition at line 881 of file datacollection.cpp.

◆ GenerateVTUPath()

std::string mfem::ParaViewDataCollection::GenerateVTUPath ( )

protected

Definition at line 865 of file datacollection.cpp.

◆ GetCoeffFieldMap()

const CoeffFieldMap::MapType & mfem::ParaViewDataCollection::GetCoeffFieldMap ( ) const

inline

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

Definition at line 625 of file datacollection.hpp.

◆ GetDataFormatString()

const char * mfem::ParaViewDataCollection::GetDataFormatString ( ) const

protected

Definition at line 1336 of file datacollection.cpp.

◆ GetDataTypeString()

const char * mfem::ParaViewDataCollection::GetDataTypeString ( ) const

protected

Definition at line 1348 of file datacollection.cpp.

◆ GetVCoeffFieldMap()

const VCoeffFieldMap::MapType & mfem::ParaViewDataCollection::GetVCoeffFieldMap ( ) const

inline

Definition at line 627 of file datacollection.hpp.

◆ RegisterCoeffField()

void mfem::ParaViewDataCollection::RegisterCoeffField	(	const std::string &	field_name,
		Coefficient *	coeff )

inline

Add a Coefficient or VectorCoefficient to the collection.

Definition at line 631 of file datacollection.hpp.

◆ RegisterVCoeffField()

void mfem::ParaViewDataCollection::RegisterVCoeffField	(	const std::string &	field_name,
		VectorCoefficient *	vcoeff )

inline

Definition at line 633 of file datacollection.hpp.

◆ Save()

void mfem::ParaViewDataCollection::Save ( )

overridevirtual

Save the collection - the directory name is constructed based on the cycle value

Reimplemented from mfem::DataCollection.

Definition at line 887 of file datacollection.cpp.

◆ SaveCoeffFieldVTU()

void mfem::ParaViewDataCollection::SaveCoeffFieldVTU	(	std::ostream &	out,
		int	ref_,
		const std::string &	name,
		Coefficient &	coeff )

protected

Definition at line 1214 of file datacollection.cpp.

◆ SaveDataVTU()

void mfem::ParaViewDataCollection::SaveDataVTU	(	std::ostream &	out,
		int	ref )

protected

Definition at line 1123 of file datacollection.cpp.

◆ SaveGFieldVTU()

void mfem::ParaViewDataCollection::SaveGFieldVTU	(	std::ostream &	out,
		int	ref_,
		const FieldMapIterator &	it )

protected

Definition at line 1163 of file datacollection.cpp.

◆ SaveVCoeffFieldVTU()

void mfem::ParaViewDataCollection::SaveVCoeffFieldVTU	(	std::ostream &	out,
		int	ref_,
		const std::string &	name,
		VectorCoefficient &	coeff )

protected

Definition at line 1271 of file datacollection.cpp.

◆ WritePVTUFooter()

void mfem::ParaViewDataCollection::WritePVTUFooter	(	std::ostream &	out,
		const std::string &	vtu_prefix )

protected

Definition at line 1111 of file datacollection.cpp.

◆ WritePVTUHeader()

void mfem::ParaViewDataCollection::WritePVTUHeader ( std::ostream & out )

protected

Definition at line 1085 of file datacollection.cpp.

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

fem/datacollection.hpp
fem/datacollection.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ParaViewDataCollection()

Member Function Documentation

◆ DeregisterCoeffField()

◆ DeregisterVCoeffField()

◆ GenerateCollectionPath()

◆ GeneratePVDFileName()

◆ GeneratePVTUFileName()

◆ GeneratePVTUPath()

◆ GenerateVTUFileName()

◆ GenerateVTUPath()

◆ GetCoeffFieldMap()

◆ GetDataFormatString()

◆ GetDataTypeString()

◆ GetVCoeffFieldMap()

◆ RegisterCoeffField()

◆ RegisterVCoeffField()

◆ Save()

◆ SaveCoeffFieldVTU()

◆ SaveDataVTU()

◆ SaveGFieldVTU()

◆ SaveVCoeffFieldVTU()

◆ WritePVTUFooter()

◆ WritePVTUHeader()