Kratos::GeometryContainer< TGeometryType > Class Template Reference

#include <geometry_container.h>

Collaboration diagram for Kratos::GeometryContainer< TGeometryType >:

Public Member Functions
Life Cycle
	GeometryContainer ()
	Default Constructor. More...
	GeometryContainer (GeometryContainer const &rOther)
	Copy Constructor. More...
	GeometryContainer (GeometriesMapType &NewGeometries)
	Components Constructor. More...
	~GeometryContainer ()=default
	Destructor. More...
Operations
GeometryContainer	Clone ()
void	Clear ()
Geometries
SizeType	NumberOfGeometries () const
	Return number of geometries stored inside this geometry container. More...
Add Functions
GeometryIterator	AddGeometry (GeometryPointerType pNewGeometry)
	Adds a geometry to the geometry container. More...
Get Functions
GeometryPointerType	pGetGeometry (IndexType GeometryId)
	Returns the Geometry::Pointer corresponding to its Id. More...
const GeometryPointerType	pGetGeometry (IndexType GeometryId) const
	Returns the const Geometry::Pointer corresponding to its Id. More...
GeometryPointerType	pGetGeometry (std::string GeometryName)
	Returns the Geometry::Pointer corresponding to its name. More...
const GeometryPointerType	pGetGeometry (std::string GeometryName) const
	Returns the Geometry::Pointer corresponding to its name. More...
TGeometryType &	GetGeometry (IndexType GeometryId)
	Returns a reference geometry corresponding to the id. More...
const TGeometryType &	GetGeometry (IndexType GeometryId) const
	Returns a const reference geometry corresponding to the id. More...
TGeometryType &	GetGeometry (std::string GeometryName)
	Returns a reference geometry corresponding to the name. More...
const TGeometryType &	GetGeometry (std::string GeometryName) const
	Returns a const reference geometry corresponding to the name. More...
Remove Functions
void	RemoveGeometry (IndexType GeometryId)
	Remove the geometry with given Id from geometry container. More...
void	RemoveGeometry (std::string GeometryName)
	Remove the geometry with given name from geometry container. More...
Search Functions
bool	HasGeometry (IndexType GeometryId) const
bool	HasGeometry (std::string GeometryName) const
Iterators
GeometryIterator	GeometriesBegin ()
GeometryConstantIterator	GeometriesBegin () const
GeometryIterator	GeometriesEnd ()
GeometryConstantIterator	GeometriesEnd () const
Container Functions
GeometriesMapType &	Geometries ()
const GeometriesMapType &	Geometries () const
Input and output
std::string	Info () const
	Return information. More...
void	PrintInfo (std::ostream &rOStream) const
	Print information about this object. More...
void	PrintData (std::ostream &rOStream) const
	Print object's data. More...
virtual void	PrintInfo (std::ostream &rOStream, std::string const &PrefixString) const
	Print information about this object. More...
virtual void	PrintData (std::ostream &rOStream, std::string const &PrefixString) const
	Print object's data. More...

Type Definitions
typedef std::size_t	IndexType
typedef std::size_t	SizeType
typedef TGeometryType::Pointer	GeometryPointerType
typedef PointerHashMapSet< TGeometryType, std::hash< std::size_t >, GetGeometryId, GeometryPointerType >	GeometriesMapType
	Geometry Hash Map Container. More...
typedef GeometriesMapType::iterator	GeometryIterator
	Geometry Iterator. More...
typedef GeometriesMapType::const_iterator	GeometryConstantIterator
	Const Geometry Iterator. More...
	KRATOS_CLASS_POINTER_DEFINITION (GeometryContainer)
	Pointer definition of GeometryContainer. More...

Serialization
class	Serializer

Member Typedef Documentation

GeometriesMapType

template<class TGeometryType >

typedef PointerHashMapSet< TGeometryType, std::hash<std::size_t>, GetGeometryId, GeometryPointerType > Kratos::GeometryContainer< TGeometryType >::GeometriesMapType

Geometry Hash Map Container.

GeometryConstantIterator

template<class TGeometryType >

typedef GeometriesMapType::const_iterator Kratos::GeometryContainer< TGeometryType >::GeometryConstantIterator

Const Geometry Iterator.

GeometryIterator

template<class TGeometryType >

typedef GeometriesMapType::iterator Kratos::GeometryContainer< TGeometryType >::GeometryIterator

Geometry Iterator.

GeometryPointerType

template<class TGeometryType >

typedef TGeometryType::Pointer Kratos::GeometryContainer< TGeometryType >::GeometryPointerType

IndexType

template<class TGeometryType >

typedef std::size_t Kratos::GeometryContainer< TGeometryType >::IndexType

SizeType

template<class TGeometryType >

typedef std::size_t Kratos::GeometryContainer< TGeometryType >::SizeType

Constructor & Destructor Documentation

GeometryContainer() [1/3]

template<class TGeometryType >

Kratos::GeometryContainer< TGeometryType >::GeometryContainer ( )

inline

Default Constructor.

GeometryContainer() [2/3]

template<class TGeometryType >

Kratos::GeometryContainer< TGeometryType >::GeometryContainer ( GeometryContainer< TGeometryType > const &  rOther )

inline

Copy Constructor.

GeometryContainer() [3/3]

template<class TGeometryType >

Kratos::GeometryContainer< TGeometryType >::GeometryContainer ( GeometriesMapType &  NewGeometries )

inline

Components Constructor.

~GeometryContainer()

template<class TGeometryType >

Kratos::GeometryContainer< TGeometryType >::~GeometryContainer ( )

default

Destructor.

Member Function Documentation

AddGeometry()

template<class TGeometryType >

GeometryIterator Kratos::GeometryContainer< TGeometryType >::AddGeometry ( GeometryPointerType  pNewGeometry )

inline

Adds a geometry to the geometry container.

Clear()

template<class TGeometryType >

void Kratos::GeometryContainer< TGeometryType >::Clear ( )

inline

Clone()

template<class TGeometryType >

GeometryContainer Kratos::GeometryContainer< TGeometryType >::Clone ( )

inline

Geometries() [1/2]

template<class TGeometryType >

GeometriesMapType& Kratos::GeometryContainer< TGeometryType >::Geometries ( )

inline

Geometries() [2/2]

template<class TGeometryType >

const GeometriesMapType& Kratos::GeometryContainer< TGeometryType >::Geometries ( ) const

inline

GeometriesBegin() [1/2]

template<class TGeometryType >

GeometryIterator Kratos::GeometryContainer< TGeometryType >::GeometriesBegin ( )

inline

GeometriesBegin() [2/2]

template<class TGeometryType >

GeometryConstantIterator Kratos::GeometryContainer< TGeometryType >::GeometriesBegin ( ) const

inline

GeometriesEnd() [1/2]

template<class TGeometryType >

GeometryIterator Kratos::GeometryContainer< TGeometryType >::GeometriesEnd ( )

inline

GeometriesEnd() [2/2]

template<class TGeometryType >

GeometryConstantIterator Kratos::GeometryContainer< TGeometryType >::GeometriesEnd ( ) const

inline

GetGeometry() [1/4]

template<class TGeometryType >

TGeometryType& Kratos::GeometryContainer< TGeometryType >::GetGeometry ( IndexType  GeometryId )

inline

Returns a reference geometry corresponding to the id.

GetGeometry() [2/4]

template<class TGeometryType >

const TGeometryType& Kratos::GeometryContainer< TGeometryType >::GetGeometry ( IndexType  GeometryId ) const

inline

Returns a const reference geometry corresponding to the id.

GetGeometry() [3/4]

template<class TGeometryType >

TGeometryType& Kratos::GeometryContainer< TGeometryType >::GetGeometry ( std::string  GeometryName )

inline

Returns a reference geometry corresponding to the name.

GetGeometry() [4/4]

template<class TGeometryType >

const TGeometryType& Kratos::GeometryContainer< TGeometryType >::GetGeometry ( std::string  GeometryName ) const

inline

Returns a const reference geometry corresponding to the name.

HasGeometry() [1/2]

template<class TGeometryType >

bool Kratos::GeometryContainer< TGeometryType >::HasGeometry ( IndexType  GeometryId ) const

inline

HasGeometry() [2/2]

template<class TGeometryType >

bool Kratos::GeometryContainer< TGeometryType >::HasGeometry ( std::string  GeometryName ) const

inline

Info()

template<class TGeometryType >

std::string Kratos::GeometryContainer< TGeometryType >::Info ( ) const

inline

Return information.

KRATOS_CLASS_POINTER_DEFINITION()

template<class TGeometryType >

Kratos::GeometryContainer< TGeometryType >::KRATOS_CLASS_POINTER_DEFINITION

(

GeometryContainer< TGeometryType >

)

Pointer definition of GeometryContainer.

NumberOfGeometries()

template<class TGeometryType >

SizeType Kratos::GeometryContainer< TGeometryType >::NumberOfGeometries ( ) const

inline

Return number of geometries stored inside this geometry container.

pGetGeometry() [1/4]

template<class TGeometryType >

GeometryPointerType Kratos::GeometryContainer< TGeometryType >::pGetGeometry ( IndexType  GeometryId )

inline

Returns the Geometry::Pointer corresponding to its Id.

pGetGeometry() [2/4]

template<class TGeometryType >

const GeometryPointerType Kratos::GeometryContainer< TGeometryType >::pGetGeometry ( IndexType  GeometryId ) const

inline

Returns the const Geometry::Pointer corresponding to its Id.

pGetGeometry() [3/4]

template<class TGeometryType >

GeometryPointerType Kratos::GeometryContainer< TGeometryType >::pGetGeometry ( std::string  GeometryName )

inline

Returns the Geometry::Pointer corresponding to its name.

pGetGeometry() [4/4]

template<class TGeometryType >

const GeometryPointerType Kratos::GeometryContainer< TGeometryType >::pGetGeometry ( std::string  GeometryName ) const

inline

Returns the Geometry::Pointer corresponding to its name.

PrintData() [1/2]

template<class TGeometryType >

void Kratos::GeometryContainer< TGeometryType >::PrintData ( std::ostream &  rOStream ) const

inline

Print object's data.

PrintData() [2/2]

template<class TGeometryType >

virtual void Kratos::GeometryContainer< TGeometryType >::PrintData ( std::ostream &  rOStream, std::string const &  PrefixString  ) const

inlinevirtual

Print object's data.

PrintInfo() [1/2]

template<class TGeometryType >

void Kratos::GeometryContainer< TGeometryType >::PrintInfo ( std::ostream &  rOStream ) const

inline

Print information about this object.

PrintInfo() [2/2]

template<class TGeometryType >

virtual void Kratos::GeometryContainer< TGeometryType >::PrintInfo ( std::ostream &  rOStream, std::string const &  PrefixString  ) const

inlinevirtual

Print information about this object.

RemoveGeometry() [1/2]

template<class TGeometryType >

void Kratos::GeometryContainer< TGeometryType >::RemoveGeometry ( IndexType  GeometryId )

inline

Remove the geometry with given Id from geometry container.

RemoveGeometry() [2/2]

template<class TGeometryType >

void Kratos::GeometryContainer< TGeometryType >::RemoveGeometry ( std::string  GeometryName )

inline

Remove the geometry with given name from geometry container.

Friends And Related Function Documentation

Serializer

template<class TGeometryType >

friend class Serializer

friend

---

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

• /home/runner/work/Documentation/Documentation/master/kratos/containers/geometry_container.h