Kratos::IndexSet Class Reference

Custom unordered set container to be used by the mapper. More...

#include <mapping_variables.h>

Inheritance diagram for Kratos::IndexSet:

Collaboration diagram for Kratos::IndexSet:

Public Member Functions
Life Cycle
	IndexSet ()
	Default constructors. More...
virtual	~IndexSet ()
	Destructor. More...
Operations
IndexType	GetId (IteratorType ThisIterator)
	Returns the id corresponding a iterator. More...
IndexType	GetOtherId (IteratorType ThisIterator)
	Returns the new entity id corresponding a iterator. More...
bool	Has (const IndexType IndexOrigin) override
	It checks if an ID exists in the map. More...
void	AddId (const IndexType IndexOrigin, const IndexType IndexNewEntity=0) override
	It adds a new ID to the map. More...
void	RemoveId (const IndexType IndexOrigin) override
	It removes one particular pair from the map. More...
std::string	Info () const override
	Turn back information as a string. More...
void	save (Serializer &rSerializer) const override
void	load (Serializer &rSerializer) override
Public Member Functions inherited from Kratos::IndexDatabase
	KRATOS_CLASS_POINTER_DEFINITION (IndexDatabase)
	IndexDatabase ()
	Default constructors. More...
virtual	~IndexDatabase ()
	Destructor. More...
virtual IndexType	GetNewEntityId (const IndexType IndexOrigin)
	It returns the new created entity ID. More...
virtual void	SetNewEntityId (const IndexType IndexOrigin, const IndexType IndexNewEntity=0)
	It sets the new created entity ID. More...

Type Definitions
Counted pointer of IndexSet
typedef std::unordered_set< IndexType >	BaseType
typedef iterator	IteratorType
	KRATOS_CLASS_POINTER_DEFINITION (IndexSet)

Detailed Description

Custom unordered set container to be used by the mapper.

Contains a set of IDs of paired conditions

Author

Vicente Mataix Ferrandiz

Member Typedef Documentation

BaseType

typedef std::unordered_set<IndexType> Kratos::IndexSet::BaseType

IteratorType

typedef iterator Kratos::IndexSet::IteratorType

Constructor & Destructor Documentation

IndexSet()

Kratos::IndexSet::IndexSet ( )

inline

Default constructors.

~IndexSet()

virtual Kratos::IndexSet::~IndexSet ( )

inlinevirtual

Destructor.

Member Function Documentation

AddId()

void Kratos::IndexSet::AddId ( const IndexType  IndexOrigin, const IndexType  IndexNewEntity = 0  )

inlineoverridevirtual

It adds a new ID to the map.

Parameters

IndexOrigin	The condition ID to remove
IndexNewEntity	The new created entity ID

Reimplemented from Kratos::IndexDatabase.

GetId()

IndexType Kratos::IndexSet::GetId ( IteratorType  ThisIterator )

inline

Returns the id corresponding a iterator.

Parameters

ThisIterator

The iterator of the class

Returns

The ID

GetOtherId()

IndexType Kratos::IndexSet::GetOtherId ( IteratorType  ThisIterator )

inline

Returns the new entity id corresponding a iterator.

Parameters

ThisIterator

The iterator of the class

Returns

The ID of the new generated entity

Has()

bool Kratos::IndexSet::Has ( const IndexType  IndexOrigin )

inlineoverridevirtual

It checks if an ID exists in the map.

Parameters

IndexOrigin

The condition ID to remove

Returns

If the ID already exists or not

Reimplemented from Kratos::IndexDatabase.

Info()

std::string Kratos::IndexSet::Info ( ) const

inlineoverridevirtual

Turn back information as a string.

Reimplemented from Kratos::IndexDatabase.

KRATOS_CLASS_POINTER_DEFINITION()

Kratos::IndexSet::KRATOS_CLASS_POINTER_DEFINITION

(

IndexSet

)

load()

void Kratos::IndexSet::load ( Serializer &  rSerializer )

inlineoverridevirtual

Reimplemented from Kratos::IndexDatabase.

RemoveId()

void Kratos::IndexSet::RemoveId ( const IndexType  IndexOrigin )

inlineoverridevirtual

It removes one particular pair from the map.

Parameters

IndexOrigin

The condition ID to remove

Reimplemented from Kratos::IndexDatabase.

save()

void Kratos::IndexSet::save ( Serializer &  rSerializer ) const

inlineoverridevirtual

Reimplemented from Kratos::IndexDatabase.

---

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

• /home/runner/work/Documentation/Documentation/master/kratos/includes/mapping_variables.h