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::MPCContactCriteria< TSparseSpace, TDenseSpace > Class Template Reference

Custom convergence criteria for the contact problem. More...

#include <mpc_contact_criteria.h>

Inheritance diagram for Kratos::MPCContactCriteria< TSparseSpace, TDenseSpace >:
Collaboration diagram for Kratos::MPCContactCriteria< TSparseSpace, TDenseSpace >:

Public Member Functions

Life Cycle
 MPCContactCriteria ()
 Default constructor. More...
 
 MPCContactCriteria (Kratos::Parameters ThisParameters)
 Default constructor. (with parameters) More...
 
 MPCContactCriteria (MPCContactCriteria const &rOther)
 Copy constructor. More...
 
 ~MPCContactCriteria () override=default
 Destructor. 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 IsInitialized ()
 This function returns if the convergence criteria is initialized. More...
 
virtual void InitializeSolutionStep (ModelPart &rModelPart, DofsArrayType &rDofSet, const TSystemMatrixType &rA, const TSystemVectorType &rDx, const TSystemVectorType &rb)
 This function initializes the solution step. 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 FinalizeSolutionStep (ModelPart &rModelPart, DofsArrayType &rDofSet, const TSystemMatrixType &rA, const TSystemVectorType &rDx, const TSystemVectorType &rb)
 This function finalizes the solution step. 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...
 

Type Definitions

using BaseType = ConvergenceCriteria< TSparseSpace, TDenseSpace >
 The base class definition. More...
 
using ClassType = MPCContactCriteria< TSparseSpace, TDenseSpace >
 The definition of the current class. More...
 
using DofsArrayType = typename BaseType::DofsArrayType
 The dofs array type. More...
 
using TSystemMatrixType = typename BaseType::TSystemMatrixType
 The sparse matrix type. More...
 
using TSystemVectorType = typename BaseType::TSystemVectorType
 The dense vector type. More...
 
using TablePrinterPointerType = TableStreamUtility::Pointer
 The table stream definition TODO: Replace by logger. More...
 
using IndexType = std::size_t
 The index type definition. More...
 
using CouplingGeometryType = CouplingGeometry< Node >
 
 KRATOS_CLASS_POINTER_DEFINITION (MPCContactCriteria)
 Pointer definition of MPCContactCriteria. More...
 

Operations

BaseType::Pointer Create (Parameters ThisParameters) const override
 Create method. More...
 
bool PreCriteria (ModelPart &rModelPart, DofsArrayType &rDofSet, const TSystemMatrixType &rA, const TSystemVectorType &rDx, const TSystemVectorType &rb) override
 Criterias that need to be called before getting the solution. 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...
 
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...
 
- 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...
 

Detailed Description

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

Custom convergence criteria for the contact problem.

Author
Vicente Mataix Ferrandiz

Member Typedef Documentation

◆ BaseType

template<class TSparseSpace , class TDenseSpace >
using Kratos::MPCContactCriteria< TSparseSpace, TDenseSpace >::BaseType = ConvergenceCriteria<TSparseSpace, TDenseSpace>

The base class definition.

◆ ClassType

template<class TSparseSpace , class TDenseSpace >
using Kratos::MPCContactCriteria< TSparseSpace, TDenseSpace >::ClassType = MPCContactCriteria<TSparseSpace, TDenseSpace>

The definition of the current class.

◆ CouplingGeometryType

template<class TSparseSpace , class TDenseSpace >
using Kratos::MPCContactCriteria< TSparseSpace, TDenseSpace >::CouplingGeometryType = CouplingGeometry<Node>

◆ DofsArrayType

template<class TSparseSpace , class TDenseSpace >
using Kratos::MPCContactCriteria< TSparseSpace, TDenseSpace >::DofsArrayType = typename BaseType::DofsArrayType

The dofs array type.

◆ IndexType

template<class TSparseSpace , class TDenseSpace >
using Kratos::MPCContactCriteria< TSparseSpace, TDenseSpace >::IndexType = std::size_t

The index type definition.

◆ TablePrinterPointerType

template<class TSparseSpace , class TDenseSpace >
using Kratos::MPCContactCriteria< TSparseSpace, TDenseSpace >::TablePrinterPointerType = TableStreamUtility::Pointer

The table stream definition TODO: Replace by logger.

◆ TSystemMatrixType

template<class TSparseSpace , class TDenseSpace >
using Kratos::MPCContactCriteria< TSparseSpace, TDenseSpace >::TSystemMatrixType = typename BaseType::TSystemMatrixType

The sparse matrix type.

◆ TSystemVectorType

template<class TSparseSpace , class TDenseSpace >
using Kratos::MPCContactCriteria< TSparseSpace, TDenseSpace >::TSystemVectorType = typename BaseType::TSystemVectorType

The dense vector type.

Constructor & Destructor Documentation

◆ MPCContactCriteria() [1/3]

template<class TSparseSpace , class TDenseSpace >
Kratos::MPCContactCriteria< TSparseSpace, TDenseSpace >::MPCContactCriteria ( )
inlineexplicit

Default constructor.

◆ MPCContactCriteria() [2/3]

template<class TSparseSpace , class TDenseSpace >
Kratos::MPCContactCriteria< TSparseSpace, TDenseSpace >::MPCContactCriteria ( Kratos::Parameters  ThisParameters)
inlineexplicit

Default constructor. (with parameters)

Parameters
ThisParametersThe configuration parameters

◆ MPCContactCriteria() [3/3]

template<class TSparseSpace , class TDenseSpace >
Kratos::MPCContactCriteria< TSparseSpace, TDenseSpace >::MPCContactCriteria ( MPCContactCriteria< TSparseSpace, TDenseSpace > const &  rOther)
inline

Copy constructor.

◆ ~MPCContactCriteria()

template<class TSparseSpace , class TDenseSpace >
Kratos::MPCContactCriteria< TSparseSpace, TDenseSpace >::~MPCContactCriteria ( )
overridedefault

Destructor.

Member Function Documentation

◆ AssignSettings()

template<class TSparseSpace , class TDenseSpace >
void Kratos::MPCContactCriteria< TSparseSpace, TDenseSpace >::AssignSettings ( const Parameters  ThisParameters)
inlineoverrideprotectedvirtual

This method assigns settings to member variables.

Parameters
ThisParametersParameters that are assigned to the member variables

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

◆ Create()

template<class TSparseSpace , class TDenseSpace >
BaseType::Pointer Kratos::MPCContactCriteria< TSparseSpace, TDenseSpace >::Create ( Parameters  ThisParameters) const
inlineoverridevirtual

Create method.

Parameters
ThisParametersThe configuration parameters

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

◆ GetDefaultParameters()

template<class TSparseSpace , class TDenseSpace >
Parameters Kratos::MPCContactCriteria< 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 >.

◆ Info()

template<class TSparseSpace , class TDenseSpace >
std::string Kratos::MPCContactCriteria< TSparseSpace, TDenseSpace >::Info ( ) const
inlineoverridevirtual

Turn back information as a string.

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

◆ Initialize()

template<class TSparseSpace , class TDenseSpace >
void Kratos::MPCContactCriteria< TSparseSpace, TDenseSpace >::Initialize ( ModelPart rModelPart)
inlineoverridevirtual

This function initialize the convergence criteria.

Parameters
rModelPartThe model part of interest

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

◆ KRATOS_CLASS_POINTER_DEFINITION()

template<class TSparseSpace , class TDenseSpace >
Kratos::MPCContactCriteria< TSparseSpace, TDenseSpace >::KRATOS_CLASS_POINTER_DEFINITION ( MPCContactCriteria< TSparseSpace, TDenseSpace >  )

Pointer definition of MPCContactCriteria.

◆ Name()

template<class TSparseSpace , class TDenseSpace >
static std::string Kratos::MPCContactCriteria< TSparseSpace, TDenseSpace >::Name ( )
inlinestatic

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

Returns
The name of the class

◆ PostCriteria()

template<class TSparseSpace , class TDenseSpace >
bool Kratos::MPCContactCriteria< TSparseSpace, TDenseSpace >::PostCriteria ( ModelPart rModelPart,
DofsArrayType rDofSet,
const TSystemMatrixType rA,
const TSystemVectorType rDx,
const TSystemVectorType rb 
)
inlineoverridevirtual

Compute relative and absolute error.

Parameters
rModelPartReference to the ModelPart containing the contact problem.
rDofSetReference to the container of the problem's degrees of freedom (stored by the BuilderAndSolver)
rASystem matrix (unused)
rDxVector of results (variations on nodal variables)
rbRHS vector (residual)
Returns
true if convergence is achieved, false otherwise

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

◆ PreCriteria()

template<class TSparseSpace , class TDenseSpace >
bool Kratos::MPCContactCriteria< TSparseSpace, TDenseSpace >::PreCriteria ( ModelPart rModelPart,
DofsArrayType rDofSet,
const TSystemMatrixType rA,
const TSystemVectorType rDx,
const TSystemVectorType rb 
)
inlineoverridevirtual

Criterias that need to be called before getting the solution.

Parameters
rModelPartReference to the ModelPart containing the contact problem.
rDofSetReference to the container of the problem's degrees of freedom (stored by the BuilderAndSolver)
rASystem matrix (unused)
rDxVector of results (variations on nodal variables)
rbRHS vector (residual)
Returns
true if convergence is achieved, false otherwise

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

◆ PrintData()

template<class TSparseSpace , class TDenseSpace >
void Kratos::MPCContactCriteria< TSparseSpace, TDenseSpace >::PrintData ( std::ostream &  rOStream) const
inlineoverridevirtual

Print object's data.

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

◆ PrintInfo()

template<class TSparseSpace , class TDenseSpace >
void Kratos::MPCContactCriteria< TSparseSpace, TDenseSpace >::PrintInfo ( std::ostream &  rOStream) const
inlineoverridevirtual

Print information about this object.

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


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