Kratos::PeriodicVariablesContainer Class Reference

A container of Kratos variables used to define a periodic boundary condition. More...

#include <periodic_variables_container.h>

Collaboration diagram for Kratos::PeriodicVariablesContainer:

Public Member Functions
Life Cycle
	PeriodicVariablesContainer ()
	Default constructor. More...
	PeriodicVariablesContainer (PeriodicVariablesContainer const &rOther)
	Copy constructor. More...
	~PeriodicVariablesContainer ()
	Destructor. More...
Operators
PeriodicVariablesContainer &	operator= (PeriodicVariablesContainer const &rOther)
	Assignment operator. More...
Operations
void	Add (DoubleVariableType const &rThisVariable)
	Add a scalar variable to the list of variables where periodic conditions will be imposed. More...
void	Clear ()
	Erase all information contained in this object. More...
Access
DoubleVariablesConstIterator	DoubleVariablesBegin () const
	Iterator for the list of scalar variables. More...
DoubleVariablesConstIterator	DoubleVariablesEnd () const
	Iterator for the list of scalar variables. More...
SizeType	size () const
	Total number of periodic variables (including scalars and vector components) More...
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 Variable< double >	DoubleVariableType
	Kratos double Variable. More...
typedef std::vector< const DoubleVariableType * >	DoubleVariablesContainerType
	Container of pointers to Kratos double variables. More...
typedef boost::indirect_iterator< DoubleVariablesContainerType::const_iterator >	DoubleVariablesConstIterator
	Double Variable iterator. More...
typedef std::size_t	SizeType
	KRATOS_CLASS_POINTER_DEFINITION (PeriodicVariablesContainer)
	Pointer definition of PeriodicVariablesContainer. More...

Serialization
class	Serializer

Detailed Description

A container of Kratos variables used to define a periodic boundary condition.

It is used by PeriodicCondition to identify the Dofs where the periodic condition applies.

See also

PeriodicCondition

Member Typedef Documentation

DoubleVariablesConstIterator

typedef boost::indirect_iterator<DoubleVariablesContainerType::const_iterator> Kratos::PeriodicVariablesContainer::DoubleVariablesConstIterator

Double Variable iterator.

DoubleVariablesContainerType

typedef std::vector<const DoubleVariableType*> Kratos::PeriodicVariablesContainer::DoubleVariablesContainerType

Container of pointers to Kratos double variables.

DoubleVariableType

typedef Variable<double> Kratos::PeriodicVariablesContainer::DoubleVariableType

Kratos double Variable.

SizeType

typedef std::size_t Kratos::PeriodicVariablesContainer::SizeType

Constructor & Destructor Documentation

PeriodicVariablesContainer() [1/2]

Kratos::PeriodicVariablesContainer::PeriodicVariablesContainer ( )

inline

Default constructor.

PeriodicVariablesContainer() [2/2]

Kratos::PeriodicVariablesContainer::PeriodicVariablesContainer ( PeriodicVariablesContainer const &  rOther )

inline

Copy constructor.

~PeriodicVariablesContainer()

Kratos::PeriodicVariablesContainer::~PeriodicVariablesContainer ( )

inline

Destructor.

Member Function Documentation

Add()

void Kratos::PeriodicVariablesContainer::Add ( DoubleVariableType const &  rThisVariable )

inline

Add a scalar variable to the list of variables where periodic conditions will be imposed.

Clear()

void Kratos::PeriodicVariablesContainer::Clear ( )

inline

Erase all information contained in this object.

DoubleVariablesBegin()

DoubleVariablesConstIterator Kratos::PeriodicVariablesContainer::DoubleVariablesBegin ( ) const

inline

Iterator for the list of scalar variables.

DoubleVariablesEnd()

DoubleVariablesConstIterator Kratos::PeriodicVariablesContainer::DoubleVariablesEnd ( ) const

inline

Iterator for the list of scalar variables.

Info()

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

inline

Turn back information as a string.

KRATOS_CLASS_POINTER_DEFINITION()

Kratos::PeriodicVariablesContainer::KRATOS_CLASS_POINTER_DEFINITION

(

PeriodicVariablesContainer

)

Pointer definition of PeriodicVariablesContainer.

operator=()

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

inline

Assignment operator.

PrintData()

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

inline

Print object's data.

PrintInfo()

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

inline

Print information about this object.

size()

SizeType Kratos::PeriodicVariablesContainer::size ( ) const

inline

Total number of periodic variables (including scalars and vector components)

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/periodic_variables_container.h