Kratos::EntitiesUtilities::EntitityIdentifier< TEntity > Class Template Reference

Template struct for entity identifier. More...

#include <entities_utilities.h>

Collaboration diagram for Kratos::EntitiesUtilities::EntitityIdentifier< TEntity >:

Public Member Functions
Life Cycle
	EntitityIdentifier ()=default
	Default constructor. More...
	EntitityIdentifier (const std::string &rName)
	Constructor. More...
	EntitityIdentifier (const EntitityIdentifier &rOther)
	Copy constructor. More...
Operators
EntitityIdentifier &	operator= (const EntitityIdentifier &rOther)
	Assignment operator. More...
Operations
bool	IsInitialized () const
	Checks if the object is initialized. More...
bool	HasPrototypeEntity (const GeometryType &rGeometry) const
	Get the prototype entity. More...
const TEntity &	GetPrototypeEntity (typename GeometryType::Pointer pGeometry) const
	Get the prototype entity. More...
const TEntity &	GetPrototypeEntity (const GeometryType &rGeometry) const
	Get the prototype entity. More...
Input and output
std::string	Info () const
	Turn back information as a string. More...
void	PrintInfo (std::ostream &rOStream) const
	Print information about this object. More...
void	PrintData (std::ostream &rOStream) const
	Print object's data. More...

Type Definitions
using	GeometryType = typename TEntity::GeometryType
	Geometry type definition. More...
constexpr static std::size_t	LengthArray = static_cast<std::size_t>(GeometryData::KratosGeometryType::NumberOfGeometryTypes)
	Length of array definition. More...
	KRATOS_CLASS_POINTER_DEFINITION (EntitityIdentifier)
	Pointer definition of ReplaceElementsAndConditionsProcess. More...

Detailed Description

template<class TEntity>
class Kratos::EntitiesUtilities::EntitityIdentifier< TEntity >

Template struct for entity identifier.

This struct is used to identify and retrieve entity types based on their names and definitions.

Template Parameters

TEntity

The entity type.

Member Typedef Documentation

GeometryType

template<class TEntity >

using Kratos::EntitiesUtilities::EntitityIdentifier< TEntity >::GeometryType = typename TEntity::GeometryType

Geometry type definition.

Constructor & Destructor Documentation

EntitityIdentifier() [1/3]

template<class TEntity >

Kratos::EntitiesUtilities::EntitityIdentifier< TEntity >::EntitityIdentifier ( )

default

Default constructor.

EntitityIdentifier() [2/3]

template<class TEntity >

Kratos::EntitiesUtilities::EntitityIdentifier< TEntity >::EntitityIdentifier

(

const std::string &

rName

)

Constructor.

Parameters

rName

The name of the entity.

EntitityIdentifier() [3/3]

template<class TEntity >

Kratos::EntitiesUtilities::EntitityIdentifier< TEntity >::EntitityIdentifier ( const EntitityIdentifier< TEntity > &  rOther )

inline

Copy constructor.

Member Function Documentation

GetPrototypeEntity() [1/2]

template<class TEntity >

const TEntity & Kratos::EntitiesUtilities::EntitityIdentifier< TEntity >::GetPrototypeEntity

(

const GeometryType &

rGeometry

)

const

Get the prototype entity.

Parameters

rGeometry

The reference to the geometry.

Returns

const TEntity& The prototype entity.

GetPrototypeEntity() [2/2]

template<class TEntity >

const TEntity & Kratos::EntitiesUtilities::EntitityIdentifier< TEntity >::GetPrototypeEntity

(

typename GeometryType::Pointer

pGeometry

)

const

Get the prototype entity.

Parameters

pGeometry

The pointer to the geometry.

Returns

const TEntity& The prototype entity.

HasPrototypeEntity()

template<class TEntity >

bool Kratos::EntitiesUtilities::EntitityIdentifier< TEntity >::HasPrototypeEntity

(

const GeometryType &

rGeometry

)

const

Get the prototype entity.

Parameters

rGeometry

The reference to the geometry.

Returns

true there is a prototype for the provided entity.

false there is no prototype for the provided entity.

Info()

template<class TEntity >

std::string Kratos::EntitiesUtilities::EntitityIdentifier< TEntity >::Info ( ) const

inline

Turn back information as a string.

IsInitialized()

template<class TEntity >

bool Kratos::EntitiesUtilities::EntitityIdentifier< TEntity >::IsInitialized

Checks if the object is initialized.

Returns

true if the object is initialized, false otherwise.

KRATOS_CLASS_POINTER_DEFINITION()

template<class TEntity >

Kratos::EntitiesUtilities::EntitityIdentifier< TEntity >::KRATOS_CLASS_POINTER_DEFINITION

(

EntitityIdentifier< TEntity >

)

Pointer definition of ReplaceElementsAndConditionsProcess.

operator=()

template<class TEntity >

EntitityIdentifier& Kratos::EntitiesUtilities::EntitityIdentifier< TEntity >::operator= ( const EntitityIdentifier< TEntity > &  rOther )

inline

Assignment operator.

PrintData()

template<class TEntity >

void Kratos::EntitiesUtilities::EntitityIdentifier< TEntity >::PrintData

(

std::ostream &

rOStream

)

const

Print object's data.

PrintInfo()

template<class TEntity >

void Kratos::EntitiesUtilities::EntitityIdentifier< TEntity >::PrintInfo ( std::ostream &  rOStream ) const

inline

Print information about this object.

Member Data Documentation

LengthArray

template<class TEntity >

constexpr static std::size_t Kratos::EntitiesUtilities::EntitityIdentifier< TEntity >::LengthArray = static_cast<std::size_t>(GeometryData::KratosGeometryType::NumberOfGeometryTypes)

staticconstexpr

Length of array definition.

---

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

• /home/runner/work/Documentation/Documentation/master/kratos/utilities/entities_utilities.h
• /home/runner/work/Documentation/Documentation/master/kratos/utilities/entities_utilities.cpp