KratosMultiphysics
KRATOS Multiphysics (Kratos) is a framework for building parallel, multi-disciplinary simulation software, aiming at modularity, extensibility, and high performance. Kratos is written in C++, and counts with an extensive Python interface.
List of all members
Kratos::TableKeyVariables< TArgumentType, TResultType > Class Template Reference

TableKeyVariables. More...

#include <table_key_variables.hpp>

Collaboration diagram for Kratos::TableKeyVariables< TArgumentType, TResultType >:

Public Member Functions

Life Cycle
 TableKeyVariables ()
 Default constructor. More...
 
 TableKeyVariables (const TableKeyVariables &rOther)
 Copy constructor. More...
 
TableKeyVariables::Pointer Clone () const
 Clone. More...
 
 ~TableKeyVariables ()
 Destructor. More...
 
Operations
void RegisterTable (const XVariableType &rXVariable, const YVariableType &rYVariable)
 
const XVariableTypeGetXVariable (int64_t rTableKey) const
 
const YVariableTypeGetYVariable (int64_t rTableKey) 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 Variable< TArgumentType > XVariableType
 
typedef Variable< TResultType > YVariableType
 
typedef std::pair< const XVariableType *, const YVariableType * > TableVariablesType
 
typedef std::vector< TableVariablesTypeTableVariablesContainerType
 
 KRATOS_CLASS_POINTER_DEFINITION (TableKeyVariables)
 Pointer definition of TableKeyVariables. More...
 

Serialization

class Serializer
 

Detailed Description

template<class TArgumentType, class TResultType = TArgumentType>
class Kratos::TableKeyVariables< TArgumentType, TResultType >

TableKeyVariables.

Configures the variables set in the tables of the properties

Member Typedef Documentation

◆ TableVariablesContainerType

template<class TArgumentType , class TResultType = TArgumentType>
typedef std::vector<TableVariablesType> Kratos::TableKeyVariables< TArgumentType, TResultType >::TableVariablesContainerType

◆ TableVariablesType

template<class TArgumentType , class TResultType = TArgumentType>
typedef std::pair<const XVariableType*, const YVariableType*> Kratos::TableKeyVariables< TArgumentType, TResultType >::TableVariablesType

◆ XVariableType

template<class TArgumentType , class TResultType = TArgumentType>
typedef Variable<TArgumentType> Kratos::TableKeyVariables< TArgumentType, TResultType >::XVariableType

◆ YVariableType

template<class TArgumentType , class TResultType = TArgumentType>
typedef Variable<TResultType> Kratos::TableKeyVariables< TArgumentType, TResultType >::YVariableType

Constructor & Destructor Documentation

◆ TableKeyVariables() [1/2]

template<class TArgumentType , class TResultType = TArgumentType>
Kratos::TableKeyVariables< TArgumentType, TResultType >::TableKeyVariables ( )
inline

Default constructor.

◆ TableKeyVariables() [2/2]

template<class TArgumentType , class TResultType = TArgumentType>
Kratos::TableKeyVariables< TArgumentType, TResultType >::TableKeyVariables ( const TableKeyVariables< TArgumentType, TResultType > &  rOther)
inline

Copy constructor.

◆ ~TableKeyVariables()

template<class TArgumentType , class TResultType = TArgumentType>
Kratos::TableKeyVariables< TArgumentType, TResultType >::~TableKeyVariables ( )
inline

Destructor.

Member Function Documentation

◆ Clone()

template<class TArgumentType , class TResultType = TArgumentType>
TableKeyVariables::Pointer Kratos::TableKeyVariables< TArgumentType, TResultType >::Clone ( ) const
inline

Clone.

◆ GetXVariable()

template<class TArgumentType , class TResultType = TArgumentType>
const XVariableType& Kratos::TableKeyVariables< TArgumentType, TResultType >::GetXVariable ( int64_t  rTableKey) const
inline

◆ GetYVariable()

template<class TArgumentType , class TResultType = TArgumentType>
const YVariableType& Kratos::TableKeyVariables< TArgumentType, TResultType >::GetYVariable ( int64_t  rTableKey) const
inline

◆ Info()

template<class TArgumentType , class TResultType = TArgumentType>
std::string Kratos::TableKeyVariables< TArgumentType, TResultType >::Info ( ) const
inline

Turn back information as a string.

◆ KRATOS_CLASS_POINTER_DEFINITION()

template<class TArgumentType , class TResultType = TArgumentType>
Kratos::TableKeyVariables< TArgumentType, TResultType >::KRATOS_CLASS_POINTER_DEFINITION ( TableKeyVariables< TArgumentType, TResultType >  )

Pointer definition of TableKeyVariables.

◆ PrintData()

template<class TArgumentType , class TResultType = TArgumentType>
void Kratos::TableKeyVariables< TArgumentType, TResultType >::PrintData ( std::ostream &  rOStream) const
inline

Print object's data.

◆ PrintInfo()

template<class TArgumentType , class TResultType = TArgumentType>
void Kratos::TableKeyVariables< TArgumentType, TResultType >::PrintInfo ( std::ostream &  rOStream) const
inline

Print information about this object.

◆ RegisterTable()

template<class TArgumentType , class TResultType = TArgumentType>
void Kratos::TableKeyVariables< TArgumentType, TResultType >::RegisterTable ( const XVariableType rXVariable,
const YVariableType rYVariable 
)
inline

Friends And Related Function Documentation

◆ Serializer

template<class TArgumentType , class TResultType = TArgumentType>
friend class Serializer
friend

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