Short class definition. More...

#include <emc_step_method.hpp>

Inheritance diagram for Kratos::EmcStepMethod< TVariableType, TValueType >:

Collaboration diagram for Kratos::EmcStepMethod< TVariableType, TValueType >:

Classes
struct	EmcParameters

Public Member Functions
Life Cycle
	EmcStepMethod ()
	Default Constructor. More...

	EmcStepMethod (const TVariableType &rVariable)
	Constructor. More...

	EmcStepMethod (const TVariableType &rVariable, const TVariableType &rFirstDerivative, const TVariableType &rSecondDerivative)
	Constructor. More...

	EmcStepMethod (const TVariableType &rVariable, const TVariableType &rFirstDerivative, const TVariableType &rSecondDerivative, const TVariableType &rPrimaryVariable)
	Constructor. More...

	EmcStepMethod (EmcStepMethod &rOther)
	Copy Constructor. More...

BasePointerType	Clone () override
	Clone. More...

	~EmcStepMethod () override
	Destructor. More...

Operations
void	CalculateParameters (ProcessInfo &rCurrentProcessInfo) override

void	SetParameters (const ProcessInfo &rCurrentProcessInfo) override

void	SetProcessInfoParameters (ProcessInfo &rCurrentProcessInfo) override

bool	HasStepVariable () override

void	SetStepVariable (const TVariableType &rStepVariable) 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::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...

void	SetInputVariable (const TVariableType &rVariable)

std::string	GetPrimaryVariableName ()

std::string	GetVariableName ()

bool	HasVariableName (const std::string &rVariableName)

virtual void	Assign (NodeType &rNode)

virtual void	Predict (NodeType &rNode)

virtual void	Update (NodeType &rNode)

virtual double &	GetFirstDerivativeKineticFactor (double &rParameter)

virtual double &	GetSecondDerivativeKineticFactor (double &rParameter)

virtual double &	GetFirstDerivativeInertialFactor (double &rParameter)

virtual double &	GetSecondDerivativeInertialFactor (double &rParameter)

Flags &	GetFlags ()

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
Flags &	operator= (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 Flags &	operator\|= (const Flags &Other)

const Flags &	operator&= (const Flags &Other)

	Flags ()
	Default constructor. More...

	Flags (Flags const &rOther)
	Copy constructor. More...

virtual	~Flags ()
	Destructor. More...

Protected Member Functions
Protected Operations
void	AssignFromVariable (NodeType &rNode) override

void	AssignFromFirstDerivative (NodeType &rNode) override

void	AssignFromSecondDerivative (NodeType &rNode) override

void	PredictFromVariable (NodeType &rNode) override

virtual void	PredictStepVariable (NodeType &rNode)

void	PredictVariable (NodeType &rNode) override

void	PredictFirstDerivative (NodeType &rNode) override

void	PredictSecondDerivative (NodeType &rNode) override

void	UpdateFromVariable (NodeType &rNode) override

virtual void	UpdateStepVariable (NodeType &rNode)

void	UpdateVariable (NodeType &rNode) override

void	UpdateFirstDerivative (NodeType &rNode) override

void	UpdateSecondDerivative (NodeType &rNode) override

Protected Member Functions inherited from Kratos::TimeIntegrationMethod< TVariableType, TValueType >
void	SetPointerMethods ()

void	SetPointerAssignMethod ()

virtual void	AssignVariable (NodeType &rNode)

virtual void	AssignFirstDerivative (NodeType &rNode)

virtual void	AssignSecondDerivative (NodeType &rNode)

virtual void	PredictFromFirstDerivative (NodeType &rNode)

virtual void	PredictFromSecondDerivative (NodeType &rNode)

virtual void	UpdateFromFirstDerivative (NodeType &rNode)

virtual void	UpdateFromSecondDerivative (NodeType &rNode)

virtual double &	GetKineticParameter (double &rParameter)

virtual double &	GetFirstDerivativeKineticParameter (double &rParameter)

virtual double &	GetSecondDerivativeKineticParameter (double &rParameter)

virtual double &	GetInertialParameter (double &rParameter)

virtual double &	GetFirstDerivativeInertialParameter (double &rParameter)

virtual double &	GetSecondDerivativeInertialParameter (double &rParameter)

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...

	KRATOS_CLASS_POINTER_DEFINITION (EmcStepMethod)

Serialization
class	Serializer

Additional Inherited Members
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::EmcStepMethod< 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::EmcStepMethod< TVariableType, TValueType >::BasePointerType

BasePointerType.

◆ BaseType

template<class TVariableType , class TValueType >

typedef TimeIntegrationMethod<TVariableType,TValueType> Kratos::EmcStepMethod< TVariableType, TValueType >::BaseType

BaseType.

◆ NodeType

template<class TVariableType , class TValueType >

typedef BaseType::NodeType Kratos::EmcStepMethod< TVariableType, TValueType >::NodeType

NodeType.

◆ VariablePointer

template<class TVariableType , class TValueType >

typedef BaseType::VariablePointer Kratos::EmcStepMethod< TVariableType, TValueType >::VariablePointer

KratosVariable or KratosVariableComponent.

Constructor & Destructor Documentation

◆ EmcStepMethod() [1/5]

template<class TVariableType , class TValueType >

Kratos::EmcStepMethod< TVariableType, TValueType >::EmcStepMethod ( )

inline

Default Constructor.

◆ EmcStepMethod() [2/5]

template<class TVariableType , class TValueType >

Kratos::EmcStepMethod< TVariableType, TValueType >::EmcStepMethod ( const TVariableType & rVariable )

inline

Constructor.

◆ EmcStepMethod() [3/5]

template<class TVariableType , class TValueType >

Kratos::EmcStepMethod< TVariableType, TValueType >::EmcStepMethod	(	const TVariableType &	rVariable,
		const TVariableType &	rFirstDerivative,
		const TVariableType &	rSecondDerivative
	)

inline

Constructor.

◆ EmcStepMethod() [4/5]

template<class TVariableType , class TValueType >

Kratos::EmcStepMethod< TVariableType, TValueType >::EmcStepMethod	(	const TVariableType &	rVariable,
		const TVariableType &	rFirstDerivative,
		const TVariableType &	rSecondDerivative,
		const TVariableType &	rPrimaryVariable
	)

inline

Constructor.

◆ EmcStepMethod() [5/5]

template<class TVariableType , class TValueType >

Kratos::EmcStepMethod< TVariableType, TValueType >::EmcStepMethod ( EmcStepMethod< TVariableType, TValueType > & rOther )

inline

Copy Constructor.

◆ ~EmcStepMethod()

template<class TVariableType , class TValueType >

Kratos::EmcStepMethod< TVariableType, TValueType >::~EmcStepMethod ( )

inlineoverride

Destructor.

Member Function Documentation

◆ AssignFromFirstDerivative()

template<class TVariableType , class TValueType >

void Kratos::EmcStepMethod< TVariableType, TValueType >::AssignFromFirstDerivative ( NodeType & rNode )

inlineoverrideprotectedvirtual

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

◆ AssignFromSecondDerivative()

template<class TVariableType , class TValueType >

void Kratos::EmcStepMethod< TVariableType, TValueType >::AssignFromSecondDerivative ( NodeType & rNode )

inlineoverrideprotectedvirtual

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

◆ AssignFromVariable()

template<class TVariableType , class TValueType >

void Kratos::EmcStepMethod< TVariableType, TValueType >::AssignFromVariable ( NodeType & rNode )

inlineoverrideprotectedvirtual

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

◆ CalculateParameters()

template<class TVariableType , class TValueType >

void Kratos::EmcStepMethod< TVariableType, TValueType >::CalculateParameters ( ProcessInfo & rCurrentProcessInfo )

inlineoverridevirtual

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

◆ Check()

template<class TVariableType , class TValueType >

int Kratos::EmcStepMethod< 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::EmcStepMethod< TVariableType, TValueType >::Clone ( )

inlineoverridevirtual

Clone.

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

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

◆ HasStepVariable()

template<class TVariableType , class TValueType >

bool Kratos::EmcStepMethod< TVariableType, TValueType >::HasStepVariable ( )

inlineoverridevirtual

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

◆ Info()

template<class TVariableType , class TValueType >

std::string Kratos::EmcStepMethod< TVariableType, TValueType >::Info ( ) const

inlineoverridevirtual

Turn back information as a string.

Reimplemented from Kratos::Flags.

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

◆ KRATOS_CLASS_POINTER_DEFINITION()

template<class TVariableType , class TValueType >

Kratos::EmcStepMethod< TVariableType, TValueType >::KRATOS_CLASS_POINTER_DEFINITION ( EmcStepMethod< TVariableType, TValueType > )

◆ PredictFirstDerivative()

template<class TVariableType , class TValueType >

void Kratos::EmcStepMethod< TVariableType, TValueType >::PredictFirstDerivative ( NodeType & rNode )

inlineoverrideprotectedvirtual

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

◆ PredictFromVariable()

template<class TVariableType , class TValueType >

void Kratos::EmcStepMethod< TVariableType, TValueType >::PredictFromVariable ( NodeType & rNode )

inlineoverrideprotectedvirtual

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

◆ PredictSecondDerivative()

template<class TVariableType , class TValueType >

void Kratos::EmcStepMethod< TVariableType, TValueType >::PredictSecondDerivative ( NodeType & rNode )

inlineoverrideprotectedvirtual

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

◆ PredictStepVariable()

template<class TVariableType , class TValueType >

virtual void Kratos::EmcStepMethod< TVariableType, TValueType >::PredictStepVariable ( NodeType & rNode )

inlineprotectedvirtual

◆ PredictVariable()

template<class TVariableType , class TValueType >

void Kratos::EmcStepMethod< TVariableType, TValueType >::PredictVariable ( NodeType & rNode )

inlineoverrideprotectedvirtual

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

◆ PrintData()

template<class TVariableType , class TValueType >

void Kratos::EmcStepMethod< TVariableType, TValueType >::PrintData ( std::ostream & rOStream ) const

inlineoverridevirtual

Print object's data.

Reimplemented from Kratos::Flags.

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

◆ PrintInfo()

template<class TVariableType , class TValueType >

void Kratos::EmcStepMethod< TVariableType, TValueType >::PrintInfo ( std::ostream & rOStream ) const

inlineoverridevirtual

Print information about this object.

Reimplemented from Kratos::Flags.

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

◆ SetParameters()

template<class TVariableType , class TValueType >

void Kratos::EmcStepMethod< TVariableType, TValueType >::SetParameters ( const ProcessInfo & rCurrentProcessInfo )

inlineoverridevirtual

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

◆ SetProcessInfoParameters()

template<class TVariableType , class TValueType >

void Kratos::EmcStepMethod< TVariableType, TValueType >::SetProcessInfoParameters ( ProcessInfo & rCurrentProcessInfo )

inlineoverridevirtual

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

◆ SetStepVariable()

template<class TVariableType , class TValueType >

void Kratos::EmcStepMethod< TVariableType, TValueType >::SetStepVariable ( const TVariableType & rStepVariable )

inlineoverridevirtual

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

◆ UpdateFirstDerivative()

template<class TVariableType , class TValueType >

void Kratos::EmcStepMethod< TVariableType, TValueType >::UpdateFirstDerivative ( NodeType & rNode )

inlineoverrideprotectedvirtual

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

◆ UpdateFromVariable()

template<class TVariableType , class TValueType >

void Kratos::EmcStepMethod< TVariableType, TValueType >::UpdateFromVariable ( NodeType & rNode )

inlineoverrideprotectedvirtual

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

◆ UpdateSecondDerivative()

template<class TVariableType , class TValueType >

void Kratos::EmcStepMethod< TVariableType, TValueType >::UpdateSecondDerivative ( NodeType & rNode )

inlineoverrideprotectedvirtual

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

◆ UpdateStepVariable()

template<class TVariableType , class TValueType >

virtual void Kratos::EmcStepMethod< TVariableType, TValueType >::UpdateStepVariable ( NodeType & rNode )

inlineprotectedvirtual

◆ UpdateVariable()

template<class TVariableType , class TValueType >

void Kratos::EmcStepMethod< TVariableType, TValueType >::UpdateVariable ( NodeType & rNode )

inlineoverrideprotectedvirtual

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

Friends And Related Function Documentation

◆ Serializer

template<class TVariableType , class TValueType >

friend class Serializer

friend

Member Data Documentation

◆ mEmc

template<class TVariableType , class TValueType >

EmcParameters Kratos::EmcStepMethod< TVariableType, TValueType >::mEmc

protected

◆ mpStepVariable

template<class TVariableType , class TValueType >

VariablePointer Kratos::EmcStepMethod< TVariableType, TValueType >::mpStepVariable

protected

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

/home/runner/work/Documentation/Documentation/master/applications/SolidMechanicsApplication/custom_solvers/time_integration_methods/emc_step_method.hpp

Protected Attributes
Protected member Variables
EmcParameters	mEmc

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

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Type Definitions

Serialization

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ BasePointerType

◆ BaseType

◆ NodeType

◆ VariablePointer

Constructor & Destructor Documentation

◆ EmcStepMethod() [1/5]

◆ EmcStepMethod() [2/5]

◆ EmcStepMethod() [3/5]

◆ EmcStepMethod() [4/5]

◆ EmcStepMethod() [5/5]

◆ ~EmcStepMethod()

Member Function Documentation

◆ AssignFromFirstDerivative()

◆ AssignFromSecondDerivative()

◆ AssignFromVariable()

◆ CalculateParameters()

◆ Check()

◆ Clone()

◆ HasStepVariable()

◆ Info()

◆ KRATOS_CLASS_POINTER_DEFINITION()

◆ PredictFirstDerivative()

◆ PredictFromVariable()

◆ PredictSecondDerivative()

◆ PredictStepVariable()

◆ PredictVariable()

◆ PrintData()

◆ PrintInfo()

◆ SetParameters()

◆ SetProcessInfoParameters()

◆ SetStepVariable()

◆ UpdateFirstDerivative()

◆ UpdateFromVariable()

◆ UpdateSecondDerivative()

◆ UpdateStepVariable()

◆ UpdateVariable()

Friends And Related Function Documentation

◆ Serializer

Member Data Documentation

◆ mEmc

◆ mpStepVariable

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