Ioss::Field Class Reference

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

#include <Ioss_Field.h>

Collaboration diagram for Ioss::Field:

Public Types
enum	BasicType {   INVALID = -1 , REAL = 1 , DOUBLE = 1 , INTEGER = 4 ,   INT32 = 4 , INT64 = 8 , COMPLEX = 9 , STRING = 10 ,   CHARACTER = 11 }
	The basic data type held in the field. More...
enum class	InOut { INPUT , OUTPUT }
enum	RoleType {   INTERNAL , MESH , ATTRIBUTE , MAP ,   COMMUNICATION , MESH_REDUCTION , INFORMATION = MESH_REDUCTION , REDUCTION ,   TRANSIENT }

Public Member Functions
	Field ()
	Create an empty field.
	Field (std::string name, BasicType type, const std::string &storage, RoleType role, size_t value_count=0, size_t index=0)
	Create a field.
	Field (std::string name, BasicType type, const std::string &storage, int copies, RoleType role, size_t value_count=0, size_t index=0)
	Create a field.
	Field (std::string name, BasicType type, const std::string &storage, const std::string &secondary, RoleType role, size_t value_count=0, size_t index=0)
	Create a field.
	Field (std::string name, BasicType type, const VariableType *storage, RoleType role, size_t value_count=0, size_t index=0)
	Create a field.
IOSS_NODISCARD bool	operator< (const Field &other) const
IOSS_NODISCARD bool	operator== (const Ioss::Field &rhs) const
IOSS_NODISCARD bool	operator!= (const Ioss::Field &rhs) const
IOSS_NODISCARD bool	equal (const Ioss::Field &rhs) const
IOSS_NODISCARD bool	is_valid () const
IOSS_NODISCARD bool	is_invalid () const
IOSS_NODISCARD const std::string &	get_name () const
IOSS_NODISCARD std::string &	get_name ()
IOSS_NODISCARD std::string	get_component_name (int component_index, InOut in_out, char suffix=1) const
	Get name of the 'component_indexth` component (1-based)
IOSS_NODISCARD int	get_component_count (InOut in_out) const
Field &	set_suffix_separator (char suffix_separator1, char suffix_separator2=2)
IOSS_NODISCARD char	get_suffix_separator (int index=0) const
Field &	set_suffices_uppercase (bool true_false)
IOSS_NODISCARD bool	get_suffices_uppercase () const
const Field &	set_zero_copy_enabled (bool true_false=true) const
IOSS_NODISCARD bool	zero_copy_enabled () const
IOSS_NODISCARD BasicType	get_type () const
	Get the basic data type of the data held in the field.
IOSS_NODISCARD const VariableType *	raw_storage () const
IOSS_NODISCARD const VariableType *	transformed_storage () const
IOSS_NODISCARD size_t	raw_count () const
	Number of items in field.
IOSS_NODISCARD size_t	transformed_count () const
	Number of items in field after transforms have been applied.
IOSS_NODISCARD size_t	get_size () const
	data size (in bytes) required to hold entire field
IOSS_NODISCARD size_t	get_basic_size () const
	data size (in bytes) of the basic type
IOSS_NODISCARD RoleType	get_role () const
	Get the role (MESH, ATTRIBUTE, TRANSIENT, REDUCTION, etc.) of the data in the field.
IOSS_NODISCARD size_t	get_index () const
const Field &	set_index (size_t index) const
Field &	set_index (size_t index)
void	reset_count (size_t new_count)
	new number of items in field
void	reset_type (BasicType new_type)
	new type of items in field.
size_t	verify (size_t data_size) const
void	check_type (BasicType the_type) const
IOSS_NODISCARD bool	is_type (BasicType the_type) const
IOSS_NODISCARD std::string	type_string () const
IOSS_NODISCARD std::string	role_string () const
bool	add_transform (Transform *my_transform)
bool	transform (void *data)
IOSS_NODISCARD bool	has_transform () const

Static Public Member Functions
static IOSS_NODISCARD Ioss::Field::BasicType	get_field_type (char)
static IOSS_NODISCARD Ioss::Field::BasicType	get_field_type (double)
static IOSS_NODISCARD Ioss::Field::BasicType	get_field_type (int)
static IOSS_NODISCARD Ioss::Field::BasicType	get_field_type (unsigned int)
static IOSS_NODISCARD Ioss::Field::BasicType	get_field_type (int64_t)
static IOSS_NODISCARD Ioss::Field::BasicType	get_field_type (uint64_t)
static IOSS_NODISCARD Ioss::Field::BasicType	get_field_type (Complex)
static IOSS_NODISCARD Ioss::Field::BasicType	get_field_type (const std::string &)
static IOSS_NODISCARD std::string	type_string (BasicType type)
static IOSS_NODISCARD std::string	role_string (RoleType role)

Private Member Functions
bool	equal_ (const Ioss::Field &rhs, bool quiet) const

Private Attributes
std::string	name_ {}
size_t	rawCount_ {}
	Count of items in field before transformation.
size_t	transCount_ {}
	Count of items in field after transformed.
size_t	size_ {}
	maximum data size (in bytes) required to hold entire field
size_t	index_ {}
	Optional flag that can be used by a client to indicate an ordering.
BasicType	type_ {INVALID}
	The basic type of the field (Integer, Real, String)
RoleType	role_ {INTERNAL}
	The role of the field.
const VariableType *	rawStorage_ {nullptr}
	Storage type of raw field.
const VariableType *	transStorage_ {nullptr}
	Storage type after transformation.
std::vector< std::shared_ptr< Transform > >	transforms_ {}
char	suffixSeparator1_ {1}
	Value = 1 means unset; use database default.
char	suffixSeparator2_ {1}
	Value = 1 means unset; use database default.
bool	sufficesUppercase_ {false}
	True if the suffices are uppercase on database...
bool	zeroCopyable_ {false}
	True if the field is zero-copyable.

Detailed Description

Holds metadata for bulk data associated with a GroupingEntity.

Member Enumeration Documentation

BasicType

enum Ioss::Field::BasicType

The basic data type held in the field.

Enumerator
INVALID
REAL
DOUBLE
INTEGER
INT32
INT64
COMPLEX
STRING
CHARACTER

InOut

enum class Ioss::Field::InOut

strong

Enumerator
INPUT
OUTPUT

RoleType

enum Ioss::Field::RoleType

Enumerator
INTERNAL
MESH	A field which is used to define the basic geometry or topology of the model and is not normally transient in nature. Examples would be element connectivity or nodal coordinates.
ATTRIBUTE	A field which is used to define an attribute on an EntityBlock derived class. Examples would be thickness of the elements in a shell element block or the radius of particles in a particle element block.
MAP	A list of integers specifying some ordering or mapping of the entties.
COMMUNICATION	Related to parallel communication.
MESH_REDUCTION	A field which summarizes some non-transient data about an entity ( See also REDUCTION). This could be an offset applied to an element block, or the units system of a model or the name of the solid model which this entity is modelling...
INFORMATION	Same as MESH_REDUCTION
REDUCTION	A field which typically summarizes some transient data about an entity. The size of this field is typically not proportional to the number of entities in a GroupingEntity. An example would be average displacement over a group of nodes or the kinetic energy of a model. This data is also transient.
TRANSIENT	A field which is typically calculated at multiple steps or times in an analysis. These are typically "results" data. Examples would be nodal displacement or element stress.

Constructor & Destructor Documentation

Field() [1/5]

Ioss::Field::Field

(

)

Create an empty field.

Field() [2/5]

Ioss::Field::Field	(	std::string	name,
		BasicType	type,
		const std::string &	storage,
		RoleType	role,
		size_t	value_count = 0,
		size_t	index = 0 )

Create a field.

Parameters

[in]	name	The name of the field
[in]	type	The basic data type of data held in the field.
[in]	storage	The storage class of the data (ConstructedVariableType, CompositeVariableType, etc)
[in]	role	The category of information held in the field (MESH, ATTRIBUTE, TRANSIENT, REDUCTION, etc)
[in]	value_count	The number of items in the field.
[in]	index

Field() [3/5]

Ioss::Field::Field	(	std::string	name,
		BasicType	type,
		const std::string &	storage,
		int	copies,
		RoleType	role,
		size_t	value_count = 0,
		size_t	index = 0 )

Create a field.

Parameters

[in]	name	The name of the field
[in]	type	The basic data type of data held in the field.
[in]	storage	The storage class of the data (ConstructedVariableType, CompositeVariableType, etc)
[in]	copies	The number of variables to be combined in a CompositeVariableType field.
[in]	role	The category of information held in the field (MESH, ATTRIBUTE, TRANSIENT, REDUCTION, etc)
[in]	value_count	The number of items in the field.
[in]	index

Field() [4/5]

Ioss::Field::Field	(	std::string	name,
		BasicType	type,
		const std::string &	storage,
		const std::string &	secondary,
		RoleType	role,
		size_t	value_count = 0,
		size_t	index = 0 )

Create a field.

Parameters

[in]	name	The name of the field
[in]	type	The basic data type of data held in the field.
[in]	storage	The storage class of the data (ConstructedVariableType, CompositeVariableType, etc)
[in]	role	The category of information held in the field (MESH, ATTRIBUTE, TRANSIENT, REDUCTION, etc)
[in]	value_count	The number of items in the field.
[in]	index

Field() [5/5]

Ioss::Field::Field	(	std::string	name,
		BasicType	type,
		const VariableType *	storage,
		RoleType	role,
		size_t	value_count = 0,
		size_t	index = 0 )

Create a field.

Parameters

[in]	name	The name of the field
[in]	type	The basic data type of data held in the field.
[in]	storage	The storage class of the data (ConstructedVariableType, CompositeVariableType, etc)
[in]	secondary	The secondary storage class of the data (typically "basis") [For a ComposedVariableType field]
[in]	role	The category of information held in the field (MESH, ATTRIBUTE, TRANSIENT, REDUCTION, etc)
[in]	value_count	The number of items in the field.
[in]	index

Member Function Documentation

add_transform()

bool Ioss::Field::add_transform

(

Transform *

my_transform

)

check_type()

void Ioss::Field::check_type

(

BasicType

the_type

)

const

Verify that the type 'the_type' matches the field's type. throws exception if the types don't match.

equal()

bool Ioss::Field::equal

(

const Ioss::Field &

rhs

)

const

equal_()

bool Ioss::Field::equal_ ( const Ioss::Field & rhs, bool quiet ) const

private

get_basic_size()

size_t Ioss::Field::get_basic_size

(

)

const

data size (in bytes) of the basic type

get_component_count()

int Ioss::Field::get_component_count

(

InOut

in_out

)

const

get_component_name()

std::string Ioss::Field::get_component_name	(	int	component_index,
		InOut	in_out,
		char	suffix = 1 ) const

Get name of the 'component_indexth` component (1-based)

Parameters

[in]	component_index	1-based index of the component to be named
[in]	in_out	Is the field being read or written
[in]	suffix	optional suffix separator to be used if the separator on the field is set to '1' which means 'unset'

Returns

name of the specified component

get_field_type() [1/8]

IOSS_NODISCARD Ioss::Field::BasicType Ioss::Field::get_field_type ( char )

inlinestatic

get_field_type() [2/8]

IOSS_NODISCARD Ioss::Field::BasicType Ioss::Field::get_field_type ( Complex )

inlinestatic

get_field_type() [3/8]

IOSS_NODISCARD Ioss::Field::BasicType Ioss::Field::get_field_type ( const std::string & )

inlinestatic

get_field_type() [4/8]

IOSS_NODISCARD Ioss::Field::BasicType Ioss::Field::get_field_type ( double )

inlinestatic

get_field_type() [5/8]

IOSS_NODISCARD Ioss::Field::BasicType Ioss::Field::get_field_type ( int )

inlinestatic

get_field_type() [6/8]

IOSS_NODISCARD Ioss::Field::BasicType Ioss::Field::get_field_type ( int64_t )

inlinestatic

get_field_type() [7/8]

IOSS_NODISCARD Ioss::Field::BasicType Ioss::Field::get_field_type ( uint64_t )

inlinestatic

get_field_type() [8/8]

IOSS_NODISCARD Ioss::Field::BasicType Ioss::Field::get_field_type ( unsigned int )

inlinestatic

get_index()

IOSS_NODISCARD size_t Ioss::Field::get_index ( ) const

inline

get_name() [1/2]

IOSS_NODISCARD std::string & Ioss::Field::get_name ( )

inline

get_name() [2/2]

IOSS_NODISCARD const std::string & Ioss::Field::get_name ( ) const

inline

get_role()

IOSS_NODISCARD RoleType Ioss::Field::get_role ( ) const

inline

Get the role (MESH, ATTRIBUTE, TRANSIENT, REDUCTION, etc.) of the data in the field.

Returns

The RoleType of the data in the field.

get_size()

size_t Ioss::Field::get_size

(

)

const

data size (in bytes) required to hold entire field

get_suffices_uppercase()

IOSS_NODISCARD bool Ioss::Field::get_suffices_uppercase ( ) const

inline

get_suffix_separator()

IOSS_NODISCARD char Ioss::Field::get_suffix_separator ( int index = 0 ) const

inline

get_type()

IOSS_NODISCARD BasicType Ioss::Field::get_type ( ) const

inline

Get the basic data type of the data held in the field.

Returns

the basic data type of the data held in the field.

has_transform()

IOSS_NODISCARD bool Ioss::Field::has_transform ( ) const

inline

is_invalid()

IOSS_NODISCARD bool Ioss::Field::is_invalid ( ) const

inline

is_type()

IOSS_NODISCARD bool Ioss::Field::is_type ( BasicType the_type ) const

inline

is_valid()

IOSS_NODISCARD bool Ioss::Field::is_valid ( ) const

inline

operator!=()

bool Ioss::Field::operator!=

(

const Ioss::Field &

rhs

)

const

operator<()

IOSS_NODISCARD bool Ioss::Field::operator<

(

const Field &

other

)

const

operator==()

bool Ioss::Field::operator==

(

const Ioss::Field &

rhs

)

const

raw_count()

IOSS_NODISCARD size_t Ioss::Field::raw_count ( ) const

inline

Number of items in field.

raw_storage()

IOSS_NODISCARD const VariableType * Ioss::Field::raw_storage ( ) const

inline

reset_count()

void Ioss::Field::reset_count

(

size_t

new_count

)

new number of items in field

reset_type()

void Ioss::Field::reset_type

(

BasicType

new_type

)

new type of items in field.

role_string() [1/2]

std::string Ioss::Field::role_string

(

)

const

role_string() [2/2]

std::string Ioss::Field::role_string ( RoleType role )

static

set_index() [1/2]

Field & Ioss::Field::set_index ( size_t index )

inline

set_index() [2/2]

const Field & Ioss::Field::set_index ( size_t index ) const

inline

set_suffices_uppercase()

Field & Ioss::Field::set_suffices_uppercase ( bool true_false )

inline

set_suffix_separator()

Field & Ioss::Field::set_suffix_separator ( char suffix_separator1, char suffix_separator2 = 2 )

inline

set_zero_copy_enabled()

const Ioss::Field & Ioss::Field::set_zero_copy_enabled

(

bool

true_false = true

)

const

transform()

bool Ioss::Field::transform

(

void *

data

)

transformed_count()

IOSS_NODISCARD size_t Ioss::Field::transformed_count ( ) const

inline

Number of items in field after transforms have been applied.

transformed_storage()

IOSS_NODISCARD const VariableType * Ioss::Field::transformed_storage ( ) const

inline

type_string() [1/2]

std::string Ioss::Field::type_string

(

)

const

type_string() [2/2]

std::string Ioss::Field::type_string ( BasicType type )

static

verify()

size_t Ioss::Field::verify

(

size_t

data_size

)

const

Verify that data_size is valid. Return value is the maximum number of entities to get ('RawCount') Throws runtime error if data_size too small.

zero_copy_enabled()

IOSS_NODISCARD bool Ioss::Field::zero_copy_enabled ( ) const

inline

Member Data Documentation

index_

size_t Ioss::Field::index_ {}

mutableprivate

Optional flag that can be used by a client to indicate an ordering.

name_

std::string Ioss::Field::name_ {}

private

rawCount_

size_t Ioss::Field::rawCount_ {}

private

Count of items in field before transformation.

rawStorage_

const VariableType* Ioss::Field::rawStorage_ {nullptr}

private

Storage type of raw field.

role_

RoleType Ioss::Field::role_ {INTERNAL}

private

The role of the field.

size_

size_t Ioss::Field::size_ {}

private

maximum data size (in bytes) required to hold entire field

sufficesUppercase_

bool Ioss::Field::sufficesUppercase_ {false}

private

True if the suffices are uppercase on database...

suffixSeparator1_

char Ioss::Field::suffixSeparator1_ {1}

private

Value = 1 means unset; use database default.

suffixSeparator2_

char Ioss::Field::suffixSeparator2_ {1}

private

Value = 1 means unset; use database default.

transCount_

size_t Ioss::Field::transCount_ {}

private

Count of items in field after transformed.

transforms_

std::vector<std::shared_ptr<Transform> > Ioss::Field::transforms_ {}

private

transStorage_

const VariableType* Ioss::Field::transStorage_ {nullptr}

private

Storage type after transformation.

type_

BasicType Ioss::Field::type_ {INVALID}

private

The basic type of the field (Integer, Real, String)

zeroCopyable_

bool Ioss::Field::zeroCopyable_ {false}

mutableprivate

True if the field is zero-copyable.

---

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

• src/Ioss_Field.h
• src/Ioss_Field.C