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::TableAccessor Class Reference

This class defines the way a certain property is accessed according to a table. More...

#include <table_accessor.h>

Inheritance diagram for Kratos::TableAccessor:
Collaboration diagram for Kratos::TableAccessor:

Public Member Functions

Life Cycle
 TableAccessor ()
 
 TableAccessor (VariableType &rInputVariable, const std::string &rInputVariableType="node_historical")
 Custom constructor. More...
 
 TableAccessor (const TableAccessor &rOther)
 Copy constructor. More...
 
Operations
double GetValue (const Variable< double > &rVariable, const Properties &rProperties, const GeometryType &rGeometry, const Vector &rShapeFunctionVector, const ProcessInfo &rProcessInfo) const override
 Custom method to retrieve double type properties. More...
 
double GetValueFromTable (const Variable< double > &rIndependentVariable, const Variable< double > &rDependentVariable, const Properties &rProperties, const GeometryType &rGeometry, const Vector &rShapeFunctionVector, const ProcessInfo &rProcessInfo) const
 This computes a material property according to a certain nodal Variable<double> table. More...
 
VariableTypeGetInputVariable () const
 Returns the member input variable. More...
 
Accessor::UniquePointer Clone () const override
 
Input and output
std::string Info () const override
 Turn back information as a string. More...
 
void PrintInfo (std::ostream &rOStream) const override
 Print information about this object. More...
 
void PrintData (std::ostream &rOStream) const override
 Print object's data. More...
 
- Public Member Functions inherited from Kratos::Accessor
 Accessor ()=default
 Default constructor. More...
 
virtual ~Accessor ()=default
 Destructor. More...
 
 Accessor (const Accessor &rOther)
 Copy constructor. More...
 
virtual Vector GetValue (const Variable< Vector > &rVariable, const Properties &rProperties, const GeometryType &rGeometry, const Vector &rShapeFunctionVector, const ProcessInfo &rProcessInfo) const
 Custom method to retrieve Vector type properties. More...
 
virtual bool GetValue (const Variable< bool > &rVariable, const Properties &rProperties, const GeometryType &rGeometry, const Vector &rShapeFunctionVector, const ProcessInfo &rProcessInfo) const
 Custom method to retrieve bool type properties. More...
 
virtual int GetValue (const Variable< int > &rVariable, const Properties &rProperties, const GeometryType &rGeometry, const Vector &rShapeFunctionVector, const ProcessInfo &rProcessInfo) const
 Custom method to retrieve int type properties. More...
 
virtual Matrix GetValue (const Variable< Matrix > &rVariable, const Properties &rProperties, const GeometryType &rGeometry, const Vector &rShapeFunctionVector, const ProcessInfo &rProcessInfo) const
 Custom method to retrieve Matrix type properties. More...
 
virtual array_1d< double, 3 > GetValue (const Variable< array_1d< double, 3 >> &rVariable, const Properties &rProperties, const GeometryType &rGeometry, const Vector &rShapeFunctionVector, const ProcessInfo &rProcessInfo) const
 Custom method to retrieve array_1d<double, 3 > type properties. More...
 
virtual array_1d< double, 6 > GetValue (const Variable< array_1d< double, 6 >> &rVariable, const Properties &rProperties, const GeometryType &rGeometry, const Vector &rShapeFunctionVector, const ProcessInfo &rProcessInfo) const
 Custom method to retrieve array_1d<double, 6 > type properties. More...
 
virtual array_1d< double, 4 > GetValue (const Variable< array_1d< double, 4 >> &rVariable, const Properties &rProperties, const GeometryType &rGeometry, const Vector &rShapeFunctionVector, const ProcessInfo &rProcessInfo) const
 Custom method to retrieve array_1d<double, 6 > type properties. More...
 
virtual array_1d< double, 9 > GetValue (const Variable< array_1d< double, 9 >> &rVariable, const Properties &rProperties, const GeometryType &rGeometry, const Vector &rShapeFunctionVector, const ProcessInfo &rProcessInfo) const
 Custom method to retrieve array_1d<double, 6 > type properties. More...
 
virtual std::string GetValue (const Variable< std::string > &rVariable, const Properties &rProperties, const GeometryType &rGeometry, const Vector &rShapeFunctionVector, const ProcessInfo &rProcessInfo) const
 Custom method to retrieve string type properties. More...
 
 KRATOS_CLASS_POINTER_DEFINITION (Accessor)
 Pointer definition of Accessor. More...
 

Type Definitions

using GeometryType = Geometry< Node >
 Geometry type definition. More...
 
using VariableType = Variable< double >
 Variable type. More...
 
using BaseType = Accessor
 BaseType. More...
 
using DataLocation = Globals::DataLocation
 
using SizeType = std::size_t
 
 KRATOS_CLASS_POINTER_DEFINITION (TableAccessor)
 Pointer definition of TableAccessor. More...
 

Member Variables

class Serializer
 

Additional Inherited Members

- Public Types inherited from Kratos::Accessor
using GeometryType = Geometry< Node >
 Geometry type definition. More...
 

Detailed Description

This class defines the way a certain property is accessed according to a table.

The tables are supposed to relate double <-> double type entities.

The input variable is suposed to be a nodally accesible one (either historical or not)

Author
Alejandro Cornejo, Riccardo Rossi, Carlos Roig and Ruben Zorrilla

Member Typedef Documentation

◆ BaseType

BaseType.

◆ DataLocation

◆ GeometryType

Geometry type definition.

◆ SizeType

using Kratos::TableAccessor::SizeType = std::size_t

◆ VariableType

Variable type.

Constructor & Destructor Documentation

◆ TableAccessor() [1/3]

Kratos::TableAccessor::TableAccessor ( )
inline

◆ TableAccessor() [2/3]

Kratos::TableAccessor::TableAccessor ( VariableType rInputVariable,
const std::string &  rInputVariableType = "node_historical" 
)
inline

Custom constructor.

◆ TableAccessor() [3/3]

Kratos::TableAccessor::TableAccessor ( const TableAccessor rOther)
inline

Copy constructor.

Member Function Documentation

◆ Clone()

Accessor::UniquePointer Kratos::TableAccessor::Clone ( ) const
overridevirtual

Reimplemented from Kratos::Accessor.

◆ GetInputVariable()

VariableType& Kratos::TableAccessor::GetInputVariable ( ) const
inline

Returns the member input variable.

◆ GetValue()

double Kratos::TableAccessor::GetValue ( const Variable< double > &  rVariable,
const Properties rProperties,
const GeometryType rGeometry,
const Vector rShapeFunctionVector,
const ProcessInfo rProcessInfo 
) const
overridevirtual

Custom method to retrieve double type properties.

Parameters
rVariableThe variable considered (double type properties)
rPropertiesThe properties considered
rGeometryThe geometry considered
rShapeFunctionVectorThe shape function of the GP considered
rProcessInfoThe process info considered
Returns
The double type properties

Reimplemented from Kratos::Accessor.

◆ GetValueFromTable()

double Kratos::TableAccessor::GetValueFromTable ( const Variable< double > &  rIndependentVariable,
const Variable< double > &  rDependentVariable,
const Properties rProperties,
const GeometryType rGeometry,
const Vector rShapeFunctionVector,
const ProcessInfo rProcessInfo 
) const

This computes a material property according to a certain nodal Variable<double> table.

◆ Info()

std::string Kratos::TableAccessor::Info ( ) const
inlineoverridevirtual

Turn back information as a string.

Reimplemented from Kratos::Accessor.

◆ KRATOS_CLASS_POINTER_DEFINITION()

Kratos::TableAccessor::KRATOS_CLASS_POINTER_DEFINITION ( TableAccessor  )

Pointer definition of TableAccessor.

◆ PrintData()

void Kratos::TableAccessor::PrintData ( std::ostream &  rOStream) const
inlineoverridevirtual

Print object's data.

Reimplemented from Kratos::Accessor.

◆ PrintInfo()

void Kratos::TableAccessor::PrintInfo ( std::ostream &  rOStream) const
inlineoverridevirtual

Print information about this object.

Reimplemented from Kratos::Accessor.

Friends And Related Function Documentation

◆ Serializer

friend class Serializer
friend

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