Kratos::VariableDatabase Class Reference

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

#include <result_dabatase.h>

Collaboration diagram for Kratos::VariableDatabase:

Public Member Functions
Life Cycle
	VariableDatabase (const SizeType SizeVector, const EntityDatabase &rBaseData)
	Default constructor. More...
virtual	~VariableDatabase ()
	Destructor. More...
	VariableDatabase (VariableDatabase const &rOther)
	Copy constructor. More...
Operators
EntityDatabase &	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 EntityDatabase &	GetEntityData (const IndexType EntityIndex) const
	This method retrieves the entity database. More...
double	GetValue (const IndexType EntityIndex, 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 IndexType EntityIndex, 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< EntityDatabase >	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 (VariableDatabase)
	Pointer definition of ResultDatabase. More...

Detailed Description

This class stores the results of a variable.

Author

Vicente Mataix Ferrandiz

Member Typedef Documentation

DataType

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

Base type definition.

IndexType

typedef std::size_t Kratos::VariableDatabase::IndexType

The definition of the index type.

SizeType

typedef std::size_t Kratos::VariableDatabase::SizeType

The definition of the sizetype.

Constructor & Destructor Documentation

VariableDatabase() [1/2]

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

inline

Default constructor.

~VariableDatabase()

virtual Kratos::VariableDatabase::~VariableDatabase ( )

inlinevirtual

Destructor.

VariableDatabase() [2/2]

Kratos::VariableDatabase::VariableDatabase ( VariableDatabase const &  rOther )

inline

Copy constructor.

Member Function Documentation

begin() [1/2]

DataType::iterator Kratos::VariableDatabase::begin ( )

inline

The begin iterator.

begin() [2/2]

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

inline

The const begin iterator.

Clear()

void Kratos::VariableDatabase::Clear

(

)

This function is designed for clear all the databases.

end() [1/2]

DataType::iterator Kratos::VariableDatabase::end ( )

inline

The end iterator.

end() [2/2]

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

inline

The const end iterator.

GetEntityData()

const EntityDatabase & Kratos::VariableDatabase::GetEntityData

(

const IndexType

EntityIndex

)

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::VariableDatabase::GetValue	(	const IndexType	EntityIndex,
		const double	Time,
		const SizeType	ComponentIndex = 0,
		const SizeType	GPIndex = 0
	)		const

This method retrieves the interpolated value from the database.

Parameters

EntityIndex	The index of the entity (not the entity Id, the index in the database)
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::VariableDatabase::Info ( ) const

inlinevirtual

Turn back information as a string.

KRATOS_CLASS_POINTER_DEFINITION()

Kratos::VariableDatabase::KRATOS_CLASS_POINTER_DEFINITION

(

VariableDatabase

)

Pointer definition of ResultDatabase.

operator[]()

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

inline

The [] operator.

Parameters

i	The index of the value to access

PrintData()

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

inlinevirtual

Print object's data.

PrintInfo()

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

inlinevirtual

Print information about this object.

SetValues()

void Kratos::VariableDatabase::SetValues	(	const Vector &	rValuesX,
		const Vector &	rValuesY,
		const IndexType	EntityIndex,
		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
EntityIndex	The index of the entity (not the entity Id, the index in the database)
ComponentIndex	The component index of the vector/array
GPIndex	The GP index

Member Data Documentation

mData

DataType Kratos::VariableDatabase::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