XDMFEntry Class Reference

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

Public Member Functions
	XDMFEntry ()
	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)
	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, const unsigned int spacedim)
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 Attributes
bool	valid
std::string	h5_sol_filename
std::string	h5_mesh_filename
double	entry_time
unsigned int	num_nodes
unsigned int	num_cells
unsigned int	dimension
unsigned int	space_dimension
std::map< std::string, unsigned int >	attribute_dims

Detailed Description

A class to store relevant data to use when writing a lightweight XDMF file. 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 point data.

Definition at line 2997 of file data_out_base.h.

Constructor & Destructor Documentation

XDMFEntry() [1/4]

XDMFEntry::XDMFEntry

(

)

Default constructor that creates an invalid object.

Definition at line 7760 of file data_out_base.cc.

XDMFEntry() [2/4]

XDMFEntry::XDMFEntry	(	const std::string &	filename,
		const double	time,
		const unsigned int	nodes,
		const unsigned int	cells,
		const unsigned int	dim
	)

Simplified constructor that calls the complete constructor for cases where solution_filename == mesh_filename, and dim==spacedim.

Definition at line 7774 of file data_out_base.cc.

XDMFEntry() [3/4]

XDMFEntry::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
	)

Simplified constructor that calls the complete constructor for cases where dim==spacedim.

Definition at line 7791 of file data_out_base.cc.

XDMFEntry() [4/4]

XDMFEntry::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,
		const unsigned int	spacedim
	)

Constructor that sets all members to provided parameters.

Definition at line 7809 of file data_out_base.cc.

Member Function Documentation

add_attribute()

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

Record an attribute and associated dimensionality.

Definition at line 7830 of file data_out_base.cc.

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 3047 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 7853 of file data_out_base.cc.

Member Data Documentation

valid

bool XDMFEntry::valid

private

Whether this entry is valid and contains data to be written.

Definition at line 3069 of file data_out_base.h.

h5_sol_filename

std::string XDMFEntry::h5_sol_filename

private

The name of the HDF5 heavy data solution file this entry references.

Definition at line 3074 of file data_out_base.h.

h5_mesh_filename

std::string XDMFEntry::h5_mesh_filename

private

The name of the HDF5 mesh file this entry references.

Definition at line 3079 of file data_out_base.h.

entry_time

double XDMFEntry::entry_time

private

The simulation time associated with this entry.

Definition at line 3084 of file data_out_base.h.

num_nodes

unsigned int XDMFEntry::num_nodes

private

The number of data nodes.

Definition at line 3089 of file data_out_base.h.

num_cells

unsigned int XDMFEntry::num_cells

private

The number of data cells.

Definition at line 3094 of file data_out_base.h.

dimension

unsigned int XDMFEntry::dimension

private

The dimension associated with the data.

Definition at line 3099 of file data_out_base.h.

space_dimension

unsigned int XDMFEntry::space_dimension

private

The dimension of the space the data lives in. Note that dimension <= space_dimension.

Definition at line 3105 of file data_out_base.h.

attribute_dims

std::map<std::string, unsigned int> XDMFEntry::attribute_dims

private

The attributes associated with this entry and their dimension.

Definition at line 3110 of file data_out_base.h.

---

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

• deal.II/base/data_out_base.h
• source/base/data_out_base.cc