SENSEI
A frame work for generic in situ analytics
sensei::MeshMetadataFlags Class Reference

a set of flags describing which optional fields in the MeshMetadata structure should be generated. More...

#include <MeshMetadata.h>

Public Member Functions

 MeshMetadataFlags (long long flags)
 
void SetAll ()
 
void ClearAll ()
 
void SetBlockDecomp ()
 set, clear, or check flag to generate arrays describing the domain decomposition. More...
 
void ClearBlockDecomp ()
 set, clear, or check flag to generate arrays describing the domain decomposition. More...
 
bool BlockDecompSet () const
 set, clear, or check flag to generate arrays describing the domain decomposition. More...
 
void SetBlockSize ()
 set, clear, or check flag to generate global and block size arrays MeshMetadata.BlockNumPoints, MeshMetadata.BlockNumCells, and MeshMetadata.BlockCellArraySize) More...
 
void ClearBlockSize ()
 set, clear, or check flag to generate global and block size arrays MeshMetadata.BlockNumPoints, MeshMetadata.BlockNumCells, and MeshMetadata.BlockCellArraySize) More...
 
bool BlockSizeSet () const
 set, clear, or check flag to generate global and block size arrays MeshMetadata.BlockNumPoints, MeshMetadata.BlockNumCells, and MeshMetadata.BlockCellArraySize) More...
 
void SetBlockExtents ()
 set, clear, or check flag to generate block extent arrays MeshMetadata.BlockExtents More...
 
void ClearBlockExtents ()
 set, clear, or check flag to generate block extent arrays MeshMetadata.BlockExtents More...
 
bool BlockExtentsSet () const
 set, clear, or check flag to generate block extent arrays MeshMetadata.BlockExtents More...
 
void SetBlockBounds ()
 set, clear, or check flag to generate block bounds arrays MeshMetaData.BlockBounds More...
 
void ClearBlockBounds ()
 set, clear, or check flag to generate block bounds arrays MeshMetaData.BlockBounds More...
 
bool BlockBoundsSet () const
 set, clear, or check flag to generate block bounds arrays MeshMetaData.BlockBounds More...
 
void SetBlockArrayRange ()
 set, clear, or check flag to generate block array ranges (MeshMetadata.BlockArrayRange) More...
 
void ClearBlockArrayRange ()
 set, clear, or check flag to generate block array ranges (MeshMetadata.BlockArrayRange) More...
 
bool BlockArrayRangeSet () const
 set, clear, or check flag to generate block array ranges (MeshMetadata.BlockArrayRange) More...
 
int ToStream (sensei::BinaryStream &str) const
 serialize for communication and/or I/O More...
 
int FromStream (sensei::BinaryStream &str)
 deserialize for communication and/or I/O More...
 
int ToStream (ostream &str) const
 serialize for human readable I/O More...
 

Detailed Description

a set of flags describing which optional fields in the MeshMetadata structure should be generated.

Member Function Documentation

◆ BlockArrayRangeSet()

bool sensei::MeshMetadataFlags::BlockArrayRangeSet ( ) const
inline

set, clear, or check flag to generate block array ranges (MeshMetadata.BlockArrayRange)

◆ BlockBoundsSet()

bool sensei::MeshMetadataFlags::BlockBoundsSet ( ) const
inline

set, clear, or check flag to generate block bounds arrays MeshMetaData.BlockBounds

◆ BlockDecompSet()

bool sensei::MeshMetadataFlags::BlockDecompSet ( ) const
inline

set, clear, or check flag to generate arrays describing the domain decomposition.

This incudles MPI rank block ownership arrays (MeshMetadata.BlockOwner and MeshMetadata.BlockIds)

◆ BlockExtentsSet()

bool sensei::MeshMetadataFlags::BlockExtentsSet ( ) const
inline

set, clear, or check flag to generate block extent arrays MeshMetadata.BlockExtents

◆ BlockSizeSet()

bool sensei::MeshMetadataFlags::BlockSizeSet ( ) const
inline

set, clear, or check flag to generate global and block size arrays MeshMetadata.BlockNumPoints, MeshMetadata.BlockNumCells, and MeshMetadata.BlockCellArraySize)

◆ ClearBlockArrayRange()

void sensei::MeshMetadataFlags::ClearBlockArrayRange ( )
inline

set, clear, or check flag to generate block array ranges (MeshMetadata.BlockArrayRange)

◆ ClearBlockBounds()

void sensei::MeshMetadataFlags::ClearBlockBounds ( )
inline

set, clear, or check flag to generate block bounds arrays MeshMetaData.BlockBounds

◆ ClearBlockDecomp()

void sensei::MeshMetadataFlags::ClearBlockDecomp ( )
inline

set, clear, or check flag to generate arrays describing the domain decomposition.

This incudles MPI rank block ownership arrays (MeshMetadata.BlockOwner and MeshMetadata.BlockIds)

◆ ClearBlockExtents()

void sensei::MeshMetadataFlags::ClearBlockExtents ( )
inline

set, clear, or check flag to generate block extent arrays MeshMetadata.BlockExtents

◆ ClearBlockSize()

void sensei::MeshMetadataFlags::ClearBlockSize ( )
inline

set, clear, or check flag to generate global and block size arrays MeshMetadata.BlockNumPoints, MeshMetadata.BlockNumCells, and MeshMetadata.BlockCellArraySize)

◆ FromStream()

int sensei::MeshMetadataFlags::FromStream ( sensei::BinaryStream str)

deserialize for communication and/or I/O

◆ SetBlockArrayRange()

void sensei::MeshMetadataFlags::SetBlockArrayRange ( )
inline

set, clear, or check flag to generate block array ranges (MeshMetadata.BlockArrayRange)

◆ SetBlockBounds()

void sensei::MeshMetadataFlags::SetBlockBounds ( )
inline

set, clear, or check flag to generate block bounds arrays MeshMetaData.BlockBounds

◆ SetBlockDecomp()

void sensei::MeshMetadataFlags::SetBlockDecomp ( )
inline

set, clear, or check flag to generate arrays describing the domain decomposition.

This incudles MPI rank block ownership arrays (MeshMetadata.BlockOwner and MeshMetadata.BlockIds)

◆ SetBlockExtents()

void sensei::MeshMetadataFlags::SetBlockExtents ( )
inline

set, clear, or check flag to generate block extent arrays MeshMetadata.BlockExtents

◆ SetBlockSize()

void sensei::MeshMetadataFlags::SetBlockSize ( )
inline

set, clear, or check flag to generate global and block size arrays MeshMetadata.BlockNumPoints, MeshMetadata.BlockNumCells, and MeshMetadata.BlockCellArraySize)

◆ ToStream() [1/2]

int sensei::MeshMetadataFlags::ToStream ( sensei::BinaryStream str) const

serialize for communication and/or I/O

◆ ToStream() [2/2]

int sensei::MeshMetadataFlags::ToStream ( ostream &  str) const

serialize for human readable I/O


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