Kratos::ResultDatabase Class Reference

This class stores the results of a simulation for a later comparison. More...

#include <result_dabatase.h>

Collaboration diagram for Kratos::ResultDatabase:

Public Member Functions
Life Cycle
	ResultDatabase ()
	Default constructor. More...
virtual	~ResultDatabase ()
	Destructor. More...
	ResultDatabase (ResultDatabase const &rOther)
	Copy constructor. More...
Operations
void	Initialize (const std::vector< IndexType > &rVariablesIndexes, const std::vector< IndexType > &rValuesSizes, const SizeType NumberOfEntites, const SizeType NumberOfGP=1)
	This method initializes the database. More...
template<class TVariableType >
VariableDatabase &	GetVariableData (const TVariableType &rVariable)
	This method retrieves the variable database. More...
template<class TVariableType >
const VariableDatabase &	GetVariableData (const TVariableType &rVariable) const
	This method retrieves the variable database. More...
template<class TVariableType >
void	SetValues (const Vector &rValuesX, const Vector &rValuesY, const TVariableType &rVariable, 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...
int	Check ()
	This function is designed for being called after ExecuteInitialize ONCE to verify that the input is correct. More...
Access
Vector &	GetCommonColumn ()
	This method returns the common column vector. More...
void	SetCommonColumn (const Vector &rCommonColumn)
	This method sets the common column. 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
std::unordered_map< IndexType, VariableDatabase >	mData
Vector	mCommonColumn

Type Definitions
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 (ResultDatabase)
	Pointer definition of ResultDatabase. More...

Detailed Description

This class stores the results of a simulation for a later comparison.

The results are stored in a map which stores the results in tables. The following structure is followed:

• The key is the Id of the variable considered (so it does not depend if a double or component)
• A vector containing a set of tables. This tables are which actually contain the results

  Note

  If the table could store N columns without requiring a template argument the vector would not be required, saving NvariablesxNColumnsxNsteps doubles of memory

  Author

  Vicente Mataix Ferrandiz

Member Typedef Documentation

IndexType

typedef std::size_t Kratos::ResultDatabase::IndexType

The definition of the index type.

SizeType

typedef std::size_t Kratos::ResultDatabase::SizeType

The definition of the sizetype.

Constructor & Destructor Documentation

ResultDatabase() [1/2]

Kratos::ResultDatabase::ResultDatabase ( )

inline

Default constructor.

~ResultDatabase()

virtual Kratos::ResultDatabase::~ResultDatabase ( )

inlinevirtual

Destructor.

ResultDatabase() [2/2]

Kratos::ResultDatabase::ResultDatabase ( ResultDatabase const &  rOther )

inline

Copy constructor.

Member Function Documentation

Check()

int Kratos::ResultDatabase::Check

(

)

This function is designed for being called after ExecuteInitialize ONCE to verify that the input is correct.

Clear()

void Kratos::ResultDatabase::Clear

(

)

This function is designed for clear all the databases.

GetCommonColumn()

Vector& Kratos::ResultDatabase::GetCommonColumn ( )

inline

This method returns the common column vector.

Returns

The common column vector

GetVariableData() [1/2]

template<class TVariableType >

VariableDatabase& Kratos::ResultDatabase::GetVariableData ( const TVariableType &  rVariable )

inline

This method retrieves the variable database.

Parameters

rVariable

The variable to be retrieved

Template Parameters

TVariableType

The variable type considered

GetVariableData() [2/2]

template<class TVariableType >

const VariableDatabase& Kratos::ResultDatabase::GetVariableData ( const TVariableType &  rVariable ) const

inline

This method retrieves the variable database.

Parameters

rVariable

The variable to be retrieved

Template Parameters

TVariableType

The variable type considered

Info()

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

inlinevirtual

Turn back information as a string.

Initialize()

void Kratos::ResultDatabase::Initialize	(	const std::vector< IndexType > &	rVariablesIndexes,
		const std::vector< IndexType > &	rValuesSizes,
		const SizeType	NumberOfEntites,
		const SizeType	NumberOfGP = 1
	)

This method initializes the database.

Parameters

rVariablesIndexes	The list of indexes of the variables
NumberOfEntites	The number of entities considered

KRATOS_CLASS_POINTER_DEFINITION()

Kratos::ResultDatabase::KRATOS_CLASS_POINTER_DEFINITION

(

ResultDatabase

)

Pointer definition of ResultDatabase.

PrintData()

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

inlinevirtual

Print object's data.

PrintInfo()

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

inlinevirtual

Print information about this object.

SetCommonColumn()

void Kratos::ResultDatabase::SetCommonColumn ( const Vector &  rCommonColumn )

inline

This method sets the common column.

Parameters

rCommonColumn

The common column (time) vector

SetValues()

template<class TVariableType >

void Kratos::ResultDatabase::SetValues ( const Vector &  rValuesX, const Vector &  rValuesY, const TVariableType &  rVariable, const IndexType  EntityIndex, const SizeType  ComponentIndex = 0, const SizeType  GPIndex = 0  )

inline

This method set the values into the tables.

Parameters

rValuesX	The values of the X axis
rValuesY	The values of the Y axis
rVariable	The variable to be retrieved
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

Template Parameters

TVariableType

The variable type considered

Member Data Documentation

mCommonColumn

Vector Kratos::ResultDatabase::mCommonColumn

protected

mData

std::unordered_map<IndexType, VariableDatabase> Kratos::ResultDatabase::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