Kratos::VariablesList Class Reference

Holds a list of variables and their position in VariablesListDataValueContainer. More...

#include <variables_list.h>

Collaboration diagram for Kratos::VariablesList:

Public Member Functions
Life Cycle
	VariablesList ()
	Default constructor. mPosition should have at least on entry. More...
template<class TInputIteratorType >
	VariablesList (TInputIteratorType First, TInputIteratorType Last)
	VariablesList (VariablesList const &rOther)
	Copy constructor. More...
	~VariablesList ()
	Destructor. More...
Operators
VariablesList &	operator= (VariablesList const &rOther)
	Assignment operator. More...
IndexType	operator() (IndexType VariableKey) const
template<class TDataType >
IndexType	operator() (Variable< TDataType > const &ThisVariable) const
const VariableData *	operator[] (IndexType Index) const
bool	operator== (const VariablesList &r) const
unsigned int	use_count () const noexcept
Operations
const_iterator	begin () const
const_iterator	end () const
const_reverse_iterator	rbegin () const
const_reverse_iterator	rend () const
ptr_const_iterator	ptr_begin () const
ptr_const_iterator	ptr_end () const
ptr_const_reverse_iterator	ptr_rbegin () const
ptr_const_reverse_iterator	ptr_rend () const
const_reference	front () const
const_reference	back () const
size_type	size () const
size_type	max_size () const
void	swap (VariablesList &rOther)
template<class TOtherDataType >
void	push_back (TOtherDataType const &x)
void	clear ()
void	Add (VariableData const &ThisVariable)
int	AddDof (VariableData const *pThisDofVariable)
int	AddDof (VariableData const *pThisDofVariable, VariableData const *pThisDofReaction)
const VariableData &	GetDofVariable (int DofIndex) const
const VariableData *	pGetDofReaction (int DofIndex) const
void	SetDofReaction (VariableData const *pThisDofReaction, int DofIndex)
IndexType	Index (IndexType VariableKey) const
template<class TDataType >
IndexType	Index (Variable< TDataType > const &ThisVariable) const
IndexType	Index (const VariableData *pThisVariable) const
Access
SizeType	DataSize () const
VariablesContainerType const &	Variables ()
Inquiry
bool	Has (const VariableData &rThisVariable) const
bool	IsEmpty () const
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
typedef std::size_t	SizeType
typedef std::size_t	IndexType
typedef double	BlockType
typedef std::vector< IndexType >	KeysContainerType
typedef std::vector< IndexType >	PositionsContainerType
typedef std::vector< const VariableData * >	VariablesContainerType
typedef VariableData	data_type
typedef const VariableData *	value_type
typedef const VariableData *	const_pointer
typedef VariableData const &	const_reference
typedef boost::indirect_iterator< VariablesContainerType::const_iterator >	const_iterator
typedef boost::indirect_iterator< VariablesContainerType::const_reverse_iterator >	const_reverse_iterator
typedef VariablesContainerType::size_type	size_type
typedef VariablesContainerType::const_iterator	ptr_const_iterator
typedef VariablesContainerType::const_reverse_iterator	ptr_const_reverse_iterator
typedef VariablesContainerType::difference_type	difference_type
	KRATOS_CLASS_INTRUSIVE_POINTER_DEFINITION (VariablesList)
	Pointer definition of VariablesList. More...

Private Operators
void	intrusive_ptr_add_ref (const VariablesList *x)
void	intrusive_ptr_release (const VariablesList *x)

Serialization
class	Serializer

Detailed Description

Holds a list of variables and their position in VariablesListDataValueContainer.

This class works tightly with VariablesListDataValueContainer and provides the the positions of variables for that containers

Member Typedef Documentation

BlockType

typedef double Kratos::VariablesList::BlockType

const_iterator

typedef boost::indirect_iterator<VariablesContainerType::const_iterator> Kratos::VariablesList::const_iterator

const_pointer

typedef const VariableData* Kratos::VariablesList::const_pointer

const_reference

typedef VariableData const& Kratos::VariablesList::const_reference

const_reverse_iterator

typedef boost::indirect_iterator<VariablesContainerType::const_reverse_iterator> Kratos::VariablesList::const_reverse_iterator

data_type

typedef VariableData Kratos::VariablesList::data_type

difference_type

typedef VariablesContainerType::difference_type Kratos::VariablesList::difference_type

IndexType

typedef std::size_t Kratos::VariablesList::IndexType

KeysContainerType

typedef std::vector<IndexType> Kratos::VariablesList::KeysContainerType

PositionsContainerType

typedef std::vector<IndexType> Kratos::VariablesList::PositionsContainerType

ptr_const_iterator

typedef VariablesContainerType::const_iterator Kratos::VariablesList::ptr_const_iterator

ptr_const_reverse_iterator

typedef VariablesContainerType::const_reverse_iterator Kratos::VariablesList::ptr_const_reverse_iterator

size_type

typedef VariablesContainerType::size_type Kratos::VariablesList::size_type

SizeType

typedef std::size_t Kratos::VariablesList::SizeType

value_type

typedef const VariableData* Kratos::VariablesList::value_type

VariablesContainerType

typedef std::vector<const VariableData*> Kratos::VariablesList::VariablesContainerType

Constructor & Destructor Documentation

VariablesList() [1/3]

Kratos::VariablesList::VariablesList ( )

inline

Default constructor. mPosition should have at least on entry.

VariablesList() [2/3]

template<class TInputIteratorType >

Kratos::VariablesList::VariablesList ( TInputIteratorType  First, TInputIteratorType  Last  )

inline

VariablesList() [3/3]

Kratos::VariablesList::VariablesList ( VariablesList const &  rOther )

inline

Copy constructor.

~VariablesList()

Kratos::VariablesList::~VariablesList ( )

inline

Destructor.

Member Function Documentation

Add()

void Kratos::VariablesList::Add ( VariableData const &  ThisVariable )

inline

AddDof() [1/2]

int Kratos::VariablesList::AddDof ( VariableData const *  pThisDofVariable )

inline

AddDof() [2/2]

int Kratos::VariablesList::AddDof ( VariableData const *  pThisDofVariable, VariableData const *  pThisDofReaction  )

inline

back()

const_reference Kratos::VariablesList::back ( ) const

inline

begin()

const_iterator Kratos::VariablesList::begin ( ) const

inline

clear()

void Kratos::VariablesList::clear ( )

inline

DataSize()

SizeType Kratos::VariablesList::DataSize ( ) const

inline

end()

const_iterator Kratos::VariablesList::end ( ) const

inline

front()

const_reference Kratos::VariablesList::front ( ) const

inline

GetDofVariable()

const VariableData& Kratos::VariablesList::GetDofVariable ( int  DofIndex ) const

inline

Has()

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

inline

Index() [1/3]

IndexType Kratos::VariablesList::Index ( const VariableData *  pThisVariable ) const

inline

Index() [2/3]

IndexType Kratos::VariablesList::Index ( IndexType  VariableKey ) const

inline

Index() [3/3]

template<class TDataType >

IndexType Kratos::VariablesList::Index ( Variable< TDataType > const &  ThisVariable ) const

inline

Info()

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

inline

Turn back information as a string.

IsEmpty()

bool Kratos::VariablesList::IsEmpty ( ) const

inline

KRATOS_CLASS_INTRUSIVE_POINTER_DEFINITION()

Kratos::VariablesList::KRATOS_CLASS_INTRUSIVE_POINTER_DEFINITION

(

VariablesList

)

Pointer definition of VariablesList.

max_size()

size_type Kratos::VariablesList::max_size ( ) const

inline

operator()() [1/2]

IndexType Kratos::VariablesList::operator() ( IndexType  VariableKey ) const

inline

operator()() [2/2]

template<class TDataType >

IndexType Kratos::VariablesList::operator() ( Variable< TDataType > const &  ThisVariable ) const

inline

operator=()

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

inline

Assignment operator.

operator==()

bool Kratos::VariablesList::operator== ( const VariablesList &  r ) const

inline

operator[]()

const VariableData* Kratos::VariablesList::operator[] ( IndexType  Index ) const

inline

pGetDofReaction()

const VariableData* Kratos::VariablesList::pGetDofReaction ( int  DofIndex ) const

inline

PrintData()

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

inline

Print object's data.

PrintInfo()

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

inline

Print information about this object.

ptr_begin()

ptr_const_iterator Kratos::VariablesList::ptr_begin ( ) const

inline

ptr_end()

ptr_const_iterator Kratos::VariablesList::ptr_end ( ) const

inline

ptr_rbegin()

ptr_const_reverse_iterator Kratos::VariablesList::ptr_rbegin ( ) const

inline

ptr_rend()

ptr_const_reverse_iterator Kratos::VariablesList::ptr_rend ( ) const

inline

push_back()

template<class TOtherDataType >

void Kratos::VariablesList::push_back ( TOtherDataType const &  x )

inline

rbegin()

const_reverse_iterator Kratos::VariablesList::rbegin ( ) const

inline

rend()

const_reverse_iterator Kratos::VariablesList::rend ( ) const

inline

SetDofReaction()

void Kratos::VariablesList::SetDofReaction ( VariableData const *  pThisDofReaction, int  DofIndex  )

inline

size()

size_type Kratos::VariablesList::size ( ) const

inline

swap()

void Kratos::VariablesList::swap ( VariablesList &  rOther )

inline

use_count()

unsigned int Kratos::VariablesList::use_count ( ) const

inlinenoexcept

Variables()

VariablesContainerType const& Kratos::VariablesList::Variables ( )

inline

Friends And Related Function Documentation

intrusive_ptr_add_ref

void intrusive_ptr_add_ref ( const VariablesList *  x )

friend

intrusive_ptr_release

void intrusive_ptr_release ( const VariablesList *  x )

friend

Serializer

friend class Serializer

friend

---

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

• /home/runner/work/Documentation/Documentation/master/kratos/containers/variables_list.h
• /home/runner/work/Documentation/Documentation/master/kratos/containers/variables_list.cpp