Reference documentation for deal.II version 8.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
XDMFEntry Class Reference

#include <data_out_base.h>

Public Member Functions

 XDMFEntry (const std::string filename, const double time, const unsigned int nodes, const unsigned int cells, const unsigned int dim)
 
 XDMFEntry (const std::string mesh_filename, const std::string solution_filename, const double time, const unsigned int nodes, const unsigned int cells, const unsigned int dim)
 
void add_attribute (const std::string &attr_name, const unsigned int dimension)
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 
std::string get_xdmf_content (const unsigned int indent_level) const
 

Private Member Functions

std::string indent (const unsigned int indent_level) const
 Small function to create indentation for XML file.
 

Private Attributes

bool valid
 Whether this entry is valid and contains data to be written.
 
std::string h5_sol_filename
 The name of the HDF5 heavy data solution and/or mesh files this entry references.
 
std::string h5_mesh_filename
 
double entry_time
 The simulation time associated with this entry.
 
unsigned int num_nodes
 The number of nodes, cells and dimensionality associated with the data.
 
unsigned int num_cells
 
unsigned int dimension
 
std::map< std::string,
unsigned int
attribute_dims
 The attributes associated with this entry and their dimension.
 

Detailed Description

A class to store relevant data to use when writing the light data XDMF file. This should only contain valid data on the root node which writes the files, the rest of the nodes will have valid set to false. The XDMF file in turn points to heavy data files (such as HDF5) where the actual simulation data is stored. This allows flexibility in arranging the data, and also allows the mesh to be separated from the the point data.

Definition at line 3143 of file data_out_base.h.

Member Function Documentation

void XDMFEntry::add_attribute ( const std::string &  attr_name,
const unsigned int  dimension 
)
inline

Record an attribute and associated dimensionality.

Definition at line 3173 of file data_out_base.h.

template<class Archive >
void XDMFEntry::serialize ( Archive &  ar,
const unsigned int  version 
)
inline

Read or write the data of this object for serialization

Definition at line 3182 of file data_out_base.h.

std::string XDMFEntry::get_xdmf_content ( const unsigned int  indent_level) const

Get the XDMF content associated with this entry. If the entry is not valid, this returns an empty string.


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