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::Table< double, double > Class Reference
Kratos Core

#include <table.h>

Collaboration diagram for Kratos::Table< double, double >:

Public Member Functions

Life Cycle
 Table ()=default
 
template<class TMatrixType >
 Table (TMatrixType const &ThisMatrix)
 Matrix constructor. the template parameter must have (i,j) access operator and size1 methods defined. More...
 
virtual ~Table ()=default
 
Operators
TResultType operator() (TArgumentType const &X) const
 
TResultType const & operator[] (TArgumentType const &X) const
 
TResultType & operator[] (TArgumentType &X)
 
Operations
TResultType GetValue (TArgumentType const &X) const
 
result_row_type & GetNearestRow (TArgumentType const &X)
 
TResultType const & GetNearestValue (TArgumentType const &X) const
 
TResultType & GetNearestValue (TArgumentType const &X)
 
TResultType & Interpolate (TArgumentType const &X, TArgumentType const &X1, TResultType const &Y1, TArgumentType const &X2, TResultType const &Y2, TResultType &Result) const
 
void insert (TArgumentType const &X, TResultType const &Y)
 
void insert (TArgumentType const &X, result_row_type const &Y)
 
void PushBack (TArgumentType const &X, TResultType const &Y)
 
TResultType GetDerivative (TArgumentType const &X) const
 
TResultType & InterpolateDerivative (TArgumentType const &X1, TResultType const &Y1, TArgumentType const &X2, TResultType const &Y2, TResultType &Result) const
 
void Clear ()
 This method clears database. More...
 
Access
TableContainerType & Data ()
 
TableContainerType const & Data () const
 
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...
 
const std::string & NameOfX () const
 
const std::string & NameOfY () const
 
void SetNameOfX (const std::string &name)
 
void SetNameOfY (const std::string &name)
 

Type Definitions

typedef double TResultType
 
typedef double TArgumentType
 
typedef std::array< TResultType, 1 > result_row_type
 
typedef std::pair< TArgumentType, result_row_type > RecordType
 
typedef std::vector< RecordType > TableContainerType
 
typedef Variable< TArgumentType > XVariableType
 
typedef Variable< TResultType > YVariableType
 
 KRATOS_CLASS_POINTER_DEFINITION (Table)
 Pointer definition of Table. More...
 

Serialization

class Serializer
 

Member Typedef Documentation

◆ RecordType

typedef std::pair<TArgumentType, result_row_type> Kratos::Table< double, double >::RecordType

◆ result_row_type

typedef std::array<TResultType, 1> Kratos::Table< double, double >::result_row_type

◆ TableContainerType

typedef std::vector<RecordType> Kratos::Table< double, double >::TableContainerType

◆ TArgumentType

typedef double Kratos::Table< double, double >::TArgumentType

◆ TResultType

typedef double Kratos::Table< double, double >::TResultType

◆ XVariableType

typedef Variable<TArgumentType> Kratos::Table< double, double >::XVariableType

◆ YVariableType

typedef Variable<TResultType> Kratos::Table< double, double >::YVariableType

Constructor & Destructor Documentation

◆ Table() [1/2]

Kratos::Table< double, double >::Table ( )
default

◆ Table() [2/2]

template<class TMatrixType >
Kratos::Table< double, double >::Table ( TMatrixType const &  ThisMatrix)
inlineexplicit

Matrix constructor. the template parameter must have (i,j) access operator and size1 methods defined.

◆ ~Table()

virtual Kratos::Table< double, double >::~Table ( )
virtualdefault

Member Function Documentation

◆ Clear()

void Kratos::Table< double, double >::Clear ( )
inline

This method clears database.

◆ Data() [1/2]

TableContainerType& Kratos::Table< double, double >::Data ( )
inline

◆ Data() [2/2]

TableContainerType const& Kratos::Table< double, double >::Data ( ) const
inline

◆ GetDerivative()

TResultType Kratos::Table< double, double >::GetDerivative ( TArgumentType const &  X) const
inline

◆ GetNearestRow()

result_row_type& Kratos::Table< double, double >::GetNearestRow ( TArgumentType const &  X)
inline

◆ GetNearestValue() [1/2]

TResultType& Kratos::Table< double, double >::GetNearestValue ( TArgumentType const &  X)
inline

◆ GetNearestValue() [2/2]

TResultType const& Kratos::Table< double, double >::GetNearestValue ( TArgumentType const &  X) const
inline

◆ GetValue()

TResultType Kratos::Table< double, double >::GetValue ( TArgumentType const &  X) const
inline

◆ Info()

virtual std::string Kratos::Table< double, double >::Info ( ) const
inlinevirtual

Turn back information as a string.

◆ insert() [1/2]

void Kratos::Table< double, double >::insert ( TArgumentType const &  X,
result_row_type const &  Y 
)
inline

◆ insert() [2/2]

void Kratos::Table< double, double >::insert ( TArgumentType const &  X,
TResultType const &  Y 
)
inline

◆ Interpolate()

TResultType& Kratos::Table< double, double >::Interpolate ( TArgumentType const &  X,
TArgumentType const &  X1,
TResultType const &  Y1,
TArgumentType const &  X2,
TResultType const &  Y2,
TResultType &  Result 
) const
inline

◆ InterpolateDerivative()

TResultType& Kratos::Table< double, double >::InterpolateDerivative ( TArgumentType const &  X1,
TResultType const &  Y1,
TArgumentType const &  X2,
TResultType const &  Y2,
TResultType &  Result 
) const
inline

◆ KRATOS_CLASS_POINTER_DEFINITION()

Kratos::Table< double, double >::KRATOS_CLASS_POINTER_DEFINITION ( Table< double, double >  )

Pointer definition of Table.

◆ NameOfX()

const std::string& Kratos::Table< double, double >::NameOfX ( ) const
inline

◆ NameOfY()

const std::string& Kratos::Table< double, double >::NameOfY ( ) const
inline

◆ operator()()

TResultType Kratos::Table< double, double >::operator() ( TArgumentType const &  X) const
inline

◆ operator[]() [1/2]

TResultType& Kratos::Table< double, double >::operator[] ( TArgumentType &  X)
inline

◆ operator[]() [2/2]

TResultType const& Kratos::Table< double, double >::operator[] ( TArgumentType const &  X) const
inline

◆ PrintData()

virtual void Kratos::Table< double, double >::PrintData ( std::ostream &  rOStream) const
inlinevirtual

Print object's data.

◆ PrintInfo()

virtual void Kratos::Table< double, double >::PrintInfo ( std::ostream &  rOStream) const
inlinevirtual

Print information about this object.

◆ PushBack()

void Kratos::Table< double, double >::PushBack ( TArgumentType const &  X,
TResultType const &  Y 
)
inline

◆ SetNameOfX()

void Kratos::Table< double, double >::SetNameOfX ( const std::string &  name)
inline

◆ SetNameOfY()

void Kratos::Table< double, double >::SetNameOfY ( const std::string &  name)
inline

Friends And Related Function Documentation

◆ Serializer

friend class Serializer
friend
The documentation for this class was generated from the following file:
Generated on Sat Feb 3 2024 02:51:28 for KratosMultiphysics by doxygen 1.9.1