MFEM v4.7.0
Finite element discretization library
|
#include <datacollection.hpp>
Public Types | |
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 |
Public Member Functions | |
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 | Save () |
Save the collection to disk. | |
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 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 | 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. | |
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. | |
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 | |
static const int | precision_default = 6 |
Default value for precision. | |
static const int | pad_digits_default = 6 |
Default value for pad_digits_*. | |
Friends | |
class | ParMesh |
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.
Definition at line 139 of file datacollection.hpp.
Definition at line 138 of file datacollection.hpp.
Definition at line 137 of file datacollection.hpp.
Definition at line 143 of file datacollection.hpp.
Definition at line 142 of file datacollection.hpp.
Definition at line 141 of file datacollection.hpp.
anonymous enum |
Errors returned by Error()
Enumerator | |
---|---|
NO_ERROR | |
No_Error | |
READ_ERROR | |
WRITE_ERROR |
Definition at line 381 of file datacollection.hpp.
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.
|
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.
|
virtual |
Delete the mesh and fields if owned by the collection.
Definition at line 338 of file datacollection.cpp.
|
staticprotected |
Definition at line 34 of file datacollection.cpp.
|
protected |
Delete data owned by the DataCollection including field information.
Definition at line 331 of file datacollection.cpp.
|
protected |
Delete data owned by the DataCollection keeping field information.
Definition at line 321 of file datacollection.cpp.
|
inlinevirtual |
Remove a grid function from the collection.
Reimplemented in mfem::SidreDataCollection.
Definition at line 248 of file datacollection.hpp.
|
inlinevirtual |
Remove a QuadratureFunction from the collection.
Definition at line 258 of file datacollection.hpp.
|
inline |
Get the current error state.
Definition at line 396 of file datacollection.hpp.
|
inline |
Get the name of the collection.
Definition at line 334 of file datacollection.hpp.
|
inline |
Return the associated MPI communicator or MPI_COMM_NULL.
Definition at line 272 of file datacollection.hpp.
|
inline |
Get time cycle (for time-dependent simulations)
Definition at line 327 of file datacollection.hpp.
|
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.
|
protected |
Definition at line 261 of file datacollection.cpp.
|
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.
|
inline |
Get a pointer to the mesh in the collection.
Definition at line 304 of file datacollection.hpp.
|
protected |
Definition at line 256 of file datacollection.cpp.
|
protected |
Definition at line 251 of file datacollection.cpp.
|
inline |
Get a pointer to a parallel grid function in the collection.
Returns NULL if field_name is not in the collection.
Definition at line 278 of file datacollection.hpp.
|
inline |
Get the path where the DataCollection will be saved.
Definition at line 360 of file datacollection.hpp.
|
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.
|
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.
|
inline |
Get physical time (for time-dependent simulations)
Definition at line 329 of file datacollection.hpp.
|
inline |
Get the simulation time step (for time-dependent simulations)
Definition at line 331 of file datacollection.hpp.
|
inline |
Check if a grid function is part of the collection.
Definition at line 262 of file datacollection.hpp.
|
inline |
Check if a QuadratureFunction with the given name is in the collection.
Definition at line 283 of file datacollection.hpp.
|
virtual |
Load the collection. Not implemented in the base class DataCollection.
Reimplemented in mfem::ConduitDataCollection, mfem::FMSDataCollection, mfem::ParaViewDataCollection, mfem::SidreDataCollection, and mfem::VisItDataCollection.
Definition at line 191 of file datacollection.cpp.
|
inlinevirtual |
Add a grid function to the collection.
Reimplemented in mfem::SidreDataCollection, and mfem::VisItDataCollection.
Definition at line 244 of file datacollection.hpp.
|
inlinevirtual |
Add a QuadratureFunction to the collection.
Reimplemented in mfem::VisItDataCollection.
Definition at line 252 of file datacollection.hpp.
|
inline |
Reset the error state.
Definition at line 398 of file datacollection.hpp.
|
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::ADIOS2DataCollection, mfem::ConduitDataCollection, mfem::FMSDataCollection, mfem::ParaViewDataCollection, mfem::SidreDataCollection, and mfem::VisItDataCollection.
Definition at line 196 of file datacollection.cpp.
|
virtual |
Save one field, assuming the collection directory already exists.
Definition at line 303 of file datacollection.cpp.
|
virtual |
Save the mesh, creating the collection directory.
Definition at line 215 of file datacollection.cpp.
|
protected |
Save one field to disk, assuming the collection directory exists.
Definition at line 277 of file datacollection.cpp.
|
protected |
Save one q-field to disk, assuming the collection directory exists.
Definition at line 290 of file datacollection.cpp.
|
virtual |
Save one q-field, assuming the collection directory already exists.
Definition at line 312 of file datacollection.cpp.
|
virtual |
Set the flag for use of gz compressed files.
Reimplemented in mfem::ParaViewDataCollection.
Definition at line 167 of file datacollection.cpp.
|
inline |
Set time cycle (for time-dependent simulations)
Definition at line 319 of file datacollection.hpp.
|
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.
|
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::SidreDataCollection, and mfem::VisItDataCollection.
Definition at line 117 of file datacollection.cpp.
|
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::SidreDataCollection, and mfem::VisItDataCollection.
Definition at line 141 of file datacollection.cpp.
|
inline |
Set the ownership of collection data.
Definition at line 336 of file datacollection.hpp.
|
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.
|
inlinevirtual |
Set the number of digits used for the cycle.
Definition at line 344 of file datacollection.hpp.
|
inlinevirtual |
Set the number of digits used for the MPI rank in filenames.
Definition at line 346 of file datacollection.hpp.
|
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.
|
inline |
Set physical time (for time-dependent simulations)
Definition at line 321 of file datacollection.hpp.
|
inline |
Set the simulation time step (for time-dependent simulations)
Definition at line 324 of file datacollection.hpp.
|
friend |
Definition at line 401 of file datacollection.hpp.
|
protected |
Append rank to any output file names.
Definition at line 187 of file datacollection.hpp.
|
protected |
Definition at line 210 of file datacollection.hpp.
|
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.
|
protected |
Error state.
Definition at line 216 of file datacollection.hpp.
|
protected |
A FieldMap mapping registered field names to GridFunction pointers.
Definition at line 167 of file datacollection.hpp.
|
protected |
Output mesh format: see the Format enumeration.
Definition at line 209 of file datacollection.hpp.
|
protected |
Associated MPI communicator.
Definition at line 195 of file datacollection.hpp.
|
protected |
The (common) mesh for the collected fields.
Definition at line 173 of file datacollection.hpp.
|
protected |
MPI rank (in parallel)
Definition at line 190 of file datacollection.hpp.
|
protected |
Name of the collection, used as a directory name when saving.
Definition at line 160 of file datacollection.hpp.
|
protected |
Number of MPI ranks (in parallel)
Definition at line 192 of file datacollection.hpp.
|
protected |
Should the collection delete its mesh and fields.
Definition at line 213 of file datacollection.hpp.
|
protected |
Number of digits used for the cycle and MPI rank in filenames.
Definition at line 201 of file datacollection.hpp.
|
staticprotected |
Default value for pad_digits_*.
Definition at line 206 of file datacollection.hpp.
|
protected |
Definition at line 201 of file datacollection.hpp.
|
protected |
Precision (number of digits) used for the text output of doubles.
Definition at line 199 of file datacollection.hpp.
|
staticprotected |
Default value for precision.
Definition at line 204 of file datacollection.hpp.
|
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.
|
protected |
A FieldMap mapping registered names to QuadratureFunction pointers.
Definition at line 170 of file datacollection.hpp.
|
protected |
Serial or parallel run? False iff mesh is a ParMesh.
Definition at line 185 of file datacollection.hpp.
|
protected |
Physical time (for time-dependent simulations)
Definition at line 179 of file datacollection.hpp.
|
protected |
Time step i.e. delta_t (for time-dependent simulations)
Definition at line 182 of file datacollection.hpp.