Reference documentation for deal.II version GIT db2fd67796 2022-12-07 23:35:02+00:00
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Member Functions | Private Attributes | List of all members
XDMFEntry Class Reference

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

Public Member Functions

 XDMFEntry ()
 
 XDMFEntry (const std::string &filename, const double time, const std::uint64_t nodes, const std::uint64_t cells, const unsigned int dim, const ReferenceCell &cell_type)
 
 XDMFEntry (const std::string &filename, const double time, const std::uint64_t nodes, const std::uint64_t cells, const unsigned int dim)
 
 XDMFEntry (const std::string &mesh_filename, const std::string &solution_filename, const double time, const std::uint64_t nodes, const std::uint64_t cells, const unsigned int dim)
 
 XDMFEntry (const std::string &mesh_filename, const std::string &solution_filename, const double time, const std::uint64_t nodes, const std::uint64_t cells, const unsigned int dim, const ReferenceCell &cell_type)
 
 XDMFEntry (const std::string &mesh_filename, const std::string &solution_filename, const double time, const std::uint64_t nodes, const std::uint64_t cells, const unsigned int dim, const unsigned int spacedim)
 
 XDMFEntry (const std::string &mesh_filename, const std::string &solution_filename, const double time, const std::uint64_t nodes, const std::uint64_t cells, const unsigned int dim, const unsigned int spacedim, const ReferenceCell &cell_type)
 
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
 
std::string get_xdmf_content (const unsigned int indent_level, const ReferenceCell &reference_cell) const
 

Private Attributes

bool valid
 
std::string h5_sol_filename
 
std::string h5_mesh_filename
 
double entry_time
 
std::uint64_t num_nodes
 
std::uint64_t num_cells
 
unsigned int dimension
 
unsigned int space_dimension
 
ReferenceCell cell_type
 
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 3367 of file data_out_base.h.

Constructor & Destructor Documentation

◆ XDMFEntry() [1/7]

XDMFEntry::XDMFEntry ( )

Default constructor that creates an invalid object.

Definition at line 9975 of file data_out_base.cc.

◆ XDMFEntry() [2/7]

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

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

Definition at line 9997 of file data_out_base.cc.

◆ XDMFEntry() [3/7]

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

Deprecated constructor.

Deprecated:
Use the constructor that additionally takes a ReferenceCell.

Definition at line 9989 of file data_out_base.cc.

◆ XDMFEntry() [4/7]

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

Deprecated constructor.

Deprecated:
Use the constructor that additionally takes a ReferenceCell.

Definition at line 10008 of file data_out_base.cc.

◆ XDMFEntry() [5/7]

XDMFEntry::XDMFEntry ( const std::string &  mesh_filename,
const std::string &  solution_filename,
const double  time,
const std::uint64_t  nodes,
const std::uint64_t  cells,
const unsigned int  dim,
const ReferenceCell cell_type 
)

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

Definition at line 10026 of file data_out_base.cc.

◆ XDMFEntry() [6/7]

XDMFEntry::XDMFEntry ( const std::string &  mesh_filename,
const std::string &  solution_filename,
const double  time,
const std::uint64_t  nodes,
const std::uint64_t  cells,
const unsigned int  dim,
const unsigned int  spacedim 
)

Deprecated constructor.

Deprecated:
Use the constructor that additionally takes a ReferenceCell.

Definition at line 10045 of file data_out_base.cc.

◆ XDMFEntry() [7/7]

XDMFEntry::XDMFEntry ( const std::string &  mesh_filename,
const std::string &  solution_filename,
const double  time,
const std::uint64_t  nodes,
const std::uint64_t  cells,
const unsigned int  dim,
const unsigned int  spacedim,
const ReferenceCell cell_type 
)

Constructor that sets all members to provided parameters.

Definition at line 10097 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 10119 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 using the BOOST serialization library.

Definition at line 3461 of file data_out_base.h.

◆ get_xdmf_content() [1/2]

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

◆ get_xdmf_content() [2/2]

std::string XDMFEntry::get_xdmf_content ( const unsigned int  indent_level,
const ReferenceCell reference_cell 
) const

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

Deprecated:
Use the other function instead.

Definition at line 10145 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 3489 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 3494 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 3499 of file data_out_base.h.

◆ entry_time

double XDMFEntry::entry_time
private

The simulation time associated with this entry.

Definition at line 3504 of file data_out_base.h.

◆ num_nodes

std::uint64_t XDMFEntry::num_nodes
private

The number of data nodes.

Definition at line 3509 of file data_out_base.h.

◆ num_cells

std::uint64_t XDMFEntry::num_cells
private

The number of data cells.

Definition at line 3514 of file data_out_base.h.

◆ dimension

unsigned int XDMFEntry::dimension
private

The dimension associated with the data.

Definition at line 3519 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 3525 of file data_out_base.h.

◆ cell_type

ReferenceCell XDMFEntry::cell_type
private

The type of cell in deal.II language. We currently only support xdmf entries where all cells have the same type.

Definition at line 3531 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 3536 of file data_out_base.h.


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