Kratos::IndexDatabase Class Reference

Base class to derive common methods. More...

#include <mapping_variables.h>

Inheritance diagram for Kratos::IndexDatabase:

Collaboration diagram for Kratos::IndexDatabase:

Public Member Functions
Type Definitions
Counted pointer of IndexDatabase
	KRATOS_CLASS_POINTER_DEFINITION (IndexDatabase)
Life Cycle
	IndexDatabase ()
	Default constructors. More...
virtual	~IndexDatabase ()
	Destructor. More...
Operations
virtual bool	Has (const IndexType IndexOrigin)
	It checks if an ID exists in the map. More...
virtual void	AddId (const IndexType IndexOrigin, const IndexType IndexNewEntity=0)
	It adds a new ID to the map. More...
virtual void	RemoveId (const IndexType IndexOrigin)
	It removes one particular pair from the map. 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...
virtual std::string	Info () const
	Turn back information as a string. More...
virtual void	save (Serializer &rSerializer) const
virtual void	load (Serializer &rSerializer)

Detailed Description

Base class to derive common methods.

Author

Vicente Mataix Ferrandiz

Constructor & Destructor Documentation

IndexDatabase()

Kratos::IndexDatabase::IndexDatabase ( )

inline

Default constructors.

~IndexDatabase()

virtual Kratos::IndexDatabase::~IndexDatabase ( )

inlinevirtual

Destructor.

Member Function Documentation

AddId()

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

inlinevirtual

It adds a new ID to the map.

Parameters

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

Reimplemented in Kratos::IndexMap, and Kratos::IndexSet.

GetNewEntityId()

virtual IndexType Kratos::IndexDatabase::GetNewEntityId ( const IndexType  IndexOrigin )

inlinevirtual

It returns the new created entity ID.

Parameters

IndexOrigin

The condition ID to remove

Returns

The new created entity ID

Reimplemented in Kratos::IndexMap.

Has()

virtual bool Kratos::IndexDatabase::Has ( const IndexType  IndexOrigin )

inlinevirtual

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 in Kratos::IndexMap, and Kratos::IndexSet.

Info()

virtual std::string Kratos::IndexDatabase::Info ( ) const

inlinevirtual

Turn back information as a string.

Reimplemented in Kratos::IndexMap, and Kratos::IndexSet.

KRATOS_CLASS_POINTER_DEFINITION()

Kratos::IndexDatabase::KRATOS_CLASS_POINTER_DEFINITION

(

IndexDatabase

)

load()

virtual void Kratos::IndexDatabase::load ( Serializer &  rSerializer )

inlinevirtual

Reimplemented in Kratos::IndexMap, and Kratos::IndexSet.

RemoveId()

virtual void Kratos::IndexDatabase::RemoveId ( const IndexType  IndexOrigin )

inlinevirtual

It removes one particular pair from the map.

Parameters

IndexOrigin

The condition ID to remove

Reimplemented in Kratos::IndexMap, and Kratos::IndexSet.

save()

virtual void Kratos::IndexDatabase::save ( Serializer &  rSerializer ) const

inlinevirtual

Reimplemented in Kratos::IndexMap, and Kratos::IndexSet.

SetNewEntityId()

virtual void Kratos::IndexDatabase::SetNewEntityId ( const IndexType  IndexOrigin, const IndexType  IndexNewEntity = 0  )

inlinevirtual

It sets the new created entity ID.

Parameters

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

Reimplemented in Kratos::IndexMap.

---

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

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