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

#include <Ioss_EntityBlock.h>

Inheritance diagram for Ioss::EntityBlock:

[legend]

Collaboration diagram for Ioss::EntityBlock:

[legend]

Public Member Functions
EntityBlock &	operator= (const EntityBlock &)=delete

IOSS_NODISCARD Property	get_implicit_property (const std::string &my_name) const override=0
	Calculate and get an implicit property.

IOSS_NODISCARD const ElementTopology *	topology () const
	Get the topology of the entities in the block.

IOSS_NODISCARD bool	contains (size_t local_id) const
	Determine whether the block contains the entity with a given id.

void	set_offset (size_t offset)
	Set the 'offset' for the block.

IOSS_NODISCARD size_t	get_offset () const
	Get the 'offset' for the block.

IOSS_NODISCARD bool	operator== (const Ioss::EntityBlock &rhs) const

IOSS_NODISCARD bool	operator!= (const Ioss::EntityBlock &rhs) const

IOSS_NODISCARD bool	equal (const Ioss::EntityBlock &rhs) const

Public Member Functions inherited from Ioss::GroupingEntity
	GroupingEntity ()=default

	GroupingEntity (DatabaseIO *io_database, const std::string &my_name, int64_t entity_count)
	Base class constructor adds "name" and "entity_count" properties to the entity.

	GroupingEntity (const GroupingEntity &other)

GroupingEntity &	operator= (const GroupingEntity &rhs)=delete

virtual	~GroupingEntity ()

IOSS_NODISCARD State	get_state () const
	Get the current Ioss::State of the entity.

IOSS_NODISCARD DatabaseIO *	get_database () const

void	set_database (DatabaseIO *io_database)

void	reset_database (DatabaseIO *io_database)

virtual void	delete_database ()

virtual IOSS_NODISCARD const GroupingEntity *	contained_in () const

IOSS_NODISCARD const std::string &	name () const
	Get name of entity.

void	set_name (const std::string &new_name)
	Set the name of the entity.

IOSS_NODISCARD std::string	generic_name () const
	Get a generated name based on the type of the entity and the id.

IOSS_NODISCARD bool	is_alias (const std::string &my_name) const

virtual void	block_membership (std::vector< std::string > &)
	Get list of blocks that the entities in this GroupingEntity "touch".

IOSS_NODISCARD std::string	get_filename () const
	Get the file name associated with the database containing this entity.

virtual IOSS_NODISCARD std::string	type_string () const =0
	Get the name of the particular type of entity.

virtual IOSS_NODISCARD std::string	short_type_string () const =0
	Get a short name of the particular type of entity.

virtual IOSS_NODISCARD std::string	contains_string () const =0
	What does this entity contain.

virtual IOSS_NODISCARD EntityType	type () const =0
	Get the EntityType, which indicates the particular type of GroupingEntity this is.

void	property_add (const Property &new_prop)
	Add a property to the entity's property manager.

void	property_erase (const std::string &property_name)
	Remove a property from the entity's property manager.

IOSS_NODISCARD bool	property_exists (const std::string &property_name) const
	Checks if a property exists in the entity's property manager.

IOSS_NODISCARD Property	get_property (const std::string &property_name) const
	Get the Property from the property manager associated with the entity.

IOSS_NODISCARD int64_t	get_optional_property (const std::string &property, int64_t optional_value) const

IOSS_NODISCARD std::string	get_optional_property (const std::string &property_name, const std::string &optional_value) const

IOSS_NODISCARD NameList	property_describe () const
	Get the names of all properties in the property manager for this entity.

int	property_describe (NameList *names) const
	Get the names of all properties in the property manager for this entity.

IOSS_NODISCARD NameList	property_describe (Ioss::Property::Origin origin) const

int	property_describe (Ioss::Property::Origin origin, NameList *names) const

IOSS_NODISCARD size_t	property_count () const
	Get the number of properties defined in the property manager for this entity.

void	property_update (const std::string &property, int64_t value) const

void	property_update (const std::string &property, const std::string &value) const

void	field_add (Field new_field)
	Add a field to the entity's field manager.

void	field_erase (const std::string &field_name)
	Remove a field from the entity's field manager.

void	field_erase (Field::RoleType role)
	Remove all fields of type `role` from the entity's field manager.

IOSS_NODISCARD bool	field_exists (const std::string &field_name) const
	Checks if a field with a given name exists in the entity's field manager.

IOSS_NODISCARD Field	get_field (const std::string &field_name) const
	Get a field from the entity's field manager.

IOSS_NODISCARD const Field &	get_fieldref (const std::string &field_name) const
	Get a reference to a field from the entity's field manager.

int	field_describe (NameList *names) const
	Get the names of all fields in the entity's field manager.

IOSS_NODISCARD NameList	field_describe () const
	Get the names of all fields in the entity's field manager.

int	field_describe (Field::RoleType role, NameList *names) const
	Get the names of all fields of a specified RoleType in the entity's field manager.

IOSS_NODISCARD NameList	field_describe (Field::RoleType role) const
	Get the names of all fields of a specified RoleType in the entity's field manager.

IOSS_NODISCARD size_t	field_count () const
	Get the number of fields in the entity's field manager.

IOSS_NODISCARD size_t	field_count (Field::RoleType role) const
	Get the number of fields with the given role (MESH, ATTRIBUTE, TRANSIENT, REDUCTION, etc.) in the entity's field manager.

IOSS_NODISCARD bool	check_for_duplicate (const Ioss::Field &new_field) const

int64_t	get_field_data (const std::string &field_name, void *data, size_t data_size) const
	Read field data from the database file into memory using a pointer.

int64_t	put_field_data (const std::string &field_name, void *data, size_t data_size) const
	Write field data from memory into the database file using a pointer.

int64_t	get_field_data (const std::string &field_name, void *data, size_t data_size) const

template<typename T >
int64_t	get_field_data (const std::string &field_name, std::vector< T > &data) const
	Read type 'T' field data from the database file into memory using a std::vector.

template<typename T >
int64_t	put_field_data (const std::string &field_name, const std::vector< T > &data) const
	Write type 'T' field data from memory into the database file using a std::vector.

template<typename T >
int64_t	put_field_data (const std::string &field_name, std::vector< T > &data) const

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

IOSS_NODISCARD unsigned int	hash () const

IOSS_NODISCARD int64_t	entity_count () const

IOSS_NODISCARD bool	operator!= (const GroupingEntity &rhs) const

IOSS_NODISCARD bool	operator== (const GroupingEntity &rhs) const

IOSS_NODISCARD bool	equal (const GroupingEntity &rhs) const

Protected Member Functions
	EntityBlock (DatabaseIO *io_database, const std::string &my_name, const std::string &entity_type, size_t entity_cnt)
	Constructor adds "name" and "entity_count" properties to the entity and specifies the topology type for the entity block.

	EntityBlock (const EntityBlock &)=default

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

Protected Member Functions inherited from Ioss::GroupingEntity
void	count_attributes () const

bool	set_state (State new_state)

void	really_delete_database ()

virtual int64_t	internal_get_field_data (const Field &field, void *data, size_t data_size=0) const =0

virtual int64_t	internal_put_field_data (const Field &field, void *data, size_t data_size=0) const =0

virtual int64_t	internal_get_zc_field_data (const Field &field, void *data, size_t data_size) const =0

IOSS_NODISCARD bool	equal_ (const GroupingEntity &rhs, bool quiet) const

Protected Attributes
ElementTopology *	topology_ {nullptr}

size_t	idOffset {0}

Protected Attributes inherited from Ioss::GroupingEntity
PropertyManager	properties

FieldManager	fields

int64_t	entityCount = 0

Detailed Description

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

The following derived classes are typical:

– NodeBlock – grouping of 'similar' nodes (same degree of freedom, ...)

– ElementBlock – grouping of 'similar' elements (same element topology, attributes, ...) 0d, 1d, 2d, 3d topology possible – e.g., sphere, bar, quad, hex

Constructor & Destructor Documentation

◆ EntityBlock() [1/2]

Ioss::EntityBlock::EntityBlock	(	Ioss::DatabaseIO *	io_database,
		const std::string &	my_name,
		const std::string &	entity_type,
		size_t	entity_cnt )

protected

Constructor adds "name" and "entity_count" properties to the entity and specifies the topology type for the entity block.

Parameters

[in]	io_database	The database associated with the block.
[in]	my_name	The block name.
[in]	entity_type	The topology type for the block.
[in]	entity_cnt	The number of subentities in the block.

◆ EntityBlock() [2/2]

Ioss::EntityBlock::EntityBlock ( const EntityBlock & )

protecteddefault

Member Function Documentation

◆ contains()

IOSS_NODISCARD bool Ioss::EntityBlock::contains ( size_t local_id ) const

inline

Determine whether the block contains the entity with a given id.

Parameters

[in] local_id The id to check.

Returns: True if the block contains the entity.

◆ equal()

bool Ioss::EntityBlock::equal ( const Ioss::EntityBlock & rhs ) const

◆ equal_()

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

protected

◆ get_implicit_property()

Ioss::Property Ioss::EntityBlock::get_implicit_property ( const std::string & my_name ) const

overridepure virtual

Calculate and get an implicit property.

These are calculated from data stored in the EntityBlock instead of having an explicit value assigned. An example would be 'topology_node_count' for an ElementBlock. Note that even though this is a pure virtual function, an implementation is provided to return properties that are common to all 'block'-type grouping entities. Derived classes should call 'EntityBlock::get_implicit_property' if the requested property is not specific to their type.

Implements Ioss::GroupingEntity.

Implemented in Ioss::EdgeBlock, Ioss::ElementBlock, Ioss::FaceBlock, Ioss::NodeBlock, Ioss::SideBlock, and Ioss::StructuredBlock.

◆ get_offset()

IOSS_NODISCARD size_t Ioss::EntityBlock::get_offset ( ) const

inline

Get the 'offset' for the block.

The 'offset' is used to map an element location within an element block to the element 'file descriptor'. For example, the file descriptor of the 37th element in the 4th block is calculated by:

file_descriptor = offset of block 4 + 37

This can also be used to determine which element block an element with a file_descriptor maps into. An particular element block contains all elements in the range:

offset < file_descriptor <= offset+number_elements_per_block

◆ operator!=()

bool Ioss::EntityBlock::operator!= ( const Ioss::EntityBlock & rhs ) const

◆ operator=()

EntityBlock & Ioss::EntityBlock::operator= ( const EntityBlock & )

delete

◆ operator==()

bool Ioss::EntityBlock::operator== ( const Ioss::EntityBlock & rhs ) const

◆ set_offset()

void Ioss::EntityBlock::set_offset ( size_t offset )

inline

Set the 'offset' for the block.

The 'offset' is used to map an element location within an element block to the element 'file descriptor'. For example, the file descriptor of the 37th element in the 4th block is calculated by:

file_descriptor = offset of block 4 + 37

This can also be used to determine which element block an element with a file_descriptor maps into. An particular element block contains all elements in the range:

offset < file_descriptor <= offset+number_elements_per_block

◆ topology()

IOSS_NODISCARD const ElementTopology * Ioss::EntityBlock::topology ( ) const

inline

Get the topology of the entities in the block.

Returns: The topology.

Member Data Documentation

◆ idOffset

size_t Ioss::EntityBlock::idOffset {0}

protected

◆ topology_

ElementTopology* Ioss::EntityBlock::topology_ {nullptr}

protected

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

src/Ioss_EntityBlock.h
src/Ioss_EntityBlock.C

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EntityBlock() [1/2]

◆ EntityBlock() [2/2]

Member Function Documentation

◆ contains()

◆ equal()

◆ equal_()

◆ get_implicit_property()

◆ get_offset()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ set_offset()

◆ topology()

Member Data Documentation

◆ idOffset

◆ topology_