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

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

#include <accessor.h>

Inheritance diagram for Kratos::Accessor:
Collaboration diagram for Kratos::Accessor:

Public Member Functions

Life Cycle
 Accessor ()=default
 Default constructor. More...
 
virtual ~Accessor ()=default
 Destructor. More...
 
 Accessor (const Accessor &rOther)
 Copy constructor. More...
 
Operations
virtual double GetValue (const Variable< double > &rVariable, const Properties &rProperties, const GeometryType &rGeometry, const Vector &rShapeFunctionVector, const ProcessInfo &rProcessInfo) const
 Custom method to retrieve double type properties. 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...
 
virtual Accessor::UniquePointer Clone () 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...
 

Type Definitions

using GeometryType = Geometry< Node >
 Geometry type definition. More...
 
 KRATOS_CLASS_POINTER_DEFINITION (Accessor)
 Pointer definition of Accessor. More...
 

Member Variables

class Serializer
 

Detailed Description

This class defines the way a certain property is accessed.

Author
Alejandro Cornejo, Riccardo Rossi and Carlos Roig

Member Typedef Documentation

◆ GeometryType

Geometry type definition.

Constructor & Destructor Documentation

◆ Accessor() [1/2]

Kratos::Accessor::Accessor ( )
default

Default constructor.

◆ ~Accessor()

virtual Kratos::Accessor::~Accessor ( )
virtualdefault

Destructor.

◆ Accessor() [2/2]

Kratos::Accessor::Accessor ( const Accessor rOther)
inline

Copy constructor.

Member Function Documentation

◆ Clone()

Accessor::UniquePointer Kratos::Accessor::Clone ( ) const
virtual

Reimplemented in Kratos::TableAccessor.

◆ GetValue() [1/10]

array_1d< double, 3 > Kratos::Accessor::GetValue ( const Variable< array_1d< double, 3 >> &  rVariable,
const Properties rProperties,
const GeometryType rGeometry,
const Vector rShapeFunctionVector,
const ProcessInfo rProcessInfo 
) const
virtual

Custom method to retrieve array_1d<double, 3 > type properties.

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

◆ GetValue() [2/10]

array_1d< double, 4 > Kratos::Accessor::GetValue ( const Variable< array_1d< double, 4 >> &  rVariable,
const Properties rProperties,
const GeometryType rGeometry,
const Vector rShapeFunctionVector,
const ProcessInfo rProcessInfo 
) const
virtual

Custom method to retrieve array_1d<double, 6 > type properties.

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

◆ GetValue() [3/10]

array_1d< double, 6 > Kratos::Accessor::GetValue ( const Variable< array_1d< double, 6 >> &  rVariable,
const Properties rProperties,
const GeometryType rGeometry,
const Vector rShapeFunctionVector,
const ProcessInfo rProcessInfo 
) const
virtual

Custom method to retrieve array_1d<double, 6 > type properties.

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

◆ GetValue() [4/10]

array_1d< double, 9 > Kratos::Accessor::GetValue ( const Variable< array_1d< double, 9 >> &  rVariable,
const Properties rProperties,
const GeometryType rGeometry,
const Vector rShapeFunctionVector,
const ProcessInfo rProcessInfo 
) const
virtual

Custom method to retrieve array_1d<double, 6 > type properties.

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

◆ GetValue() [5/10]

bool Kratos::Accessor::GetValue ( const Variable< bool > &  rVariable,
const Properties rProperties,
const GeometryType rGeometry,
const Vector rShapeFunctionVector,
const ProcessInfo rProcessInfo 
) const
virtual

Custom method to retrieve bool type properties.

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

◆ GetValue() [6/10]

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

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 in Kratos::TableAccessor.

◆ GetValue() [7/10]

int Kratos::Accessor::GetValue ( const Variable< int > &  rVariable,
const Properties rProperties,
const GeometryType rGeometry,
const Vector rShapeFunctionVector,
const ProcessInfo rProcessInfo 
) const
virtual

Custom method to retrieve int type properties.

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

◆ GetValue() [8/10]

Matrix Kratos::Accessor::GetValue ( const Variable< Matrix > &  rVariable,
const Properties rProperties,
const GeometryType rGeometry,
const Vector rShapeFunctionVector,
const ProcessInfo rProcessInfo 
) const
virtual

Custom method to retrieve Matrix type properties.

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

◆ GetValue() [9/10]

std::string Kratos::Accessor::GetValue ( const Variable< std::string > &  rVariable,
const Properties rProperties,
const GeometryType rGeometry,
const Vector rShapeFunctionVector,
const ProcessInfo rProcessInfo 
) const
virtual

Custom method to retrieve string type properties.

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

◆ GetValue() [10/10]

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

Custom method to retrieve Vector type properties.

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

◆ Info()

virtual std::string Kratos::Accessor::Info ( ) const
inlinevirtual

Turn back information as a string.

Reimplemented in Kratos::TableAccessor.

◆ KRATOS_CLASS_POINTER_DEFINITION()

Kratos::Accessor::KRATOS_CLASS_POINTER_DEFINITION ( Accessor  )

Pointer definition of Accessor.

◆ PrintData()

virtual void Kratos::Accessor::PrintData ( std::ostream &  rOStream) const
inlinevirtual

Print object's data.

Reimplemented in Kratos::TableAccessor.

◆ PrintInfo()

virtual void Kratos::Accessor::PrintInfo ( std::ostream &  rOStream) const
inlinevirtual

Print information about this object.

Reimplemented in Kratos::TableAccessor.

Friends And Related Function Documentation

◆ Serializer

friend class Serializer
friend

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