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

This convergence criteria checks the variable dofs. More...

#include <dofs_criterion.hpp>

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

Public Member Functions

Life Cycle
 DofsCriterion (DataType RatioTolerance, DataType AbsoluteTolerance)
 Constructor. More...
 
 DofsCriterion (const VariableScalarType &rScalarVariable, DataType RatioTolerance, DataType AbsoluteTolerance)
 Constructor. More...
 
 DofsCriterion (const VariableVectorType &rVectorVariable, DataType RatioTolerance, DataType AbsoluteTolerance)
 Constructor. More...
 
 DofsCriterion (DofsCriterion const &rOther)
 Copy constructor. More...
 
 ~DofsCriterion () override
 Destructor. More...
 
Operators
bool PostCriteria (ModelPart &rModelPart, DofsArrayType &rDofSet, const SystemMatrixType &rA, const SystemVectorType &rDx, const SystemVectorType &rb) override
 
- Public Member Functions inherited from Kratos::ConvergenceCriterion< TSparseSpace, TDenseSpace >
 ConvergenceCriterion ()
 Constructor. More...
 
 ConvergenceCriterion (ConvergenceCriterion const &rOther)
 Copy contructor. More...
 
 ~ConvergenceCriterion () override
 Destructor. More...
 
virtual void SetEchoLevel (int Level)
 
int GetEchoLevel ()
 
virtual bool PreCriteria (ModelPart &rModelPart, DofsArrayType &rDofSet, const SystemMatrixType &rA, const SystemVectorType &rDx, const SystemVectorType &rb)
 
virtual void InitializeSolutionStep (ModelPart &rModelPart, DofsArrayType &rDofSet, const SystemMatrixType &rA, const SystemVectorType &rDx, const SystemVectorType &rb)
 
virtual void FinalizeSolutionStep (ModelPart &rModelPart, DofsArrayType &rDofSet, const SystemMatrixType &rA, const SystemVectorType &rDx, const SystemVectorType &rb)
 
virtual int Check (ModelPart &rModelPart)
 
 KRATOS_CLASS_POINTER_DEFINITION (ConvergenceCriterion)
 Pointer definition of ConvergenceCriterion. More...
 
- 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
 
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...
 
 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...
 

Type Definitions

typedef ConvergenceCriterion< TSparseSpace, TDenseSpace > BaseType
 
typedef BaseType::LocalFlagType LocalFlagType
 
typedef BaseType::DataType DataType
 
typedef BaseType::DofsArrayType DofsArrayType
 
typedef BaseType::SystemMatrixType SystemMatrixType
 
typedef BaseType::SystemVectorType SystemVectorType
 
typedef array_1d< double, 3 > VectorType
 
typedef Variable< doubleVectorComponentType
 
typedef Variable< VectorTypeVariableVectorType
 
typedef Variable< doubleVariableScalarType
 
typedef const VariableVectorTypeVariableVectorPointer
 
typedef const VariableScalarTypeVariableScalarPointer
 
 KRATOS_CLASS_POINTER_DEFINITION (DofsCriterion)
 Pointer definition of DofsCriterion. More...
 

Additional Inherited Members

- Public Types inherited from Kratos::ConvergenceCriterion< TSparseSpace, TDenseSpace >
typedef CriterionLocalFlags LocalFlagType
 
typedef TSparseSpace::DataType DataType
 
typedef ModelPart::DofsArrayType DofsArrayType
 
typedef TSparseSpace::MatrixType SystemMatrixType
 
typedef TSparseSpace::VectorType SystemVectorType
 
typedef TDenseSpace::MatrixType LocalSystemMatrixType
 
typedef TDenseSpace::VectorType LocalSystemVectorType
 
- 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)
 
- Protected Attributes inherited from Kratos::ConvergenceCriterion< TSparseSpace, TDenseSpace >
int mEchoLevel
 

Detailed Description

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

This convergence criteria checks the variable dofs.

Member Typedef Documentation

◆ BaseType

template<class TSparseSpace , class TDenseSpace >
typedef ConvergenceCriterion< TSparseSpace, TDenseSpace > Kratos::DofsCriterion< TSparseSpace, TDenseSpace >::BaseType

◆ DataType

template<class TSparseSpace , class TDenseSpace >
typedef BaseType::DataType Kratos::DofsCriterion< TSparseSpace, TDenseSpace >::DataType

◆ DofsArrayType

template<class TSparseSpace , class TDenseSpace >
typedef BaseType::DofsArrayType Kratos::DofsCriterion< TSparseSpace, TDenseSpace >::DofsArrayType

◆ LocalFlagType

template<class TSparseSpace , class TDenseSpace >
typedef BaseType::LocalFlagType Kratos::DofsCriterion< TSparseSpace, TDenseSpace >::LocalFlagType

◆ SystemMatrixType

template<class TSparseSpace , class TDenseSpace >
typedef BaseType::SystemMatrixType Kratos::DofsCriterion< TSparseSpace, TDenseSpace >::SystemMatrixType

◆ SystemVectorType

template<class TSparseSpace , class TDenseSpace >
typedef BaseType::SystemVectorType Kratos::DofsCriterion< TSparseSpace, TDenseSpace >::SystemVectorType

◆ VariableScalarPointer

template<class TSparseSpace , class TDenseSpace >
typedef const VariableScalarType* Kratos::DofsCriterion< TSparseSpace, TDenseSpace >::VariableScalarPointer

◆ VariableScalarType

template<class TSparseSpace , class TDenseSpace >
typedef Variable<double> Kratos::DofsCriterion< TSparseSpace, TDenseSpace >::VariableScalarType

◆ VariableVectorPointer

template<class TSparseSpace , class TDenseSpace >
typedef const VariableVectorType* Kratos::DofsCriterion< TSparseSpace, TDenseSpace >::VariableVectorPointer

◆ VariableVectorType

template<class TSparseSpace , class TDenseSpace >
typedef Variable<VectorType> Kratos::DofsCriterion< TSparseSpace, TDenseSpace >::VariableVectorType

◆ VectorComponentType

template<class TSparseSpace , class TDenseSpace >
typedef Variable<double> Kratos::DofsCriterion< TSparseSpace, TDenseSpace >::VectorComponentType

◆ VectorType

template<class TSparseSpace , class TDenseSpace >
typedef array_1d<double,3> Kratos::DofsCriterion< TSparseSpace, TDenseSpace >::VectorType

Constructor & Destructor Documentation

◆ DofsCriterion() [1/4]

template<class TSparseSpace , class TDenseSpace >
Kratos::DofsCriterion< TSparseSpace, TDenseSpace >::DofsCriterion ( DataType  RatioTolerance,
DataType  AbsoluteTolerance 
)
inline

Constructor.

◆ DofsCriterion() [2/4]

template<class TSparseSpace , class TDenseSpace >
Kratos::DofsCriterion< TSparseSpace, TDenseSpace >::DofsCriterion ( const VariableScalarType rScalarVariable,
DataType  RatioTolerance,
DataType  AbsoluteTolerance 
)
inline

Constructor.

◆ DofsCriterion() [3/4]

template<class TSparseSpace , class TDenseSpace >
Kratos::DofsCriterion< TSparseSpace, TDenseSpace >::DofsCriterion ( const VariableVectorType rVectorVariable,
DataType  RatioTolerance,
DataType  AbsoluteTolerance 
)
inline

Constructor.

◆ DofsCriterion() [4/4]

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

Copy constructor.

◆ ~DofsCriterion()

template<class TSparseSpace , class TDenseSpace >
Kratos::DofsCriterion< TSparseSpace, TDenseSpace >::~DofsCriterion ( )
inlineoverride

Destructor.

Member Function Documentation

◆ KRATOS_CLASS_POINTER_DEFINITION()

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

Pointer definition of DofsCriterion.

◆ PostCriteria()

template<class TSparseSpace , class TDenseSpace >
bool Kratos::DofsCriterion< TSparseSpace, TDenseSpace >::PostCriteria ( ModelPart rModelPart,
DofsArrayType rDofSet,
const SystemMatrixType rA,
const SystemVectorType rDx,
const SystemVectorType rb 
)
inlineoverridevirtual

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