MeshLib::IO::XdmfData Struct Reference

Detailed Description

Definition at line 29 of file XdmfData.h.

#include <XdmfData.h>

Public Member Functions
	XdmfData (std::size_t size_partitioned_dim, std::size_t size_tuple, MeshPropertyDataType mesh_property_data_type, std::string const &name, std::optional< MeshLib::MeshItemType > attribute_center, unsigned int const index, unsigned int n_files, std::optional< ParentDataType > parent_data_type)
	XdmfData contains meta data to be passed to the XdmfWriter - it does not contain the actual values!!

Public Attributes
std::vector< XdmfDimType >	starts
std::vector< XdmfDimType >	strides
std::vector< XdmfDimType >	global_block_dims
MeshPropertyDataType	data_type
std::string	name
std::optional< MeshLib::MeshItemType >	attribute_center
unsigned int	index
std::optional< ParentDataType >	parent_data_type

Constructor & Destructor Documentation

XdmfData()

MeshLib::IO::XdmfData::XdmfData	(	std::size_t	size_partitioned_dim,
		std::size_t	size_tuple,
		MeshPropertyDataType	mesh_property_data_type,
		std::string const &	name,
		std::optional< MeshLib::MeshItemType >	attribute_center,
		unsigned int const	index,
		unsigned int	n_files,
		std::optional< ParentDataType >	parent_data_type )

XdmfData contains meta data to be passed to the XdmfWriter - it does not contain the actual values!!

Parameters

size_partitioned_dim	The first dimension (index 0) is assumed to be the dimension that is partitioned. This first dimension expresses the length, usually the number of nodes or the number of cells. These values give the length of the local partition.
size_tuple	We assume there is at most a rank of 2 of data (properties). The size of tuple gives the length of the second dimension (index 1).
mesh_property_data_type	property vector data type.
name	The name of the attribute. It assumed to be unique.
attribute_center	XdmfData is used for topology, geometry and attributes. Geometry and topology have never a attribute_center. Attributes have always an attribute_center
index	The position of the DataItem parents in a grid (representing a single step). Convention is: 1=Time, 2= Geometry, 3=Topology, 4>=Attribute
n_files	specifies the number of files. If greater than 1 it groups the data of each process to n_files
parent_data_type	specifies the type of the parent structure (e.g. Topology, DataItem, Grid)

Definition at line 21 of file XdmfData.cpp.

    : starts(
          [&size_tuple]()
          {
              if (size_tuple > 1)
              {
                  return std::vector<XdmfDimType>{0, 0};
              }
              else
              {
                  return std::vector<XdmfDimType>{0};
              }
          }()),
      strides(
          [&size_tuple]()
          {
              if (size_tuple > 1)
              {
                  return std::vector<XdmfDimType>{1, 1};
              }
              else
              {
                  return std::vector<XdmfDimType>{1};
              }
          }()),
      data_type(mesh_property_data_type),
      name(name),
      attribute_center(attribute_center),
      index(index),
      parent_data_type(parent_data_type)
{
    auto partition_info = getPartitionInfo(size_partitioned_dim, n_files);
    // TODO (tm) XdmfLib does not support 64 bit data types so far
    assert(partition_info.local_length <
           std::numeric_limits<unsigned int>::max());
    auto const ui_global_components =
        static_cast<unsigned int>(partition_info.global_length);
    auto const ui_tuple_size = static_cast<unsigned int>(size_tuple);
 
    if (ui_tuple_size == 1)
    {
        global_block_dims = {ui_global_components};
    }
    else
    {
        global_block_dims = {ui_global_components, ui_tuple_size};
    }
 
    DBUG(
        "XDMF: dataset name: {:s}, offset: {:d} "
        "global_blocks: {:d}, tuples: {:d}",
        name, partition_info.local_offset, global_block_dims[0], ui_tuple_size);
}

Member Data Documentation

attribute_center

std::optional<MeshLib::MeshItemType> MeshLib::IO::XdmfData::attribute_center

Definition at line 67 of file XdmfData.h.

Referenced by MeshLib::IO::write_xdmf().

data_type

MeshPropertyDataType MeshLib::IO::XdmfData::data_type

Definition at line 65 of file XdmfData.h.

global_block_dims

std::vector<XdmfDimType> MeshLib::IO::XdmfData::global_block_dims

Definition at line 64 of file XdmfData.h.

Referenced by MeshLib::IO::write_xdmf().

index

unsigned int MeshLib::IO::XdmfData::index

Definition at line 68 of file XdmfData.h.

name

std::string MeshLib::IO::XdmfData::name

Definition at line 66 of file XdmfData.h.

Referenced by MeshLib::IO::write_xdmf().

parent_data_type

std::optional<ParentDataType> MeshLib::IO::XdmfData::parent_data_type

Definition at line 69 of file XdmfData.h.

Referenced by MeshLib::IO::write_xdmf().

starts

std::vector<XdmfDimType> MeshLib::IO::XdmfData::starts

Definition at line 62 of file XdmfData.h.

strides

std::vector<XdmfDimType> MeshLib::IO::XdmfData::strides

Definition at line 63 of file XdmfData.h.

---

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

• MeshLib/IO/XDMF/XdmfData.h
• MeshLib/IO/XDMF/XdmfData.cpp