Kratos::EntityDatabase Class Reference

This class stores the results of a entity. More...

#include <result_dabatase.h>

Collaboration diagram for Kratos::EntityDatabase:

Public Member Functions
Life Cycle
	EntityDatabase (const SizeType SizeVector, const GPDatabaseType &rBaseData)
	Default constructor. More...
virtual	~EntityDatabase ()
	Destructor. More...
	EntityDatabase (EntityDatabase const &rOther)
	Copy constructor. More...
Operators
GPDatabaseType &	operator[] (const std::size_t i)
	The [] operator. More...
Operations
DataType::iterator	begin ()
	The begin iterator. More...
DataType::const_iterator	begin () const
	The const begin iterator. More...
DataType::iterator	end ()
	The end iterator. More...
DataType::const_iterator	end () const
	The const end iterator. More...
const GPDatabaseType &	GetResultaData (const SizeType GPIndex=0) const
	This method retrieves the entity database. More...
double	GetValue (const double Time, const SizeType ComponentIndex=0, const SizeType GPIndex=0) const
	This method retrieves the interpolated value from the database. More...
void	SetValues (const Vector &rValuesX, const Vector &rValuesY, const SizeType ComponentIndex=0, const SizeType GPIndex=0)
	This method set the values into the tables. More...
void	Clear ()
	This function is designed for clear all the databases. More...
Input and output
virtual std::string	Info () const
	Turn back information as a string. More...
virtual void	PrintInfo (std::ostream &rOStream) const
	Print information about this object. More...
virtual void	PrintData (std::ostream &rOStream) const
	Print object's data. More...

Protected Attributes
Protected member Variables
DataType	mData

Type Definitions
typedef std::vector< Table< double, double > * >	GPDatabaseType
	GP database definition. More...
typedef std::vector< GPDatabaseType >	DataType
	Base type definition. More...
typedef std::size_t	IndexType
	The definition of the index type. More...
typedef std::size_t	SizeType
	The definition of the sizetype. More...
	KRATOS_CLASS_POINTER_DEFINITION (EntityDatabase)
	Pointer definition of ResultDatabase. More...

Detailed Description

This class stores the results of a entity.

Author

Vicente Mataix Ferrandiz

Member Typedef Documentation

DataType

typedef std::vector<GPDatabaseType> Kratos::EntityDatabase::DataType

Base type definition.

GPDatabaseType

typedef std::vector<Table<double, double>*> Kratos::EntityDatabase::GPDatabaseType

GP database definition.

IndexType

typedef std::size_t Kratos::EntityDatabase::IndexType

The definition of the index type.

SizeType

typedef std::size_t Kratos::EntityDatabase::SizeType

The definition of the sizetype.

Constructor & Destructor Documentation

EntityDatabase() [1/2]

Kratos::EntityDatabase::EntityDatabase ( const SizeType  SizeVector, const GPDatabaseType &  rBaseData  )

inline

Default constructor.

~EntityDatabase()

virtual Kratos::EntityDatabase::~EntityDatabase ( )

inlinevirtual

Destructor.

EntityDatabase() [2/2]

Kratos::EntityDatabase::EntityDatabase ( EntityDatabase const &  rOther )

inline

Copy constructor.

Member Function Documentation

begin() [1/2]

DataType::iterator Kratos::EntityDatabase::begin ( )

inline

The begin iterator.

begin() [2/2]

DataType::const_iterator Kratos::EntityDatabase::begin ( ) const

inline

The const begin iterator.

Clear()

void Kratos::EntityDatabase::Clear

(

)

This function is designed for clear all the databases.

end() [1/2]

DataType::iterator Kratos::EntityDatabase::end ( )

inline

The end iterator.

end() [2/2]

DataType::const_iterator Kratos::EntityDatabase::end ( ) const

inline

The const end iterator.

GetResultaData()

const EntityDatabase::GPDatabaseType & Kratos::EntityDatabase::GetResultaData

(

const SizeType

GPIndex = 0

)

const

This method retrieves the entity database.

Parameters

EntityIndex

The index of the entity (not the entity Id, the index in the database)

GetValue()

double Kratos::EntityDatabase::GetValue	(	const double	Time,
		const SizeType	ComponentIndex = 0,
		const SizeType	GPIndex = 0
	)		const

This method retrieves the interpolated value from the database.

Parameters

Time	The time value to be retrieved
ComponentIndex	The component index of the vector/array
GPIndex	The Gauss point index

Info()

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

inlinevirtual

Turn back information as a string.

KRATOS_CLASS_POINTER_DEFINITION()

Kratos::EntityDatabase::KRATOS_CLASS_POINTER_DEFINITION

(

EntityDatabase

)

Pointer definition of ResultDatabase.

operator[]()

GPDatabaseType& Kratos::EntityDatabase::operator[] ( const std::size_t  i )

inline

The [] operator.

Parameters

i	The index of the value to access

PrintData()

virtual void Kratos::EntityDatabase::PrintData ( std::ostream &  rOStream ) const

inlinevirtual

Print object's data.

PrintInfo()

virtual void Kratos::EntityDatabase::PrintInfo ( std::ostream &  rOStream ) const

inlinevirtual

Print information about this object.

SetValues()

void Kratos::EntityDatabase::SetValues	(	const Vector &	rValuesX,
		const Vector &	rValuesY,
		const SizeType	ComponentIndex = 0,
		const SizeType	GPIndex = 0
	)

This method set the values into the tables.

Parameters

rValuesX	The values of the X axis
rValuesY	The values of the Y axis
ComponentIndex	The component index of the vector/array
GPIndex	The GP index

Member Data Documentation

mData

DataType Kratos::EntityDatabase::mData

protected

---

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

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