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::StaticStepMethod< TVariableType, TValueType > Class Template Reference

Short class definition. More...

#include <static_step_method.hpp>

Inheritance diagram for Kratos::StaticStepMethod< TVariableType, TValueType >:
Collaboration diagram for Kratos::StaticStepMethod< TVariableType, TValueType >:

Public Member Functions

Life Cycle
 StaticStepMethod ()
 Default Constructor. More...
 
 StaticStepMethod (const TVariableType &rVariable)
 Constructor. More...
 
 StaticStepMethod (const TVariableType &rVariable, const TVariableType &rFirstDerivative, const TVariableType &rSecondDerivative)
 Constructor. More...
 
 StaticStepMethod (const TVariableType &rVariable, const TVariableType &rFirstDerivative, const TVariableType &rSecondDerivative, const TVariableType &rPrimaryVariable)
 Constructor. More...
 
 StaticStepMethod (StaticStepMethod &rOther)
 Copy Constructor. More...
 
BasePointerType Clone () override
 Clone. More...
 
 ~StaticStepMethod () override
 Destructor. More...
 
Operations
bool HasStepVariable () override
 
void SetStepVariable (const TVariableType &rStepVariable) override
 
void Assign (NodeType &rNode) override
 
void Predict (NodeType &rNode) override
 
void Update (NodeType &rNode) override
 
int Check (const ProcessInfo &rCurrentProcessInfo) override
 This function is designed to be called once to perform all the checks needed. More...
 
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::StaticMethod< TVariableType, TValueType >
 StaticMethod ()
 Default Constructor. More...
 
 StaticMethod (const TVariableType &rVariable)
 Constructor. More...
 
 StaticMethod (const TVariableType &rVariable, const TVariableType &rFirstDerivative, const TVariableType &rSecondDerivative)
 Constructor. More...
 
 StaticMethod (const TVariableType &rVariable, const TVariableType &rFirstDerivative, const TVariableType &rSecondDerivative, const TVariableType &rPrimaryVariable)
 Constructor. More...
 
 StaticMethod (StaticMethod &rOther)
 Copy Constructor. More...
 
 ~StaticMethod () override
 Destructor. More...
 
 KRATOS_CLASS_POINTER_DEFINITION (StaticMethod)
 
- Public Member Functions inherited from Kratos::TimeIntegrationMethod< TVariableType, TValueType >
 TimeIntegrationMethod ()
 Default Constructor. More...
 
 TimeIntegrationMethod (const TVariableType &rVariable)
 Constructor. More...
 
 TimeIntegrationMethod (const TVariableType &rVariable, const TVariableType &rFirstDerivative, const TVariableType &rSecondDerivative)
 Constructor. More...
 
 TimeIntegrationMethod (const TVariableType &rVariable, const TVariableType &rFirstDerivative, const TVariableType &rSecondDerivative, const TVariableType &rPrimaryVariable)
 Constructor. More...
 
 TimeIntegrationMethod (TimeIntegrationMethod &rOther)
 Copy Constructor. More...
 
 ~TimeIntegrationMethod () override
 Destructor. More...
 
virtual void CalculateParameters (ProcessInfo &rCurrentProcessInfo)
 
virtual void SetParameters (const ProcessInfo &rCurrentProcessInfo)
 
virtual void SetProcessInfoParameters (ProcessInfo &rCurrentProcessInfo)
 
void SetInputVariable (const TVariableType &rVariable)
 
std::string GetPrimaryVariableName ()
 
std::string GetVariableName ()
 
bool HasVariableName (const std::string &rVariableName)
 
virtual doubleGetFirstDerivativeKineticFactor (double &rParameter)
 
virtual doubleGetSecondDerivativeKineticFactor (double &rParameter)
 
virtual doubleGetFirstDerivativeInertialFactor (double &rParameter)
 
virtual doubleGetSecondDerivativeInertialFactor (double &rParameter)
 
FlagsGetFlags ()
 
Flags const & GetFlags () const
 
void SetFlags (Flags const &rThisFlags)
 
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...
 
 KRATOS_CLASS_POINTER_DEFINITION (TimeIntegrationMethod)
 
- Public Member Functions inherited from Kratos::Flags
Flagsoperator= (Flags const &rOther)
 Assignment operator. More...
 
 operator bool () const
 
Flags operator~ () const
 
bool operator! () const
 
void AssignFlags (Flags const &rOther)
 
void Set (const Flags ThisFlag)
 
void Set (const Flags ThisFlag, bool Value)
 
void Reset (const Flags ThisFlag)
 
void Flip (const Flags ThisFlag)
 
void SetPosition (IndexType Position, bool Value=true)
 
bool GetPosition (IndexType Position) const
 
void FlipPosition (IndexType Position)
 
void ClearPosition (IndexType Position)
 
void Clear ()
 
Flags AsFalse () const
 
bool Is (Flags const &rOther) const
 
bool IsDefined (Flags const &rOther) const
 
bool IsNot (Flags const &rOther) const
 
bool IsNotDefined (Flags const &rOther) const
 
 KRATOS_CLASS_POINTER_DEFINITION (Flags)
 Pointer definition of Flags. More...
 
const Flagsoperator|= (const Flags &Other)
 
const Flagsoperator&= (const Flags &Other)
 
 Flags ()
 Default constructor. More...
 
 Flags (Flags const &rOther)
 Copy constructor. More...
 
virtual ~Flags ()
 Destructor. More...
 

Protected Member Functions

Protected Operations
void PredictVariable (NodeType &rNode) override
 
virtual void PredictStepVariable (NodeType &rNode)
 
virtual void UpdateStepVariable (NodeType &rNode)
 
void UpdateVariable (NodeType &rNode) override
 
- Protected Member Functions inherited from Kratos::TimeIntegrationMethod< TVariableType, TValueType >
void SetPointerMethods ()
 
void SetPointerAssignMethod ()
 
virtual void AssignFromVariable (NodeType &rNode)
 
virtual void AssignFromFirstDerivative (NodeType &rNode)
 
virtual void AssignFromSecondDerivative (NodeType &rNode)
 
virtual void AssignVariable (NodeType &rNode)
 
virtual void AssignFirstDerivative (NodeType &rNode)
 
virtual void AssignSecondDerivative (NodeType &rNode)
 
virtual void PredictFromVariable (NodeType &rNode)
 
virtual void PredictFromFirstDerivative (NodeType &rNode)
 
virtual void PredictFromSecondDerivative (NodeType &rNode)
 
virtual void PredictFirstDerivative (NodeType &rNode)
 
virtual void PredictSecondDerivative (NodeType &rNode)
 
virtual void UpdateFromVariable (NodeType &rNode)
 
virtual void UpdateFromFirstDerivative (NodeType &rNode)
 
virtual void UpdateFromSecondDerivative (NodeType &rNode)
 
virtual void UpdateFirstDerivative (NodeType &rNode)
 
virtual void UpdateSecondDerivative (NodeType &rNode)
 
virtual doubleGetKineticParameter (double &rParameter)
 
virtual doubleGetFirstDerivativeKineticParameter (double &rParameter)
 
virtual doubleGetSecondDerivativeKineticParameter (double &rParameter)
 
virtual doubleGetInertialParameter (double &rParameter)
 
virtual doubleGetFirstDerivativeInertialParameter (double &rParameter)
 
virtual doubleGetSecondDerivativeInertialParameter (double &rParameter)
 

Protected Attributes

Protected member Variables
VariablePointer mpStepVariable
 
- Protected Attributes inherited from Kratos::TimeIntegrationMethod< TVariableType, TValueType >
VariablePointer mpVariable
 
VariablePointer mpFirstDerivative
 
VariablePointer mpSecondDerivative
 
VariablePointer mpPrimaryVariable
 
VariablePointer mpInputVariable
 
MethodPointer mpAssign
 
MethodPointer mpPredict
 
MethodPointer mpUpdate
 
MethodFactorPointer mpFirstDerivativeKineticFactor
 
MethodFactorPointer mpSecondDerivativeKineticFactor
 
MethodFactorPointer mpFirstDerivativeInertialFactor
 
MethodFactorPointer mpSecondDerivativeInertialFactor
 

Type Definitions

typedef TimeIntegrationMethod< TVariableType, TValueType > BaseType
 BaseType. More...
 
typedef BaseType::Pointer BasePointerType
 BasePointerType. More...
 
typedef BaseType::NodeType NodeType
 NodeType. More...
 
typedef BaseType::VariablePointer VariablePointer
 KratosVariable or KratosVariableComponent. More...
 
typedef StaticMethod< TVariableType, TValueType > DerivedType
 DerivedType. More...
 
 KRATOS_CLASS_POINTER_DEFINITION (StaticStepMethod)
 

Serialization

class Serializer
 

Additional Inherited Members

- Public Types inherited from Kratos::StaticMethod< TVariableType, TValueType >
typedef TimeIntegrationMethod< TVariableType, TValueType > BaseType
 BaseType. More...
 
typedef BaseType::Pointer BasePointerType
 BasePointerType. More...
 
typedef BaseType::NodeType NodeType
 NodeType. More...
 
typedef BaseType::VariablePointer VariablePointer
 KratosVariable or KratosVariableComponent. More...
 
- Public Types inherited from Kratos::TimeIntegrationMethod< TVariableType, TValueType >
typedef Node NodeType
 NodeType. More...
 
typedef const TVariableType * VariablePointer
 KratosVariable or KratosVariableComponent. More...
 
typedef const TValueType * ValuePointer
 
typedef void(TimeIntegrationMethod::* MethodPointer) (NodeType &rNode)
 
typedef double &(TimeIntegrationMethod::* MethodFactorPointer) (double &rParameter)
 
typedef TimeIntegrationMethod::Pointer TimeIntegrationMethodPointer
 
- Public Types inherited from Kratos::Flags
enum  FlagsList {
  Flag0 = BlockType(1) , Flag1 = BlockType(1) << 1 , Flag2 = BlockType(1) << 2 , Flag3 = BlockType(1) << 3 ,
  Flag4 = BlockType(1) << 4 , Flag5 = BlockType(1) << 5 , Flag6 = BlockType(1) << 6 , Flag7 = BlockType(1) << 7 ,
  Flag8 = BlockType(1) << 8 , Flag9 = BlockType(1) << 9 , Flag10 = BlockType(1) << 10 , Flag11 = BlockType(1) << 11 ,
  Flag12 = BlockType(1) << 12 , Flag13 = BlockType(1) << 13 , Flag14 = BlockType(1) << 14 , Flag15 = BlockType(1) << 15 ,
  Flag16 = BlockType(1) << 16 , Flag17 = BlockType(1) << 17 , Flag18 = BlockType(1) << 18 , Flag19 = BlockType(1) << 19 ,
  Flag20 = BlockType(1) << 20 , Flag21 = BlockType(1) << 21 , Flag22 = BlockType(1) << 22 , Flag23 = BlockType(1) << 23 ,
  Flag24 = BlockType(1) << 24 , Flag25 = BlockType(1) << 25 , Flag26 = BlockType(1) << 26 , Flag27 = BlockType(1) << 27 ,
  Flag28 = BlockType(1) << 28 , Flag29 = BlockType(1) << 29 , Flag30 = BlockType(1) << 30
}
 
typedef int64_t BlockType
 
typedef int64_t FlagType
 
typedef std::size_t IndexType
 
- Static Public Member Functions inherited from Kratos::Flags
static const Flags AllDefined ()
 
static const Flags AllTrue ()
 
static Flags Create (IndexType ThisPosition, bool Value=true)
 

Detailed Description

template<class TVariableType, class TValueType>
class Kratos::StaticStepMethod< TVariableType, TValueType >

Short class definition.

Detail class definition. This class performs predict and update of dofs variables, their time derivatives and time integrals

Member Typedef Documentation

◆ BasePointerType

template<class TVariableType , class TValueType >
typedef BaseType::Pointer Kratos::StaticStepMethod< TVariableType, TValueType >::BasePointerType

BasePointerType.

◆ BaseType

template<class TVariableType , class TValueType >
typedef TimeIntegrationMethod<TVariableType,TValueType> Kratos::StaticStepMethod< TVariableType, TValueType >::BaseType

BaseType.

◆ DerivedType

template<class TVariableType , class TValueType >
typedef StaticMethod<TVariableType,TValueType> Kratos::StaticStepMethod< TVariableType, TValueType >::DerivedType

DerivedType.

◆ NodeType

template<class TVariableType , class TValueType >
typedef BaseType::NodeType Kratos::StaticStepMethod< TVariableType, TValueType >::NodeType

NodeType.

◆ VariablePointer

template<class TVariableType , class TValueType >
typedef BaseType::VariablePointer Kratos::StaticStepMethod< TVariableType, TValueType >::VariablePointer

KratosVariable or KratosVariableComponent.

Constructor & Destructor Documentation

◆ StaticStepMethod() [1/5]

template<class TVariableType , class TValueType >
Kratos::StaticStepMethod< TVariableType, TValueType >::StaticStepMethod ( )
inline

Default Constructor.

◆ StaticStepMethod() [2/5]

template<class TVariableType , class TValueType >
Kratos::StaticStepMethod< TVariableType, TValueType >::StaticStepMethod ( const TVariableType &  rVariable)
inline

Constructor.

◆ StaticStepMethod() [3/5]

template<class TVariableType , class TValueType >
Kratos::StaticStepMethod< TVariableType, TValueType >::StaticStepMethod ( const TVariableType &  rVariable,
const TVariableType &  rFirstDerivative,
const TVariableType &  rSecondDerivative 
)
inline

Constructor.

◆ StaticStepMethod() [4/5]

template<class TVariableType , class TValueType >
Kratos::StaticStepMethod< TVariableType, TValueType >::StaticStepMethod ( const TVariableType &  rVariable,
const TVariableType &  rFirstDerivative,
const TVariableType &  rSecondDerivative,
const TVariableType &  rPrimaryVariable 
)
inline

Constructor.

◆ StaticStepMethod() [5/5]

template<class TVariableType , class TValueType >
Kratos::StaticStepMethod< TVariableType, TValueType >::StaticStepMethod ( StaticStepMethod< TVariableType, TValueType > &  rOther)
inline

Copy Constructor.

◆ ~StaticStepMethod()

template<class TVariableType , class TValueType >
Kratos::StaticStepMethod< TVariableType, TValueType >::~StaticStepMethod ( )
inlineoverride

Destructor.

Member Function Documentation

◆ Assign()

template<class TVariableType , class TValueType >
void Kratos::StaticStepMethod< TVariableType, TValueType >::Assign ( NodeType rNode)
inlineoverridevirtual

◆ Check()

template<class TVariableType , class TValueType >
int Kratos::StaticStepMethod< TVariableType, TValueType >::Check ( const ProcessInfo rCurrentProcessInfo)
inlineoverridevirtual

This function is designed to be called once to perform all the checks needed.

Returns
0 all ok

Reimplemented from Kratos::TimeIntegrationMethod< TVariableType, TValueType >.

◆ Clone()

template<class TVariableType , class TValueType >
BasePointerType Kratos::StaticStepMethod< TVariableType, TValueType >::Clone ( )
inlineoverridevirtual

◆ HasStepVariable()

template<class TVariableType , class TValueType >
bool Kratos::StaticStepMethod< TVariableType, TValueType >::HasStepVariable ( )
inlineoverridevirtual

◆ Info()

template<class TVariableType , class TValueType >
std::string Kratos::StaticStepMethod< TVariableType, TValueType >::Info ( ) const
inlineoverridevirtual

Turn back information as a string.

Reimplemented from Kratos::StaticMethod< TVariableType, TValueType >.

Reimplemented in Kratos::StaticStepRotationMethod< TVariableType, TValueType >.

◆ KRATOS_CLASS_POINTER_DEFINITION()

template<class TVariableType , class TValueType >
Kratos::StaticStepMethod< TVariableType, TValueType >::KRATOS_CLASS_POINTER_DEFINITION ( StaticStepMethod< TVariableType, TValueType >  )

◆ Predict()

template<class TVariableType , class TValueType >
void Kratos::StaticStepMethod< TVariableType, TValueType >::Predict ( NodeType rNode)
inlineoverridevirtual

◆ PredictStepVariable()

template<class TVariableType , class TValueType >
virtual void Kratos::StaticStepMethod< TVariableType, TValueType >::PredictStepVariable ( NodeType rNode)
inlineprotectedvirtual

◆ PredictVariable()

template<class TVariableType , class TValueType >
void Kratos::StaticStepMethod< TVariableType, TValueType >::PredictVariable ( NodeType rNode)
inlineoverrideprotectedvirtual

◆ PrintData()

template<class TVariableType , class TValueType >
void Kratos::StaticStepMethod< TVariableType, TValueType >::PrintData ( std::ostream &  rOStream) const
inlineoverridevirtual

◆ PrintInfo()

template<class TVariableType , class TValueType >
void Kratos::StaticStepMethod< TVariableType, TValueType >::PrintInfo ( std::ostream &  rOStream) const
inlineoverridevirtual

Print information about this object.

Reimplemented from Kratos::StaticMethod< TVariableType, TValueType >.

Reimplemented in Kratos::StaticStepRotationMethod< TVariableType, TValueType >.

◆ SetStepVariable()

template<class TVariableType , class TValueType >
void Kratos::StaticStepMethod< TVariableType, TValueType >::SetStepVariable ( const TVariableType &  rStepVariable)
inlineoverridevirtual

◆ Update()

template<class TVariableType , class TValueType >
void Kratos::StaticStepMethod< TVariableType, TValueType >::Update ( NodeType rNode)
inlineoverridevirtual

◆ UpdateStepVariable()

template<class TVariableType , class TValueType >
virtual void Kratos::StaticStepMethod< TVariableType, TValueType >::UpdateStepVariable ( NodeType rNode)
inlineprotectedvirtual

◆ UpdateVariable()

template<class TVariableType , class TValueType >
void Kratos::StaticStepMethod< TVariableType, TValueType >::UpdateVariable ( NodeType rNode)
inlineoverrideprotectedvirtual

Friends And Related Function Documentation

◆ Serializer

template<class TVariableType , class TValueType >
friend class Serializer
friend

Member Data Documentation

◆ mpStepVariable

template<class TVariableType , class TValueType >
VariablePointer Kratos::StaticStepMethod< TVariableType, TValueType >::mpStepVariable
protected

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