The main namespace for the Ioss library. More...

Namespaces
namespace	glob

namespace	impl

namespace	Init

namespace	Private

namespace	SmartAssert

Classes
class	Assembly
	A homogeneous collection of other GroupingEntities. More...

struct	Assert

class	assert_context

class	Asym_Tensor_01

class	Asym_Tensor_02

class	Asym_Tensor_03

struct	AxisAlignedBoundingBox

struct	Basis

struct	BasisComponent

class	BasisVariableType

class	Beam2

class	Beam3

class	Beam4

class	Blob
	A homogeneous collection of other GroupingEntities. More...

class	BlockDecompositionData

struct	BoundaryCondition

struct	chain_entry_t

class	ChangeSet

class	ChangeSetFactory
	The main public user interface for creating Ioss::ChangeSet objects. More...

class	CommSet

class	Compare

class	ComposedVariableType

class	CompositeVariableType

class	ConstructedVariableType

class	CoordinateFrame

class	DatabaseIO
	An input or output Database. More...

struct	DataPool

class	Decomposition

class	DecompUtils

class	DynamicTopologyBroker

class	DynamicTopologyFileControl

class	DynamicTopologyNotifier

class	DynamicTopologyObserver

struct	DynamicTopologyObserverCompare

class	DynamicTopologyStateLocator

class	Edge2

class	Edge2D2

class	Edge2D3

class	Edge3

class	Edge4

class	EdgeBlock
	A collection of element edges with the same topology. More...

class	EdgeSet
	A collection of element edges. More...

class	ElementBlock
	A collection of elements having the same topology. More...

class	ElementBlockBatchOffset

class	ElementPermutation

class	ElementSet
	A collection of elements. More...

class	ElementTopology
	Represents an element topology. More...

class	ElementVariableType

class	EntityBlock
	Base class for all 'block'-type grouping entities, which means all members of the block are similar or have the same topology. More...

class	EntitySet
	Base class for all 'set'-type grouping entities, which means that members of the set are not necessarily similar, or do not necessarily have the same topology. More...

class	EPRegistry

class	ETRegistry

class	Face

class	FaceBlock
	A collection of element faces with the same topology. More...

struct	FaceEqual

class	FaceGenerator

struct	FaceHash

class	FaceSet
	A collection of element faces. More...

class	Field
	Holds metadata for bulk data associated with a GroupingEntity. More...

class	FieldManager
	A collection of Ioss::Field objects. More...

class	FileInfo
	Return information about the specified file. More...

class	Full_Tensor_12

class	Full_Tensor_16

class	Full_Tensor_22

class	Full_Tensor_32

class	Full_Tensor_36

class	GetLongOption
	A database of program command line and environment variable options and methods for manipulating them. More...

class	GroupingEntity
	Base class for all 'grouping' entities. The following derived classes are typical: More...

class	Hex16

class	Hex20

class	Hex27

class	Hex32

class	Hex64

class	Hex8

class	Hex9

class	HexPermutation

class	Initializer

class	Invalid_Storage

class	IOFactory
	The main public user interface for creating Ioss::DatabaseIO objects. More...

class	LinePermutation

class	Map

class	Matrix_22

class	Matrix_33

class	MemoryUtils

struct	MeshCopyOptions

class	NamedSuffixVariableType

class	Node

class	NodeBlock
	A collection of all nodes in the region. More...

class	NodeSet
	A collection of nodes. More...

class	NullEntity

class	NullPermutation

class	ObjScopeGuardImpl0

class	ObjScopeGuardImpl1

class	ObjScopeGuardImpl2

class	ParallelUtils

class	Property
	A named value that has a known type. More...

class	PropertyManager
	A collection of Ioss::Property objects. More...

class	Pyramid13

class	Pyramid14

class	Pyramid18

class	Pyramid19

class	Pyramid5

class	PyramidPermutation

class	Quad12

class	Quad16

class	Quad4

class	Quad6

class	Quad8

class	Quad9

class	QuadPermutation

struct	QuadraturePoint

class	QuadratureVariableType

class	Quaternion_2D

class	Quaternion_3D

class	RefHolder

class	Region
	A grouping entity that contains other grouping entities. More...

class	Registry

class	Scalar

class	ScopeGuardImpl0

class	ScopeGuardImpl1

class	ScopeGuardImpl2

class	ScopeGuardImpl3

class	ScopeGuardImplBase

class	SerializeIO
	Class `SerializeIO` is a sentry class which performs serialization for mesh database I/O. More...

class	SetDecompositionData

class	Shell4

class	Shell8

class	Shell9

class	ShellLine2D2

class	ShellLine2D3

class	SideBlock
	A collection of element sides having the same topology. More...

class	SideSet
	A collection of element sides. More...

class	Sphere

class	SpherePermutation

class	Spring2

class	Spring3

class	SpringPermutation

class	St_Beam2

class	St_Beam3

class	St_Beam4

class	St_Edge2

class	St_Edge2D2

class	St_Edge2D3

class	St_Edge3

class	St_Edge4

class	St_Hex16

class	St_Hex20

class	St_Hex27

class	St_Hex32

class	St_Hex64

class	St_Hex8

class	St_Hex9

class	St_Node

class	St_Pyramid13

class	St_Pyramid14

class	St_Pyramid18

class	St_Pyramid19

class	St_Pyramid5

class	St_Quad12

class	St_Quad16

class	St_Quad4

class	St_Quad6

class	St_Quad8

class	St_Quad9

class	St_Shell4

class	St_Shell8

class	St_Shell9

class	St_ShellLine2D2

class	St_ShellLine2D3

class	St_Sphere

class	St_Spring2

class	St_Spring3

class	St_Super

class	St_Tet10

class	St_Tet11

class	St_Tet14

class	St_Tet15

class	St_Tet16

class	St_Tet4

class	St_Tet40

class	St_Tet7

class	St_Tet8

class	St_Tri13

class	St_Tri3

class	St_Tri4

class	St_Tri4a

class	St_Tri6

class	St_Tri7

class	St_Tri9

class	St_TriShell3

class	St_TriShell4

class	St_TriShell6

class	St_TriShell7

class	St_Unknown

class	St_Wedge12

class	St_Wedge15

class	St_Wedge16

class	St_Wedge18

class	St_Wedge20

class	St_Wedge21

class	St_Wedge24

class	St_Wedge52

class	St_Wedge6

class	StorageInitializer

class	StructuredBlock
	A structured zone – i,j,k. More...

struct	Suffix

class	Super

class	SuperPermutation

class	Sym_Tensor_10

class	Sym_Tensor_11

class	Sym_Tensor_13

class	Sym_Tensor_21

class	Sym_Tensor_31

class	Sym_Tensor_33

class	TestOnly

class	Tet10

class	Tet11

class	Tet14

class	Tet15

class	Tet16

class	Tet4

class	Tet40

class	Tet7

class	Tet8

class	TetPermutation

class	Tracer

class	Transform

class	TransformFactory

class	Tri13

class	Tri3

class	Tri4

class	Tri4a

class	Tri6

class	Tri7

class	Tri9

class	TriPermutation

class	TriShell3

class	TriShell4

class	TriShell6

class	TriShell7

class	Unknown

class	Utils

class	VariableType
	A generic variable type. More...

class	Vector_2D

class	Vector_3D

class	Wedge12

class	Wedge15

class	Wedge16

class	Wedge18

class	Wedge20

class	Wedge21

class	Wedge24

class	Wedge52

class	Wedge6

class	WedgePermutation

struct	ZoneConnectivity

Typedefs
using	CoordinateFrameContainer = std::vector<CoordinateFrame>

using	EntityContainer = std::vector<const Ioss::GroupingEntity *>

template<typename INT >
using	chain_t = std::vector<chain_entry_t<INT>>

using	FileNameGenerator

using	ChangeSetFactoryValuePair = ChangeSetFactoryMap::value_type

using	NameList = Ioss::NameList

using	ChangeSetFactoryMap = std::map<std::string, ChangeSetFactory *, std::less<>>

using	IntVector = std::vector<int>

using	Int64Vector = std::vector<int64_t>

using	IJK_t = std::array<int, 3>

using	TopoContainer = std::vector<std::pair<const ElementTopology , const ElementTopology >>

using	Ordinal = uint16_t

using	Permutation = uint32_t

using	ElementPermutationMap = std::map<std::string, ElementPermutation *, std::less<>>

using	EPM_VP = ElementPermutationMap::value_type

using	ElementShapeMap = std::map<ElementShape, std::string>

using	ElementTopologyMap = std::map<std::string, ElementTopology *, std::less<>>

using	ETM_VP = ElementTopologyMap::value_type

using	FaceUnorderedSet = tsl::robin_pg_set<Face, FaceHash, FaceEqual>

using	FieldMapType = tsl::robin_pg_map<std::string, Field>

using	FieldValuePair = FieldMapType::value_type

using	IOFactoryValuePair = IOFactoryMap::value_type

using	IOFactoryMap = std::map<std::string, IOFactory *, std::less<>>

using	MapContainer = std::vector<int64_t>

using	ReverseMapContainer = std::unordered_map<int64_t, int64_t>

using	PropMapType = tsl::robin_pg_map<std::string, Property>

using	ValuePair = PropMapType::value_type

using	AssemblyContainer = std::vector<Ioss::Assembly *>

using	BlobContainer = std::vector<Ioss::Blob *>

using	NodeBlockContainer = std::vector<NodeBlock *>

using	EdgeBlockContainer = std::vector<EdgeBlock *>

using	FaceBlockContainer = std::vector<FaceBlock *>

using	ElementBlockContainer = std::vector<ElementBlock *>

using	NodeSetContainer = std::vector<NodeSet *>

using	EdgeSetContainer = std::vector<EdgeSet *>

using	FaceSetContainer = std::vector<FaceSet *>

using	ElementSetContainer = std::vector<ElementSet *>

using	SideSetContainer = std::vector<SideSet *>

using	StructuredBlockContainer = std::vector<StructuredBlock *>

using	CommSetContainer = std::vector<CommSet *>

using	StateTimeContainer = std::vector<double>

using	AliasMap = std::map<std::string, std::string, std::less<>>

using	SideBlockContainer = std::vector<SideBlock *>

using	TransformFactoryMap = std::map<std::string, TransformFactory *, std::less<>>

using	VariableTypeMap = std::map<std::string, VariableType *, std::less<>>

using	VTM_ValuePair = VariableTypeMap::value_type

Enumerations
enum	ChangeSetFormat { CHANGE_SET_NONE = (0) , CHANGE_SET_INTERNAL_FILES = (1U << 0) , CHANGE_SET_LINEAR_MULTI_FILES = (1U << 1) , CHANGE_SET_CYCLIC_MULTI_FILES = (1U << 2) }

enum class	DuplicateFieldBehavior { UNSET_ , IGNORE_ , WARNING_ , ERROR_ }

enum	DataSize { USE_INT32_API = 4 , USE_INT64_API = 8 }
	The number of bytes used to store an integer type. More...

enum	DatabaseUsage { WRITE_RESTART = 1 , READ_RESTART = 2 , WRITE_RESULTS = 4 , READ_MODEL = 8 , WRITE_HISTORY , WRITE_HEARTBEAT , QUERY_TIMESTEPS_ONLY = 64 }
	Specifies how an Ioss::DatabaseIO object will be used. More...

enum	IfDatabaseExistsBehavior { DB_OVERWRITE , DB_APPEND , DB_APPEND_GROUP , DB_MODIFY , DB_ABORT , DB_ADD_SUFFIX , DB_ADD_SUFFIX_OVERWRITE }

enum	TopologyModified { TOPOLOGY_SAME = (0) , TOPOLOGY_REORDER , TOPOLOGY_SHUFFLE = (1U << 1) , TOPOLOGY_HADAPT = (1U << 2) , TOPOLOGY_GHOST = (1U << 3) , TOPOLOGY_GEOMETRY , TOPOLOGY_CREATEFACE = (1U << 5) , TOPOLOGY_CREATEELEM = (1U << 6) , TOPOLOGY_CREATENODE = (1U << 7) , TOPOLOGY_CREATEASSEMBLY = (1U << 8) , TOPOLOGY_UNKNOWN = (1U << 9) , TOPOLOGY_AUXILIARY = (1U << 10) , TOPOLOGY_CONSTRAINT = (1U << 11) }

enum class	FileControlOption { CONTROL_NONE , CONTROL_AUTO_MULTI_FILE , CONTROL_AUTO_GROUP_FILE }

enum class	ElementShape : unsigned { UNKNOWN , POINT , SPHERE , LINE , SPRING , TRI , QUAD , TET , PYRAMID , WEDGE , HEX , SUPER }

enum	EntityType { NODEBLOCK = 1 , EDGEBLOCK = 2 , FACEBLOCK = 4 , ELEMENTBLOCK = 8 , NODESET = 16 , EDGESET = 32 , FACESET = 64 , ELEMENTSET = 128 , SIDESET = 256 , SURFACE = 256 , COMMSET = 512 , SIDEBLOCK = 1024 , REGION = 2048 , SUPERELEMENT = 4096 , STRUCTUREDBLOCK = 8192 , ASSEMBLY = 16384 , BLOB = 32768 , INVALID_TYPE = 65536 }
	The particular type of GroupingEntity. More...

enum class	MeshType { UNKNOWN , STRUCTURED , UNSTRUCTURED , HYBRID }
	The mesh type – structured, unstructured, hybrid (future), or unknown. More...

enum	{ lvl_warn = 100 , lvl_debug = 200 , lvl_error = 300 , lvl_fatal = 1000 }

enum	State { STATE_INVALID = -1 , STATE_UNKNOWN , STATE_READONLY , STATE_CLOSED , STATE_DEFINE_MODEL , STATE_MODEL , STATE_DEFINE_TRANSIENT , STATE_TRANSIENT , STATE_LAST_ENTRY }
	Access states for a database. More...

enum	SurfaceSplitType { SPLIT_INVALID = -1 , SPLIT_BY_TOPOLOGIES = 1 , SPLIT_BY_ELEMENT_BLOCK = 2 , SPLIT_BY_DONT_SPLIT = 3 , SPLIT_LAST_ENTRY = 4 }
	Method used to split sidesets into homogeneous blocks. More...

Functions
template IOSS_EXPORT Ioss::chain_t< int >	generate_element_chains (Ioss::Region &region, const std::string &, int, int)

template IOSS_EXPORT Ioss::chain_t< int64_t >	generate_element_chains (Ioss::Region &region, const std::string &, int, int64_t)

template<typename INT >
Ioss::chain_t< INT >	generate_element_chains (Ioss::Region &region, const std::string &surface_list, int debug_level, INT)

template<typename INT >
IOSS_NODISCARD chain_t< INT >	generate_element_chains (Ioss::Region &region, const std::string &surface_list, int debug_level, INT)

std::string	expand_topology_files (FileNameGenerator generator, const Ioss::ParallelUtils &util, const std::string &basename, const Ioss::PropertyManager &properties, Ioss::DatabaseUsage usage, int step)

std::pair< std::string, Ioss::DatabaseIO * >	expand_topology_files (FileNameGenerator generator, const Ioss::ParallelUtils &util, const std::string &basename, const std::string &db_type, const Ioss::PropertyManager &properties, Ioss::DatabaseUsage usage, int step)

Ioss::FileNameGenerator	construct_cyclic_filename_generator (unsigned cyclicCount)

Ioss::FileNameGenerator	construct_linear_filename_generator ()

IOSS_EXPORT void	copy_database (Ioss::Region &region, Ioss::Region &output_region, Ioss::MeshCopyOptions &options)

IOSS_EXPORT void	transfer_assemblies (Ioss::Region &region, Ioss::Region &output_region, const Ioss::MeshCopyOptions &options, int rank)

IOSS_EXPORT void	transfer_blobs (Ioss::Region &region, Ioss::Region &output_region, const Ioss::MeshCopyOptions &options, int rank)

IOSS_EXPORT void	transfer_coordinate_frames (Ioss::Region &region, Ioss::Region &output_region)

bool	is_input_event (Ioss::DatabaseUsage db_usage)

IOSS_EXPORT const Ioss::NameList &	valid_decomp_methods ()

template<typename T , typename TIter = decltype(std::begin(std::declval<T>())), typename = decltype(std::end(std::declval<T>()))>
constexpr auto	enumerate (T &&iterable)

std::ostream &	operator<< (std::ostream &os, const Field &fld)

void	gl_setwidth (int w)

char *	getline_int (const char *prompt)

void	gl_histadd (const char *buf)

template<typename T >
bool	verify_field_exists_in_entity_group (const std::string &field_name, const std::vector< T * > &entity_container)

template<class T >
RefHolder< T >	ByRef (T &t)

	__attribute__ ((unused)) typedef const ScopeGuardImplBase &ScopeGuard

template<typename F >
ScopeGuardImpl0< F >	MakeGuard (F fun)

template<typename F , typename P1 >
ScopeGuardImpl1< F, P1 >	MakeGuard (F fun, P1 p1)

template<typename F , typename P1 , typename P2 >
ScopeGuardImpl2< F, P1, P2 >	MakeGuard (F fun, P1 p1, P2 p2)

template<typename F , typename P1 , typename P2 , typename P3 >
ScopeGuardImpl3< F, P1, P2, P3 >	MakeGuard (F fun, P1 p1, P2 p2, P3 p3)

template<class Obj , typename MemFun >
ObjScopeGuardImpl0< Obj, MemFun >	MakeObjGuard (Obj &obj, MemFun memFun)

template<typename Ret , class Obj1 , class Obj2 >
ObjScopeGuardImpl0< Obj1, Ret(Obj2::*)()>	MakeGuard (Ret(Obj2::*memFun)(), Obj1 &obj)

template<typename Ret , class Obj1 , class Obj2 >
ObjScopeGuardImpl0< Obj1, Ret(Obj2::*)()>	MakeGuard (Ret(Obj2::memFun)(), Obj1 obj)

template<class Obj , typename MemFun , typename P1 >
ObjScopeGuardImpl1< Obj, MemFun, P1 >	MakeObjGuard (Obj &obj, MemFun memFun, P1 p1)

template<typename Ret , class Obj1 , class Obj2 , typename P1a , typename P1b >
ObjScopeGuardImpl1< Obj1, Ret(Obj2::*)(P1a), P1b >	MakeGuard (Ret(Obj2::*memFun)(P1a), Obj1 &obj, P1b p1)

template<typename Ret , class Obj1 , class Obj2 , typename P1a , typename P1b >
ObjScopeGuardImpl1< Obj1, Ret(Obj2::*)(P1a), P1b >	MakeGuard (Ret(Obj2::memFun)(P1a), Obj1 obj, P1b p1)

template<class Obj , typename MemFun , typename P1 , typename P2 >
ObjScopeGuardImpl2< Obj, MemFun, P1, P2 >	MakeObjGuard (Obj &obj, MemFun memFun, P1 p1, P2 p2)

template<typename Ret , class Obj1 , class Obj2 , typename P1a , typename P1b , typename P2a , typename P2b >
ObjScopeGuardImpl2< Obj1, Ret(Obj2::*)(P1a, P2a), P1b, P2b >	MakeGuard (Ret(Obj2::*memFun)(P1a, P2a), Obj1 &obj, P1b p1, P2b p2)

template<typename Ret , class Obj1 , class Obj2 , typename P1a , typename P1b , typename P2a , typename P2b >
ObjScopeGuardImpl2< Obj1, Ret(Obj2::*)(P1a, P2a), P1b, P2b >	MakeGuard (Ret(Obj2::memFun)(P1a, P2a), Obj1 obj, P1b p1, P2b p2)

template<class Iter , class Comp >
void	sort (Iter begin, Iter end, Comp compare)

template<class Iter >
void	sort (Iter begin, Iter end)

template<typename INT >
void	sort (std::vector< INT > &v)

std::ostream &	operator<< (std::ostream &os, const BoundaryCondition &bc)

SurfaceSplitType	int_to_surface_split (int split_int)
	Convert an integer code for the method used to split sidesets into homogeneous blocks.

std::ostream &	OUTPUT ()

std::ostream &	DebugOut ()

std::ostream &	WarnOut (bool output_prewarning=true)

const char *	Version ()

std::ostream &	operator<< (std::ostream &os, const ZoneConnectivity &zgc)

void	io_info_file_info (const Info::Interface &interFace)

void	io_info_change_set_info (Info::Interface &interFace)

void	io_info_set_db_properties (const Info::Interface &interFace, Ioss::DatabaseIO *dbi)

void	io_info_file_info (const Info::Interface &interFace, Ioss::Region &region)

IOSS_EXPORT std::vector< std::string >	tokenize (const std::string &str, const std::string &separators, bool allow_empty=false)

Variables
static constexpr Ordinal	InvalidOrdinal = std::numeric_limits<Ordinal>::max()

static constexpr Permutation	InvalidPermutation = std::numeric_limits<Permutation>::max()

constexpr int	entityTypeCount = 16

Detailed Description

The main namespace for the Ioss library.

Typedef Documentation

◆ AliasMap

using Ioss::AliasMap = std::map<std::string, std::string, std::less<>>

◆ AssemblyContainer

using Ioss::AssemblyContainer = std::vector<Ioss::Assembly *>

◆ BlobContainer

using Ioss::BlobContainer = std::vector<Ioss::Blob *>

◆ chain_t

template<typename INT >

using Ioss::chain_t = std::vector<chain_entry_t<INT>>

◆ ChangeSetFactoryMap

using Ioss::ChangeSetFactoryMap = std::map<std::string, ChangeSetFactory *, std::less<>>

◆ ChangeSetFactoryValuePair

using Ioss::ChangeSetFactoryValuePair = ChangeSetFactoryMap::value_type

◆ CommSetContainer

using Ioss::CommSetContainer = std::vector<CommSet *>

◆ CoordinateFrameContainer

typedef std::vector< CoordinateFrame > Ioss::CoordinateFrameContainer = std::vector<CoordinateFrame>

◆ EdgeBlockContainer

using Ioss::EdgeBlockContainer = std::vector<EdgeBlock *>

◆ EdgeSetContainer

using Ioss::EdgeSetContainer = std::vector<EdgeSet *>

◆ ElementBlockContainer

using Ioss::ElementBlockContainer = std::vector<ElementBlock *>

◆ ElementPermutationMap

using Ioss::ElementPermutationMap = std::map<std::string, ElementPermutation *, std::less<>>

◆ ElementSetContainer

using Ioss::ElementSetContainer = std::vector<ElementSet *>

◆ ElementShapeMap

using Ioss::ElementShapeMap = std::map<ElementShape, std::string>

◆ ElementTopologyMap

using Ioss::ElementTopologyMap = std::map<std::string, ElementTopology *, std::less<>>

◆ EntityContainer

typedef std::vector< const Ioss::GroupingEntity * > Ioss::EntityContainer = std::vector<const Ioss::GroupingEntity *>

◆ EPM_VP

using Ioss::EPM_VP = ElementPermutationMap::value_type

◆ ETM_VP

using Ioss::ETM_VP = ElementTopologyMap::value_type

◆ FaceBlockContainer

using Ioss::FaceBlockContainer = std::vector<FaceBlock *>

◆ FaceSetContainer

using Ioss::FaceSetContainer = std::vector<FaceSet *>

◆ FaceUnorderedSet

using Ioss::FaceUnorderedSet = tsl::robin_pg_set<Face, FaceHash, FaceEqual>

◆ FieldMapType

using Ioss::FieldMapType = tsl::robin_pg_map<std::string, Field>

◆ FieldValuePair

using Ioss::FieldValuePair = FieldMapType::value_type

◆ FileNameGenerator

using Ioss::FileNameGenerator

Initial value:

std::function<std::string(const std::string &baseFileName, unsigned step)>

◆ IJK_t

using Ioss::IJK_t = std::array<int, 3>

◆ Int64Vector

using Ioss::Int64Vector = std::vector<int64_t>

◆ IntVector

using Ioss::IntVector = std::vector<int>

◆ IOFactoryMap

using Ioss::IOFactoryMap = std::map<std::string, IOFactory *, std::less<>>

◆ IOFactoryValuePair

using Ioss::IOFactoryValuePair = IOFactoryMap::value_type

◆ MapContainer

using Ioss::MapContainer = std::vector<int64_t>

◆ NameList

typedef Ioss::NameList Ioss::NameList = Ioss::NameList

◆ NodeBlockContainer

using Ioss::NodeBlockContainer = std::vector<NodeBlock *>

◆ NodeSetContainer

using Ioss::NodeSetContainer = std::vector<NodeSet *>

◆ Ordinal

using Ioss::Ordinal = uint16_t

◆ Permutation

using Ioss::Permutation = uint32_t

◆ PropMapType

using Ioss::PropMapType = tsl::robin_pg_map<std::string, Property>

◆ ReverseMapContainer

using Ioss::ReverseMapContainer = std::unordered_map<int64_t, int64_t>

◆ SideBlockContainer

using Ioss::SideBlockContainer = std::vector<SideBlock *>

◆ SideSetContainer

using Ioss::SideSetContainer = std::vector<SideSet *>

◆ StateTimeContainer

using Ioss::StateTimeContainer = std::vector<double>

◆ StructuredBlockContainer

using Ioss::StructuredBlockContainer = std::vector<StructuredBlock *>

◆ TopoContainer

using Ioss::TopoContainer = std::vector<std::pair<const ElementTopology *, const ElementTopology *>>

◆ TransformFactoryMap

using Ioss::TransformFactoryMap = std::map<std::string, TransformFactory *, std::less<>>

◆ ValuePair

using Ioss::ValuePair = PropMapType::value_type

◆ VariableTypeMap

using Ioss::VariableTypeMap = std::map<std::string, VariableType *, std::less<>>

◆ VTM_ValuePair

using Ioss::VTM_ValuePair = VariableTypeMap::value_type

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Enumerator
lvl_warn
lvl_debug
lvl_error
lvl_fatal

◆ ChangeSetFormat

enum Ioss::ChangeSetFormat

Enumerator
CHANGE_SET_NONE
CHANGE_SET_INTERNAL_FILES
CHANGE_SET_LINEAR_MULTI_FILES
CHANGE_SET_CYCLIC_MULTI_FILES

◆ DatabaseUsage

enum Ioss::DatabaseUsage

Specifies how an Ioss::DatabaseIO object will be used.

Enumerator
WRITE_RESTART	The current state of the simulation, including model and field data will be written to this database.
READ_RESTART	A previous state of the simulation, including model and field data will be read from this database.
WRITE_RESULTS	Mesh-based results data, such as nodal displacements, will be written to this database.
READ_MODEL	Model data such as node coordinates, element connectivities will be read from this database.
WRITE_HISTORY	Global results data, such as total energy, will be written to this database.
WRITE_HEARTBEAT	Text-based results data for particular nodes, edges, faces, elements, or global variables at particular times will be written to this database.
QUERY_TIMESTEPS_ONLY	Special mode where the application is only going to query the number of timesteps and the timestep values on the database. All other region data will not exist.

◆ DataSize

enum Ioss::DataSize

The number of bytes used to store an integer type.

Enumerator
USE_INT32_API
USE_INT64_API

◆ DuplicateFieldBehavior

enum class Ioss::DuplicateFieldBehavior

strong

Enumerator
UNSET_
IGNORE_
WARNING_
ERROR_

◆ ElementShape

enum class Ioss::ElementShape : unsigned

strong

Enumerator
UNKNOWN
POINT
SPHERE
LINE
SPRING
TRI
QUAD
TET
PYRAMID
WEDGE
HEX
SUPER

◆ EntityType

enum Ioss::EntityType

The particular type of GroupingEntity.

Enumerator
NODEBLOCK
EDGEBLOCK
FACEBLOCK
ELEMENTBLOCK
NODESET
EDGESET
FACESET
ELEMENTSET
SIDESET
SURFACE
COMMSET
SIDEBLOCK
REGION
SUPERELEMENT
STRUCTUREDBLOCK
ASSEMBLY
BLOB
INVALID_TYPE

◆ FileControlOption

enum class Ioss::FileControlOption

strong

Enumerator
CONTROL_NONE
CONTROL_AUTO_MULTI_FILE
CONTROL_AUTO_GROUP_FILE

◆ IfDatabaseExistsBehavior

enum Ioss::IfDatabaseExistsBehavior

Enumerator
DB_OVERWRITE
DB_APPEND
DB_APPEND_GROUP
DB_MODIFY
DB_ABORT
DB_ADD_SUFFIX
DB_ADD_SUFFIX_OVERWRITE

◆ MeshType

enum class Ioss::MeshType

strong

The mesh type – structured, unstructured, hybrid (future), or unknown.

Enumerator
UNKNOWN
STRUCTURED
UNSTRUCTURED
HYBRID

◆ State

enum Ioss::State

Access states for a database.

All access states except STATE_INVALID, STATE_UNKNOWN, and STATE_READONLY are only for output databases.

Enumerator
STATE_INVALID	Error state if something goes wrong.
STATE_UNKNOWN	Typically used at the very beginning of the database's existence when the class has been created, but no reading or writing has occurred.
STATE_READONLY	An input database that is not in STATE_UNKNOWN is in this state, which means that it cannot be written to or changed.
STATE_CLOSED	The states are not nested, so each state must end with a transition to this state prior to entering the next state.
STATE_DEFINE_MODEL	Defining the metadata, which defines the topology of the model (nontransient, geometry and topology).
STATE_MODEL	Outputting the bulk data (mesh_model_coordinates, ids, connectivity) relating to the model portion.
STATE_DEFINE_TRANSIENT	Defining the metadata relating to the transient data. For example, the element or nodal fields.
STATE_TRANSIENT	Outputting the transient bulk data.
STATE_LAST_ENTRY

◆ SurfaceSplitType

enum Ioss::SurfaceSplitType

Method used to split sidesets into homogeneous blocks.

Enumerator
SPLIT_INVALID
SPLIT_BY_TOPOLOGIES
SPLIT_BY_ELEMENT_BLOCK
SPLIT_BY_DONT_SPLIT
SPLIT_LAST_ENTRY

◆ TopologyModified

enum Ioss::TopologyModified

The TopologyModified enumeration is used as an argument to the topology_modified() functions in io to specify the type of topology modification that has occurred. The calls to topology_modified() are cumulative between output steps, so a call with TOPOLOGY_REORDER followed by a call with TOPOLOGY_SHUFFLE will do the right thing. Typical examples of when these would be used are:

TOPOLOGY_SAME: No change, but easier to call function than not.
TOPOLOGY_REORDER: Element Death which reorders the Registrars
TOPOLOGY_SHUFFLE: Load Balancing
TOPOLOGY_HADAPT: H-Adaptivity
TOPOLOGY_GHOST: Ghost nodes/edges/faces/elements created/destroyed
TOPOLOGY_GEOMETRY: Model data is modified, overlap removal.
TOPOLOGY_CREATEDELETE: Surface erosion, particle creation
TOPOLOGY_UNKNOWN: Something else, catchall option.

Enumerator
TOPOLOGY_SAME	No change, also used for initialization.
TOPOLOGY_REORDER	Data structures reordered on processor, no change between procs.
TOPOLOGY_SHUFFLE	Globally the same, data moved among processors.
TOPOLOGY_HADAPT	Elements split/combined; not moved cross-proc.
TOPOLOGY_GHOST	Ghost entities created/destroyed.
TOPOLOGY_GEOMETRY	Geometry (mesh coordinates) modified. Restart needs to know this.
TOPOLOGY_CREATEFACE	Face/Edge are created/deleted.
TOPOLOGY_CREATEELEM	Elements are created/deleted.
TOPOLOGY_CREATENODE	Nodes are created/deleted.
TOPOLOGY_CREATEASSEMBLY	Assemblies are created/deleted.
TOPOLOGY_UNKNOWN	Unknown change, recreate from scratch.
TOPOLOGY_AUXILIARY	An AUXILIARY relation was created/modified.
TOPOLOGY_CONSTRAINT	Contact constraints.

Function Documentation

◆ attribute()

Ioss::__attribute__ ( (unused) ) const &

◆ ByRef()

template<class T >

RefHolder< T > Ioss::ByRef ( T & t )

inline

◆ construct_cyclic_filename_generator()

FileNameGenerator Ioss::construct_cyclic_filename_generator ( unsigned cyclicCount )

◆ construct_linear_filename_generator()

FileNameGenerator Ioss::construct_linear_filename_generator ( )

◆ copy_database()

void Ioss::copy_database	(	Ioss::Region &	region,
		Ioss::Region &	output_region,
		Ioss::MeshCopyOptions &	options )

Copy the mesh in region to output_region. Behavior can be controlled via options in options

◆ DebugOut()

std::ostream & Ioss::DebugOut ( )

inline

◆ enumerate()

template<typename T , typename TIter = decltype(std::begin(std::declval<T>())), typename = decltype(std::end(std::declval<T>()))>

auto Ioss::enumerate ( T && iterable )

constexpr

◆ expand_topology_files() [1/2]

std::string Ioss::expand_topology_files	(	FileNameGenerator	generator,
		const Ioss::ParallelUtils &	util,
		const std::string &	basename,
		const Ioss::PropertyManager &	properties,
		Ioss::DatabaseUsage	usage,
		int	step )

◆ expand_topology_files() [2/2]

std::pair< std::string, Ioss::DatabaseIO * > Ioss::expand_topology_files	(	FileNameGenerator	generator,
		const Ioss::ParallelUtils &	util,
		const std::string &	basename,
		const std::string &	db_type,
		const Ioss::PropertyManager &	properties,
		Ioss::DatabaseUsage	usage,
		int	step )

◆ generate_element_chains() [1/4]

template IOSS_EXPORT Ioss::chain_t< int > Ioss::generate_element_chains	(	Ioss::Region &	region,
		const std::string &	,
		int	,
		int	)

◆ generate_element_chains() [2/4]

template IOSS_EXPORT Ioss::chain_t< int64_t > Ioss::generate_element_chains	(	Ioss::Region &	region,
		const std::string &	,
		int	,
		int64_t	)

◆ generate_element_chains() [3/4]

template<typename INT >

Ioss::chain_t< INT > Ioss::generate_element_chains	(	Ioss::Region &	region,
		const std::string &	surface_list,
		int	debug_level,
		INT	)

◆ generate_element_chains() [4/4]

template<typename INT >

IOSS_NODISCARD chain_t< INT > Ioss::generate_element_chains	(	Ioss::Region &	region,
		const std::string &	surface_list,
		int	debug_level,
		INT	)

◆ getline_int()

IOSS_EXPORT char * Ioss::getline_int ( const char * prompt )

◆ gl_histadd()

IOSS_EXPORT void Ioss::gl_histadd ( const char * buf )

◆ gl_setwidth()

IOSS_EXPORT void Ioss::gl_setwidth ( int w )

◆ int_to_surface_split()

SurfaceSplitType Ioss::int_to_surface_split ( int split_int )

inline

Convert an integer code for the method used to split sidesets into homogeneous blocks.

Parameters

[in] split_int The code.

Returns: The corresponding SurfaceSplitType.

◆ io_info_change_set_info()

IO_INFO_LIB_EXPORT void Ioss::io_info_change_set_info ( Info::Interface & interFace )

◆ io_info_file_info() [1/2]

IO_INFO_LIB_EXPORT void Ioss::io_info_file_info ( const Info::Interface & interFace )

◆ io_info_file_info() [2/2]

IO_INFO_LIB_EXPORT void Ioss::io_info_file_info	(	const Info::Interface &	interFace,
		Ioss::Region &	region )

◆ io_info_set_db_properties()

IO_INFO_LIB_EXPORT void Ioss::io_info_set_db_properties	(	const Info::Interface &	interFace,
		Ioss::DatabaseIO *	dbi )

◆ is_input_event()

bool Ioss::is_input_event ( Ioss::DatabaseUsage db_usage )

inline

◆ MakeGuard() [1/10]

template<typename F >

ScopeGuardImpl0< F > Ioss::MakeGuard ( F fun )

inline

◆ MakeGuard() [2/10]

template<typename F , typename P1 >

ScopeGuardImpl1< F, P1 > Ioss::MakeGuard	(	F	fun,
		P1	p1 )

inline

◆ MakeGuard() [3/10]

template<typename F , typename P1 , typename P2 >

ScopeGuardImpl2< F, P1, P2 > Ioss::MakeGuard	(	F	fun,
		P1	p1,
		P2	p2 )

inline

◆ MakeGuard() [4/10]

template<typename F , typename P1 , typename P2 , typename P3 >

ScopeGuardImpl3< F, P1, P2, P3 > Ioss::MakeGuard	(	F	fun,
		P1	p1,
		P2	p2,
		P3	p3 )

inline

◆ MakeGuard() [5/10]

template<typename Ret , class Obj1 , class Obj2 >

ObjScopeGuardImpl0< Obj1, Ret(Obj2::*)()> Ioss::MakeGuard	(	Ret(Obj2::*	memFun )(),
		Obj1 &	obj )

inline

◆ MakeGuard() [6/10]

template<typename Ret , class Obj1 , class Obj2 >

ObjScopeGuardImpl0< Obj1, Ret(Obj2::*)()> Ioss::MakeGuard	(	Ret(Obj2::*	memFun )(),
		Obj1 *	obj )

inline

◆ MakeGuard() [7/10]

template<typename Ret , class Obj1 , class Obj2 , typename P1a , typename P1b >

ObjScopeGuardImpl1< Obj1, Ret(Obj2::*)(P1a), P1b > Ioss::MakeGuard	(	Ret(Obj2::*	memFun )(P1a),
		Obj1 &	obj,
		P1b	p1 )

inline

◆ MakeGuard() [8/10]

template<typename Ret , class Obj1 , class Obj2 , typename P1a , typename P1b >

ObjScopeGuardImpl1< Obj1, Ret(Obj2::*)(P1a), P1b > Ioss::MakeGuard	(	Ret(Obj2::*	memFun )(P1a),
		Obj1 *	obj,
		P1b	p1 )

inline

◆ MakeGuard() [9/10]

template<typename Ret , class Obj1 , class Obj2 , typename P1a , typename P1b , typename P2a , typename P2b >

ObjScopeGuardImpl2< Obj1, Ret(Obj2::*)(P1a, P2a), P1b, P2b > Ioss::MakeGuard	(	Ret(Obj2::*	memFun )(P1a, P2a),
		Obj1 &	obj,
		P1b	p1,
		P2b	p2 )

inline

◆ MakeGuard() [10/10]

template<typename Ret , class Obj1 , class Obj2 , typename P1a , typename P1b , typename P2a , typename P2b >

ObjScopeGuardImpl2< Obj1, Ret(Obj2::*)(P1a, P2a), P1b, P2b > Ioss::MakeGuard	(	Ret(Obj2::*	memFun )(P1a, P2a),
		Obj1 *	obj,
		P1b	p1,
		P2b	p2 )

inline

◆ MakeObjGuard() [1/3]

template<class Obj , typename MemFun >

ObjScopeGuardImpl0< Obj, MemFun > Ioss::MakeObjGuard	(	Obj &	obj,
		MemFun	memFun )

inline

◆ MakeObjGuard() [2/3]

template<class Obj , typename MemFun , typename P1 >

ObjScopeGuardImpl1< Obj, MemFun, P1 > Ioss::MakeObjGuard	(	Obj &	obj,
		MemFun	memFun,
		P1	p1 )

inline

◆ MakeObjGuard() [3/3]

template<class Obj , typename MemFun , typename P1 , typename P2 >

ObjScopeGuardImpl2< Obj, MemFun, P1, P2 > Ioss::MakeObjGuard	(	Obj &	obj,
		MemFun	memFun,
		P1	p1,
		P2	p2 )

inline

◆ operator<<() [1/3]

IOSS_EXPORT std::ostream & Ioss::operator<<	(	std::ostream &	os,
		const BoundaryCondition &	bc )

◆ operator<<() [2/3]

IOSS_EXPORT std::ostream & Ioss::operator<<	(	std::ostream &	os,
		const Field &	fld )

◆ operator<<() [3/3]

IOSS_EXPORT std::ostream & Ioss::operator<<	(	std::ostream &	os,
		const ZoneConnectivity &	zgc )

◆ OUTPUT()

std::ostream & Ioss::OUTPUT ( )

inline

◆ sort() [1/3]

template<class Iter >

void Ioss::sort	(	Iter	begin,
		Iter	end )

inline

◆ sort() [2/3]

template<class Iter , class Comp >

void Ioss::sort	(	Iter	begin,
		Iter	end,
		Comp	compare )

inline

◆ sort() [3/3]

template<typename INT >

void Ioss::sort ( std::vector< INT > & v )

◆ tokenize()

TokenList Ioss::tokenize	(	const std::string &	str,
		const std::string &	separators,
		bool	allow_empty = false )

Take the 'str' argument and split it using the list of characters in separators as separators. Use tokens to return the result.

◆ transfer_assemblies()

void Ioss::transfer_assemblies	(	Ioss::Region &	region,
		Ioss::Region &	output_region,
		const Ioss::MeshCopyOptions &	options,
		int	rank )

◆ transfer_blobs()

void Ioss::transfer_blobs	(	Ioss::Region &	region,
		Ioss::Region &	output_region,
		const Ioss::MeshCopyOptions &	options,
		int	rank )

◆ transfer_coordinate_frames()

void Ioss::transfer_coordinate_frames	(	Ioss::Region &	region,
		Ioss::Region &	output_region )

◆ valid_decomp_methods()

IOSS_EXPORT const Ioss::NameList & Ioss::valid_decomp_methods ( )

◆ verify_field_exists_in_entity_group()

template<typename T >

bool Ioss::verify_field_exists_in_entity_group	(	const std::string &	field_name,
		const std::vector< T * > &	entity_container )

◆ Version()

const char * Ioss::Version ( )

inline

◆ WarnOut()

std::ostream & Ioss::WarnOut ( bool output_prewarning = true )

inline

Variable Documentation

◆ entityTypeCount

int Ioss::entityTypeCount = 16

constexpr

◆ InvalidOrdinal

Ordinal Ioss::InvalidOrdinal = std::numeric_limits<Ordinal>::max()

staticconstexpr

◆ InvalidPermutation

Permutation Ioss::InvalidPermutation = std::numeric_limits<Permutation>::max()

staticconstexpr

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ AliasMap

◆ AssemblyContainer

◆ BlobContainer

◆ chain_t

◆ ChangeSetFactoryMap

◆ ChangeSetFactoryValuePair

◆ CommSetContainer

◆ CoordinateFrameContainer

◆ EdgeBlockContainer

◆ EdgeSetContainer

◆ ElementBlockContainer

◆ ElementPermutationMap

◆ ElementSetContainer

◆ ElementShapeMap

◆ ElementTopologyMap

◆ EntityContainer

◆ EPM_VP

◆ ETM_VP

◆ FaceBlockContainer

◆ FaceSetContainer

◆ FaceUnorderedSet

◆ FieldMapType

◆ FieldValuePair

◆ FileNameGenerator

◆ IJK_t

◆ Int64Vector

◆ IntVector

◆ IOFactoryMap

◆ IOFactoryValuePair

◆ MapContainer

◆ NameList

◆ NodeBlockContainer

◆ NodeSetContainer

◆ Ordinal

◆ Permutation

◆ PropMapType

◆ ReverseMapContainer

◆ SideBlockContainer

◆ SideSetContainer

◆ StateTimeContainer

◆ StructuredBlockContainer

◆ TopoContainer

◆ TransformFactoryMap

◆ ValuePair

◆ VariableTypeMap

◆ VTM_ValuePair

Enumeration Type Documentation

◆ anonymous enum

◆ ChangeSetFormat

◆ DatabaseUsage

◆ DataSize

◆ DuplicateFieldBehavior

◆ ElementShape

◆ EntityType

◆ FileControlOption

◆ IfDatabaseExistsBehavior

◆ MeshType

◆ State

◆ SurfaceSplitType

◆ TopologyModified

Function Documentation

◆ __attribute__()

◆ ByRef()

◆ construct_cyclic_filename_generator()

◆ construct_linear_filename_generator()

◆ copy_database()

◆ DebugOut()

◆ enumerate()

◆ expand_topology_files() [1/2]

◆ expand_topology_files() [2/2]

◆ generate_element_chains() [1/4]

◆ generate_element_chains() [2/4]

◆ attribute()