Reference documentation for deal.II version 8.5.1
Public Member Functions | Private Member Functions | Private Attributes | List of all members
XDMFEntry Class Reference

#include <deal.II/base/data_out_base.h>

Public Member Functions

void add_attribute (const std::string &attr_name, const unsigned int dimension)
 
template<class Archive >
void serialize (Archive &ar, const unsigned int)
 
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.
 
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.
 
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 2866 of file data_out_base.h.

Member Function Documentation

◆ add_attribute()

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

Record an attribute and associated dimensionality.

Definition at line 2896 of file data_out_base.h.

◆ serialize()

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

Read or write the data of this object for serialization

Definition at line 2905 of file data_out_base.h.

◆ get_xdmf_content()

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.

Definition at line 6609 of file data_out_base.cc.


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