This is a convergence criteria that considers the increment on the solution as criteria. More...

#include <displacement_criteria.h>

Inheritance diagram for Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >:

Collaboration diagram for Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >:

Public Member Functions
Life Cycle
	DisplacementCriteria ()
	Default constructor. More...

	DisplacementCriteria (Kratos::Parameters ThisParameters)
	Default constructor. (with parameters) More...

	DisplacementCriteria (TDataType NewRatioTolerance, TDataType AlwaysConvergedNorm)
	Constructor 2 arguments. More...

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

	~DisplacementCriteria () override
	Destructor. More...

Operators
DisplacementCriteria &	operator= (DisplacementCriteria const &rOther)=delete
	Deleted assignment operator. 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::ConvergenceCriteria< TSparseSpace, TDenseSpace >
	ConvergenceCriteria ()

	ConvergenceCriteria (Kratos::Parameters ThisParameters)
	Constructor with Parameters. More...

	ConvergenceCriteria (ConvergenceCriteria const &rOther)

virtual	~ConvergenceCriteria ()

	KRATOS_CLASS_POINTER_DEFINITION (ConvergenceCriteria)
	Pointer definition of ConvergenceCriteria. More...

virtual std::vector< TSystemVectorType > &	GetRHS_Element_Components ()
	Get component wise element components. More...

virtual std::vector< Variable< LocalSystemVectorType > > &	GetRHS_Element_Variables ()
	Get component wise element variables. More...

virtual std::vector< TSystemVectorType > &	GetRHS_Condition_Components ()
	Get component wise condition components. More...

virtual std::vector< Variable< LocalSystemVectorType > > &	GetRHS_Condition_Variables ()
	Get component wise condition variables. More...

virtual void	SetEchoLevel (int Level)
	It sets the level of echo for the solving strategy. More...

int	GetEchoLevel ()
	This returns the level of echo for the solving strategy. More...

void	SetActualizeRHSFlag (bool ActualizeRHSIsNeeded)
	This method sets the flag mActualizeRHSIsNeeded. More...

bool	GetActualizeRHSflag ()
	This method gets the flag mActualizeRHSIsNeeded. More...

virtual bool	PreCriteria (ModelPart &rModelPart, DofsArrayType &rDofSet, const TSystemMatrixType &rA, const TSystemVectorType &rDx, const TSystemVectorType &rb)
	Criterias that need to be called before getting the solution. More...

virtual bool	IsInitialized ()
	This function returns if the convergence criteria is initialized. More...

virtual void	InitializeNonLinearIteration (ModelPart &rModelPart, DofsArrayType &rDofSet, const TSystemMatrixType &rA, const TSystemVectorType &rDx, const TSystemVectorType &rb)
	This function initializes the non-linear iteration. More...

virtual void	FinalizeNonLinearIteration (ModelPart &rModelPart, DofsArrayType &rDofSet, const TSystemMatrixType &rA, const TSystemVectorType &rDx, const TSystemVectorType &rb)
	This function finalizes the non-linear iteration. More...

virtual int	Check (ModelPart &rModelPart)
	This function is designed to be called once to perform all the checks needed on the input provided. Checks can be "expensive" as the function is designed to catch user's errors. More...

Protected Member Functions
Protected Operations
void	AssignSettings (const Parameters ThisParameters) override
	This method assigns settings to member variables. More...

Protected Member Functions inherited from Kratos::ConvergenceCriteria< TSparseSpace, TDenseSpace >
virtual Parameters	ValidateAndAssignParameters (Parameters ThisParameters, const Parameters DefaultParameters) const
	This method validate and assign default parameters. More...

Protected Attributes
Protected member Variables
TDataType	mRatioTolerance = 0.0

TDataType	mAlwaysConvergedNorm = 0.0
	The ratio threshold for the norm of the residual. More...

TDataType	mReferenceDispNorm = 0.0
	The absolute value threshold for the norm of the residual. More...

Protected Attributes inherited from Kratos::ConvergenceCriteria< TSparseSpace, TDenseSpace >
bool	mActualizeRHSIsNeeded = false

bool	mConvergenceCriteriaIsInitialized = false
	This "flag" is set in order to know if it is necessary to actualize the RHS. More...

int	mEchoLevel
	This "flag" is set in order to know if it is convergence criteria is initialized. More...

Type Definitions
using	BaseType = ConvergenceCriteria< TSparseSpace, TDenseSpace >
	The definition of the base ConvergenceCriteria. More...

using	ClassType = DisplacementCriteria< TSparseSpace, TDenseSpace >
	The definition of the current class. More...

using	SparseSpaceType = TSparseSpace
	The definition of the sparse space type. More...

using	TDataType = typename BaseType::TDataType
	The data type. More...

using	DofsArrayType = typename BaseType::DofsArrayType
	The dofs array type. More...

using	DofType = typename Node::DofType
	The definition of the DoF data type. More...

using	TSystemMatrixType = typename BaseType::TSystemMatrixType
	The sparse matrix type. More...

using	TSystemVectorType = typename BaseType::TSystemVectorType
	The dense vector type. More...

using	IndexType = std::size_t
	Definition of the IndexType. More...

using	SizeType = std::size_t
	Definition of the size type. More...

	KRATOS_CLASS_POINTER_DEFINITION (DisplacementCriteria)
	Pointer definition of DisplacementCriteria. More...

Operations
BaseType::Pointer	Create (Parameters ThisParameters) const override
	Create method. More...

bool	PostCriteria (ModelPart &rModelPart, DofsArrayType &rDofSet, const TSystemMatrixType &rA, const TSystemVectorType &rDx, const TSystemVectorType &rb) override
	Compute relative and absolute error. More...

void	Initialize (ModelPart &rModelPart) override
	This function initialize the convergence criteria. More...

void	InitializeSolutionStep (ModelPart &rModelPart, DofsArrayType &rDofSet, const TSystemMatrixType &rA, const TSystemVectorType &rDx, const TSystemVectorType &rb) override
	This function initializes the solution step. More...

void	FinalizeSolutionStep (ModelPart &rModelPart, DofsArrayType &rDofSet, const TSystemMatrixType &rA, const TSystemVectorType &rDx, const TSystemVectorType &rb) override
	This function finalizes the solution step. More...

Parameters	GetDefaultParameters () const override
	This method provides the defaults parameters to avoid conflicts between the different constructors. More...

static std::string	Name ()
	Returns the name of the class as used in the settings (snake_case format) More...

Additional Inherited Members
Public Types inherited from Kratos::ConvergenceCriteria< TSparseSpace, TDenseSpace >
typedef ConvergenceCriteria< TSparseSpace, TDenseSpace >	ClassType
	The definition of the current class. More...

typedef TSparseSpace::DataType	TDataType
	Data type definition. More...

typedef TSparseSpace::MatrixType	TSystemMatrixType
	Matrix type definition. More...

typedef TSparseSpace::VectorType	TSystemVectorType
	Vector type definition. More...

typedef TDenseSpace::MatrixType	LocalSystemMatrixType
	Local system matrix type definition. More...

typedef TDenseSpace::VectorType	LocalSystemVectorType
	Local system vector type definition. More...

typedef ModelPart::DofsArrayType	DofsArrayType
	DoF array type definition. More...

Static Public Member Functions inherited from Kratos::ConvergenceCriteria< TSparseSpace, TDenseSpace >
static std::string	Name ()
	Returns the name of the class as used in the settings (snake_case format) More...

Detailed Description

template<class TSparseSpace, class TDenseSpace>
class Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >

This is a convergence criteria that considers the increment on the solution as criteria.

The reactions from the RHS are not computed in the solution

Author: Riccardo Rossi

Member Typedef Documentation

◆ BaseType

template<class TSparseSpace , class TDenseSpace >

using Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::BaseType = ConvergenceCriteria< TSparseSpace, TDenseSpace >

The definition of the base ConvergenceCriteria.

◆ ClassType

template<class TSparseSpace , class TDenseSpace >

using Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::ClassType = DisplacementCriteria< TSparseSpace, TDenseSpace >

The definition of the current class.

◆ DofsArrayType

template<class TSparseSpace , class TDenseSpace >

using Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::DofsArrayType = typename BaseType::DofsArrayType

The dofs array type.

◆ DofType

template<class TSparseSpace , class TDenseSpace >

using Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::DofType = typename Node::DofType

The definition of the DoF data type.

◆ IndexType

template<class TSparseSpace , class TDenseSpace >

using Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::IndexType = std::size_t

Definition of the IndexType.

◆ SizeType

template<class TSparseSpace , class TDenseSpace >

using Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::SizeType = std::size_t

Definition of the size type.

◆ SparseSpaceType

template<class TSparseSpace , class TDenseSpace >

using Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::SparseSpaceType = TSparseSpace

The definition of the sparse space type.

◆ TDataType

template<class TSparseSpace , class TDenseSpace >

using Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::TDataType = typename BaseType::TDataType

The data type.

◆ TSystemMatrixType

template<class TSparseSpace , class TDenseSpace >

using Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::TSystemMatrixType = typename BaseType::TSystemMatrixType

The sparse matrix type.

◆ TSystemVectorType

template<class TSparseSpace , class TDenseSpace >

using Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::TSystemVectorType = typename BaseType::TSystemVectorType

The dense vector type.

Constructor & Destructor Documentation

◆ DisplacementCriteria() [1/4]

template<class TSparseSpace , class TDenseSpace >

Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::DisplacementCriteria ( )

inlineexplicit

Default constructor.

◆ DisplacementCriteria() [2/4]

template<class TSparseSpace , class TDenseSpace >

Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::DisplacementCriteria ( Kratos::Parameters ThisParameters )

inlineexplicit

Default constructor. (with parameters)

Parameters

ThisParameters The configuration parameters

◆ DisplacementCriteria() [3/4]

template<class TSparseSpace , class TDenseSpace >

Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::DisplacementCriteria	(	TDataType	NewRatioTolerance,
		TDataType	AlwaysConvergedNorm
	)

inlineexplicit

Constructor 2 arguments.

Parameters

NewRatioTolerance	The ratio tolerance for the convergence.
AlwaysConvergedNorm	The absolute tolerance for the convergence.

◆ DisplacementCriteria() [4/4]

template<class TSparseSpace , class TDenseSpace >

Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::DisplacementCriteria ( DisplacementCriteria< TSparseSpace, TDenseSpace > const & rOther )

inlineexplicit

Copy constructor.

Parameters

rOther The criteria to be copied

◆ ~DisplacementCriteria()

template<class TSparseSpace , class TDenseSpace >

Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::~DisplacementCriteria ( )

inlineoverride

Destructor.

Member Function Documentation

◆ AssignSettings()

template<class TSparseSpace , class TDenseSpace >

void Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::AssignSettings ( const Parameters ThisParameters )

inlineoverrideprotectedvirtual

This method assigns settings to member variables.

Parameters

ThisParameters Parameters that are assigned to the member variables

Reimplemented from Kratos::ConvergenceCriteria< TSparseSpace, TDenseSpace >.

Reimplemented in Kratos::TrilinosDisplacementCriteria< TSparseSpace, TDenseSpace >.

◆ Create()

template<class TSparseSpace , class TDenseSpace >

BaseType::Pointer Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::Create ( Parameters ThisParameters ) const

inlineoverridevirtual

Create method.

Parameters

ThisParameters The configuration parameters

Reimplemented from Kratos::ConvergenceCriteria< TSparseSpace, TDenseSpace >.

Reimplemented in Kratos::TrilinosDisplacementCriteria< TSparseSpace, TDenseSpace >.

◆ FinalizeSolutionStep()

template<class TSparseSpace , class TDenseSpace >

void Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::FinalizeSolutionStep	(	ModelPart &	rModelPart,
		DofsArrayType &	rDofSet,
		const TSystemMatrixType &	rA,
		const TSystemVectorType &	rDx,
		const TSystemVectorType &	rb
	)

inlineoverridevirtual

This function finalizes the solution step.

Parameters

rModelPart	Reference to the ModelPart containing the problem.
rDofSet	Reference to the container of the problem's degrees of freedom (stored by the BuilderAndSolver)
rA	System matrix (unused)
rDx	Vector of results (variations on nodal variables)
rb	RHS vector (residual + reactions)

Reimplemented from Kratos::ConvergenceCriteria< TSparseSpace, TDenseSpace >.

◆ GetDefaultParameters()

template<class TSparseSpace , class TDenseSpace >

Parameters Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::GetDefaultParameters ( ) const

inlineoverridevirtual

This method provides the defaults parameters to avoid conflicts between the different constructors.

Returns: The default parameters

Reimplemented from Kratos::ConvergenceCriteria< TSparseSpace, TDenseSpace >.

Reimplemented in Kratos::TrilinosDisplacementCriteria< TSparseSpace, TDenseSpace >.

◆ Info()

template<class TSparseSpace , class TDenseSpace >

std::string Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::Info ( ) const

inlineoverridevirtual

Turn back information as a string.

Reimplemented from Kratos::ConvergenceCriteria< TSparseSpace, TDenseSpace >.

Reimplemented in Kratos::TrilinosDisplacementCriteria< TSparseSpace, TDenseSpace >.

◆ Initialize()

template<class TSparseSpace , class TDenseSpace >

void Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::Initialize ( ModelPart & rModelPart )

inlineoverridevirtual

This function initialize the convergence criteria.

Parameters

rModelPart Reference to the ModelPart containing the problem. (unused)

Reimplemented from Kratos::ConvergenceCriteria< TSparseSpace, TDenseSpace >.

◆ InitializeSolutionStep()

template<class TSparseSpace , class TDenseSpace >

void Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::InitializeSolutionStep	(	ModelPart &	rModelPart,
		DofsArrayType &	rDofSet,
		const TSystemMatrixType &	rA,
		const TSystemVectorType &	rDx,
		const TSystemVectorType &	rb
	)

inlineoverridevirtual

This function initializes the solution step.

Parameters

rModelPart	Reference to the ModelPart containing the problem.
rDofSet	Reference to the container of the problem's degrees of freedom (stored by the BuilderAndSolver)
rA	System matrix (unused)
rDx	Vector of results (variations on nodal variables)
rb	RHS vector (residual + reactions)

Reimplemented from Kratos::ConvergenceCriteria< TSparseSpace, TDenseSpace >.

◆ KRATOS_CLASS_POINTER_DEFINITION()

template<class TSparseSpace , class TDenseSpace >

Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::KRATOS_CLASS_POINTER_DEFINITION ( DisplacementCriteria< TSparseSpace, TDenseSpace > )

Pointer definition of DisplacementCriteria.

◆ Name()

template<class TSparseSpace , class TDenseSpace >

static std::string Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::Name ( )

inlinestatic

Returns the name of the class as used in the settings (snake_case format)

Returns: The name of the class

◆ operator=()

template<class TSparseSpace , class TDenseSpace >

DisplacementCriteria& Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::operator= ( DisplacementCriteria< TSparseSpace, TDenseSpace > const & rOther )

delete

Deleted assignment operator.

◆ PostCriteria()

template<class TSparseSpace , class TDenseSpace >

bool Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::PostCriteria	(	ModelPart &	rModelPart,
		DofsArrayType &	rDofSet,
		const TSystemMatrixType &	rA,
		const TSystemVectorType &	rDx,
		const TSystemVectorType &	rb
	)

inlineoverridevirtual

Compute relative and absolute error.

Parameters

rModelPart	Reference to the ModelPart containing the problem.
rDofSet	Reference to the container of the problem's degrees of freedom (stored by the BuilderAndSolver)
rA	System matrix (unused)
rDx	Vector of results (variations on nodal variables)
rb	RHS vector (residual + reactions)

Returns: true if convergence is achieved, false otherwise

Reimplemented from Kratos::ConvergenceCriteria< TSparseSpace, TDenseSpace >.

◆ PrintData()

template<class TSparseSpace , class TDenseSpace >

void Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::PrintData ( std::ostream & rOStream ) const

inlineoverridevirtual

Print object's data.

Reimplemented from Kratos::ConvergenceCriteria< TSparseSpace, TDenseSpace >.

Reimplemented in Kratos::TrilinosDisplacementCriteria< TSparseSpace, TDenseSpace >.

◆ PrintInfo()

template<class TSparseSpace , class TDenseSpace >

void Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::PrintInfo ( std::ostream & rOStream ) const

inlineoverridevirtual

Print information about this object.

Reimplemented from Kratos::ConvergenceCriteria< TSparseSpace, TDenseSpace >.

Reimplemented in Kratos::TrilinosDisplacementCriteria< TSparseSpace, TDenseSpace >.

Member Data Documentation

◆ mAlwaysConvergedNorm

template<class TSparseSpace , class TDenseSpace >

TDataType Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::mAlwaysConvergedNorm = 0.0

protected

The ratio threshold for the norm of the residual.

◆ mRatioTolerance

template<class TSparseSpace , class TDenseSpace >

TDataType Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::mRatioTolerance = 0.0

protected

◆ mReferenceDispNorm

template<class TSparseSpace , class TDenseSpace >

TDataType Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >::mReferenceDispNorm = 0.0

protected

The absolute value threshold for the norm of the residual.

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

/home/runner/work/Documentation/Documentation/master/kratos/solving_strategies/convergencecriterias/displacement_criteria.h

Public Member Functions

Protected Member Functions

Protected Attributes

Type Definitions

Operations

Additional Inherited Members

Detailed Description

template<class TSparseSpace, class TDenseSpace> class Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >

Member Typedef Documentation

◆ BaseType

◆ ClassType

◆ DofsArrayType

◆ DofType

◆ IndexType

◆ SizeType

◆ SparseSpaceType

◆ TDataType

◆ TSystemMatrixType

◆ TSystemVectorType

Constructor & Destructor Documentation

◆ DisplacementCriteria() [1/4]

◆ DisplacementCriteria() [2/4]

◆ DisplacementCriteria() [3/4]

◆ DisplacementCriteria() [4/4]

◆ ~DisplacementCriteria()

Member Function Documentation

◆ AssignSettings()

◆ Create()

◆ FinalizeSolutionStep()

◆ GetDefaultParameters()

◆ Info()

◆ Initialize()

◆ InitializeSolutionStep()

◆ KRATOS_CLASS_POINTER_DEFINITION()

◆ Name()

◆ operator=()

◆ PostCriteria()

◆ PrintData()

◆ PrintInfo()

Member Data Documentation

◆ mAlwaysConvergedNorm

◆ mRatioTolerance

◆ mReferenceDispNorm

template<class TSparseSpace, class TDenseSpace>
class Kratos::DisplacementCriteria< TSparseSpace, TDenseSpace >