A shared variable list gives the position of each variable in the containers sharing it. More...

#include <variables_list_data_value_container.h>

Collaboration diagram for Kratos::VariablesListDataValueContainer:

Public Member Functions
Life Cycle
	VariablesListDataValueContainer (SizeType NewQueueSize=1)
	Default constructor. More...

	VariablesListDataValueContainer (VariablesListDataValueContainer const &rOther)
	Copy constructor. More...

	VariablesListDataValueContainer (VariablesList::Pointer pVariablesList, SizeType NewQueueSize=1)
	Variables list constructor. More...

	VariablesListDataValueContainer (VariablesList::Pointer pVariablesList, BlockType const *ThisData, SizeType NewQueueSize=1)
	Variables list and data constructor. More...

	~VariablesListDataValueContainer ()
	Destructor. More...

Operators
template<class TDataType >
TDataType &	operator() (const Variable< TDataType > &rThisVariable)

template<class TDataType >
TDataType &	operator() (const Variable< TDataType > &rThisVariable, SizeType QueueIndex)

template<class TDataType >
const TDataType &	operator() (const Variable< TDataType > &rThisVariable) const

template<class TDataType >
const TDataType &	operator() (const Variable< TDataType > &rThisVariable, SizeType QueueIndex) const

template<class TDataType >
TDataType &	operator[] (const Variable< TDataType > &rThisVariable)

template<class TDataType >
const TDataType &	operator[] (const Variable< TDataType > &rThisVariable) const

VariablesListDataValueContainer &	operator= (const VariablesListDataValueContainer &rOther)
	Assignment operator. More...

Operations
template<class TDataType >
TDataType &	GetValue (const Variable< TDataType > &rThisVariable)

template<class TDataType >
TDataType &	GetValue (const Variable< TDataType > &rThisVariable, SizeType QueueIndex)

template<class TDataType >
const TDataType &	GetValue (const Variable< TDataType > &rThisVariable) const

template<class TDataType >
const TDataType &	GetValue (const Variable< TDataType > &rThisVariable, SizeType QueueIndex) const

template<class TDataType >
TDataType &	FastGetValue (const Variable< TDataType > &rThisVariable)

template<class TDataType >
TDataType *	pFastGetValue (const Variable< TDataType > &rThisVariable)

template<class TDataType >
TDataType &	FastGetValue (const Variable< TDataType > &rThisVariable, SizeType QueueIndex)

template<class TDataType >
TDataType &	FastGetValue (const Variable< TDataType > &rThisVariable, SizeType QueueIndex, SizeType ThisPosition)

template<class TDataType >
TDataType &	FastGetCurrentValue (const Variable< TDataType > &rThisVariable, SizeType ThisPosition)

template<class TDataType >
const TDataType &	FastGetValue (const Variable< TDataType > &rThisVariable) const

template<class TDataType >
const TDataType *	pFastGetValue (const Variable< TDataType > &rThisVariable) const

template<class TDataType >
const TDataType &	FastGetValue (const Variable< TDataType > &rThisVariable, SizeType QueueIndex) const

template<class TDataType >
const TDataType &	FastGetValue (const Variable< TDataType > &rThisVariable, SizeType QueueIndex, SizeType ThisPosition) const

template<class TDataType >
const TDataType &	FastGetCurrentValue (const Variable< TDataType > &rThisVariable, SizeType ThisPosition) const

SizeType	Size () const

SizeType	QueueSize () const

SizeType	TotalSize () const

template<class TDataType >
void	SetValue (const Variable< TDataType > &rThisVariable, TDataType const &rValue)

template<class TDataType >
void	SetValue (const Variable< TDataType > &rThisVariable, TDataType const &rValue, SizeType QueueIndex)

void	Clear ()

Access
VariablesList::Pointer	pGetVariablesList ()

const VariablesList::Pointer	pGetVariablesList () const

VariablesList &	GetVariablesList ()

const VariablesList &	GetVariablesList () const

void	SetVariablesList (VariablesList::Pointer pVariablesList)

void	SetVariablesList (VariablesList::Pointer pVariablesList, SizeType ThisQueueSize)

void	Resize (SizeType NewSize)

BlockType *	Data ()

const BlockType *	Data () const

BlockType *	Data (SizeType QueueIndex)

BlockType *	Data (VariableData const &rThisVariable)

SizeType	DataSize ()

SizeType	TotalDataSize ()

void	AssignData (BlockType *Source, SizeType QueueIndex)

void	CloneFront ()

void	PushFront ()

void	AssignZero ()

void	AssignZero (const SizeType QueueIndex)

Inquiry
bool	Has (const VariableData &rThisVariable) const
	This method returns if a certain variable is stored in the data value container. More...

bool	IsEmpty ()

Input and output
std::string	Info () const
	Turn back information as a string. More...

void	PrintInfo (std::ostream &rOStream) const
	Print information about this object. More...

void	PrintData (std::ostream &rOStream) const
	Print object's data. More...

Type Definitions
using	BlockType = VariablesList::BlockType
	The block type definition. More...

using	ContainerType = BlockType *
	Type of the container used for variables. More...

using	IndexType = std::size_t
	The index type definition. More...

using	SizeType = std::size_t
	The size type definition. More...

	KRATOS_CLASS_POINTER_DEFINITION (VariablesListDataValueContainer)
	Pointer definition of VariablesListDataValueContainer. More...

Serialization
class	Serializer

Detailed Description

A shared variable list gives the position of each variable in the containers sharing it.

The mechanism is very simple. There is an array which stores the local offset for each variable in the container and assigns the value−1 for the rest of the variables For more details see P. Dadvand, R. Rossi, E. Oñate: An Object-oriented Environment for Developing Finite Element Codes for Multi-disciplinary Applications. Computational Methods in Engineering. 2010

Author: Pooyan Dadvand; Riccardo Rossi

Member Typedef Documentation

◆ BlockType

using Kratos::VariablesListDataValueContainer::BlockType = VariablesList::BlockType

The block type definition.

◆ ContainerType

using Kratos::VariablesListDataValueContainer::ContainerType = BlockType*

Type of the container used for variables.

◆ IndexType

using Kratos::VariablesListDataValueContainer::IndexType = std::size_t

The index type definition.

◆ SizeType

using Kratos::VariablesListDataValueContainer::SizeType = std::size_t

The size type definition.

Constructor & Destructor Documentation

◆ VariablesListDataValueContainer() [1/4]

Kratos::VariablesListDataValueContainer::VariablesListDataValueContainer ( SizeType NewQueueSize = 1 )

inlineexplicit

Default constructor.

◆ VariablesListDataValueContainer() [2/4]

Kratos::VariablesListDataValueContainer::VariablesListDataValueContainer ( VariablesListDataValueContainer const & rOther )

inline

Copy constructor.

◆ VariablesListDataValueContainer() [3/4]

Kratos::VariablesListDataValueContainer::VariablesListDataValueContainer	(	VariablesList::Pointer	pVariablesList,
		SizeType	NewQueueSize = `1`
	)

inline

Variables list constructor.

◆ VariablesListDataValueContainer() [4/4]

Kratos::VariablesListDataValueContainer::VariablesListDataValueContainer	(	VariablesList::Pointer	pVariablesList,
		BlockType const *	ThisData,
		SizeType	NewQueueSize = `1`
	)

inline

Variables list and data constructor.

◆ ~VariablesListDataValueContainer()

Kratos::VariablesListDataValueContainer::~VariablesListDataValueContainer ( )

inline

Destructor.

Member Function Documentation

◆ AssignData()

void Kratos::VariablesListDataValueContainer::AssignData	(	BlockType *	Source,
		SizeType	QueueIndex
	)

inline

◆ AssignZero() [1/2]

void Kratos::VariablesListDataValueContainer::AssignZero ( )

inline

◆ AssignZero() [2/2]

void Kratos::VariablesListDataValueContainer::AssignZero ( const SizeType QueueIndex )

inline

◆ Clear()

void Kratos::VariablesListDataValueContainer::Clear ( )

inline

◆ CloneFront()

void Kratos::VariablesListDataValueContainer::CloneFront ( )

inline

◆ Data() [1/4]

BlockType* Kratos::VariablesListDataValueContainer::Data ( )

inline

◆ Data() [2/4]

const BlockType* Kratos::VariablesListDataValueContainer::Data ( ) const

inline

◆ Data() [3/4]

BlockType* Kratos::VariablesListDataValueContainer::Data ( SizeType QueueIndex )

inline

◆ Data() [4/4]

BlockType* Kratos::VariablesListDataValueContainer::Data ( VariableData const & rThisVariable )

inline

◆ DataSize()

SizeType Kratos::VariablesListDataValueContainer::DataSize ( )

inline

◆ FastGetCurrentValue() [1/2]

template<class TDataType >

TDataType& Kratos::VariablesListDataValueContainer::FastGetCurrentValue	(	const Variable< TDataType > &	rThisVariable,
		SizeType	ThisPosition
	)

inline

◆ FastGetCurrentValue() [2/2]

template<class TDataType >

const TDataType& Kratos::VariablesListDataValueContainer::FastGetCurrentValue	(	const Variable< TDataType > &	rThisVariable,
		SizeType	ThisPosition
	)		const

inline

◆ FastGetValue() [1/6]

template<class TDataType >

TDataType& Kratos::VariablesListDataValueContainer::FastGetValue ( const Variable< TDataType > & rThisVariable )

inline

◆ FastGetValue() [2/6]

template<class TDataType >

const TDataType& Kratos::VariablesListDataValueContainer::FastGetValue ( const Variable< TDataType > & rThisVariable ) const

inline

◆ FastGetValue() [3/6]

template<class TDataType >

TDataType& Kratos::VariablesListDataValueContainer::FastGetValue	(	const Variable< TDataType > &	rThisVariable,
		SizeType	QueueIndex
	)

inline

◆ FastGetValue() [4/6]

template<class TDataType >

const TDataType& Kratos::VariablesListDataValueContainer::FastGetValue	(	const Variable< TDataType > &	rThisVariable,
		SizeType	QueueIndex
	)		const

inline

◆ FastGetValue() [5/6]

template<class TDataType >

TDataType& Kratos::VariablesListDataValueContainer::FastGetValue	(	const Variable< TDataType > &	rThisVariable,
		SizeType	QueueIndex,
		SizeType	ThisPosition
	)

inline

◆ FastGetValue() [6/6]

template<class TDataType >

const TDataType& Kratos::VariablesListDataValueContainer::FastGetValue	(	const Variable< TDataType > &	rThisVariable,
		SizeType	QueueIndex,
		SizeType	ThisPosition
	)		const

inline

◆ GetValue() [1/4]

template<class TDataType >

TDataType& Kratos::VariablesListDataValueContainer::GetValue ( const Variable< TDataType > & rThisVariable )

inline

◆ GetValue() [2/4]

template<class TDataType >

const TDataType& Kratos::VariablesListDataValueContainer::GetValue ( const Variable< TDataType > & rThisVariable ) const

inline

◆ GetValue() [3/4]

template<class TDataType >

TDataType& Kratos::VariablesListDataValueContainer::GetValue	(	const Variable< TDataType > &	rThisVariable,
		SizeType	QueueIndex
	)

inline

◆ GetValue() [4/4]

template<class TDataType >

const TDataType& Kratos::VariablesListDataValueContainer::GetValue	(	const Variable< TDataType > &	rThisVariable,
		SizeType	QueueIndex
	)		const

inline

◆ GetVariablesList() [1/2]

VariablesList& Kratos::VariablesListDataValueContainer::GetVariablesList ( )

inline

◆ GetVariablesList() [2/2]

const VariablesList& Kratos::VariablesListDataValueContainer::GetVariablesList ( ) const

inline

◆ Has()

bool Kratos::VariablesListDataValueContainer::Has ( const VariableData & rThisVariable ) const

inline

This method returns if a certain variable is stored in the data value container.

Parameters

rThisVariable The variable to be checked

Returns: True if the variable is stored, false otherwise

◆ Info()

std::string Kratos::VariablesListDataValueContainer::Info ( ) const

inline

Turn back information as a string.

◆ IsEmpty()

bool Kratos::VariablesListDataValueContainer::IsEmpty ( )

inline

◆ KRATOS_CLASS_POINTER_DEFINITION()

Kratos::VariablesListDataValueContainer::KRATOS_CLASS_POINTER_DEFINITION ( VariablesListDataValueContainer )

Pointer definition of VariablesListDataValueContainer.

◆ operator()() [1/4]

template<class TDataType >

TDataType& Kratos::VariablesListDataValueContainer::operator() ( const Variable< TDataType > & rThisVariable )

inline

◆ operator()() [2/4]

template<class TDataType >

const TDataType& Kratos::VariablesListDataValueContainer::operator() ( const Variable< TDataType > & rThisVariable ) const

inline

◆ operator()() [3/4]

template<class TDataType >

TDataType& Kratos::VariablesListDataValueContainer::operator()	(	const Variable< TDataType > &	rThisVariable,
		SizeType	QueueIndex
	)

inline

◆ operator()() [4/4]

template<class TDataType >

const TDataType& Kratos::VariablesListDataValueContainer::operator()	(	const Variable< TDataType > &	rThisVariable,
		SizeType	QueueIndex
	)		const

inline

◆ operator=()

VariablesListDataValueContainer& Kratos::VariablesListDataValueContainer::operator= ( const VariablesListDataValueContainer & rOther )

inline

Assignment operator.

◆ operator[]() [1/2]

template<class TDataType >

TDataType& Kratos::VariablesListDataValueContainer::operator[] ( const Variable< TDataType > & rThisVariable )

inline

◆ operator[]() [2/2]

template<class TDataType >

const TDataType& Kratos::VariablesListDataValueContainer::operator[] ( const Variable< TDataType > & rThisVariable ) const

inline

◆ pFastGetValue() [1/2]

template<class TDataType >

TDataType* Kratos::VariablesListDataValueContainer::pFastGetValue ( const Variable< TDataType > & rThisVariable )

inline

◆ pFastGetValue() [2/2]

template<class TDataType >

const TDataType* Kratos::VariablesListDataValueContainer::pFastGetValue ( const Variable< TDataType > & rThisVariable ) const

inline

◆ pGetVariablesList() [1/2]

VariablesList::Pointer Kratos::VariablesListDataValueContainer::pGetVariablesList ( )

inline

◆ pGetVariablesList() [2/2]

const VariablesList::Pointer Kratos::VariablesListDataValueContainer::pGetVariablesList ( ) const

inline

◆ PrintData()

void Kratos::VariablesListDataValueContainer::PrintData ( std::ostream & rOStream ) const

inline

Print object's data.

◆ PrintInfo()

void Kratos::VariablesListDataValueContainer::PrintInfo ( std::ostream & rOStream ) const

inline

Print information about this object.

◆ PushFront()

void Kratos::VariablesListDataValueContainer::PushFront ( )

inline

◆ QueueSize()

SizeType Kratos::VariablesListDataValueContainer::QueueSize ( ) const

inline

◆ Resize()

void Kratos::VariablesListDataValueContainer::Resize ( SizeType NewSize )

inline

◆ SetValue() [1/2]

template<class TDataType >

void Kratos::VariablesListDataValueContainer::SetValue	(	const Variable< TDataType > &	rThisVariable,
		TDataType const &	rValue
	)

inline

◆ SetValue() [2/2]

template<class TDataType >

void Kratos::VariablesListDataValueContainer::SetValue	(	const Variable< TDataType > &	rThisVariable,
		TDataType const &	rValue,
		SizeType	QueueIndex
	)

inline

◆ SetVariablesList() [1/2]

void Kratos::VariablesListDataValueContainer::SetVariablesList ( VariablesList::Pointer pVariablesList )

inline

◆ SetVariablesList() [2/2]

void Kratos::VariablesListDataValueContainer::SetVariablesList	(	VariablesList::Pointer	pVariablesList,
		SizeType	ThisQueueSize
	)

inline

◆ Size()

SizeType Kratos::VariablesListDataValueContainer::Size ( ) const

inline

◆ TotalDataSize()

SizeType Kratos::VariablesListDataValueContainer::TotalDataSize ( )

inline

◆ TotalSize()

SizeType Kratos::VariablesListDataValueContainer::TotalSize ( ) const

inline

Friends And Related Function Documentation

◆ Serializer

friend class Serializer

friend

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

/home/runner/work/Documentation/Documentation/master/kratos/containers/variables_list_data_value_container.h

Public Member Functions

Type Definitions

Serialization

Detailed Description

Member Typedef Documentation

◆ BlockType

◆ ContainerType

◆ IndexType

◆ SizeType

Constructor & Destructor Documentation

◆ VariablesListDataValueContainer() [1/4]

◆ VariablesListDataValueContainer() [2/4]

◆ VariablesListDataValueContainer() [3/4]

◆ VariablesListDataValueContainer() [4/4]

◆ ~VariablesListDataValueContainer()

Member Function Documentation

◆ AssignData()

◆ AssignZero() [1/2]

◆ AssignZero() [2/2]

◆ Clear()

◆ CloneFront()

◆ Data() [1/4]

◆ Data() [2/4]

◆ Data() [3/4]

◆ Data() [4/4]

◆ DataSize()

◆ FastGetCurrentValue() [1/2]

◆ FastGetCurrentValue() [2/2]

◆ FastGetValue() [1/6]

◆ FastGetValue() [2/6]

◆ FastGetValue() [3/6]

◆ FastGetValue() [4/6]

◆ FastGetValue() [5/6]

◆ FastGetValue() [6/6]

◆ GetValue() [1/4]

◆ GetValue() [2/4]

◆ GetValue() [3/4]

◆ GetValue() [4/4]

◆ GetVariablesList() [1/2]

◆ GetVariablesList() [2/2]

◆ Has()

◆ Info()

◆ IsEmpty()

◆ KRATOS_CLASS_POINTER_DEFINITION()

◆ operator()() [1/4]

◆ operator()() [2/4]

◆ operator()() [3/4]

◆ operator()() [4/4]

◆ operator=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ pFastGetValue() [1/2]

◆ pFastGetValue() [2/2]

◆ pGetVariablesList() [1/2]

◆ pGetVariablesList() [2/2]

◆ PrintData()

◆ PrintInfo()

◆ PushFront()

◆ QueueSize()

◆ Resize()

◆ SetValue() [1/2]

◆ SetValue() [2/2]

◆ SetVariablesList() [1/2]

◆ SetVariablesList() [2/2]

◆ Size()

◆ TotalDataSize()

◆ TotalSize()

Friends And Related Function Documentation

◆ Serializer