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.
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Kratos::DamUPScheme< TSparseSpace, TDenseSpace > Class Template Reference

#include <dam_UP_scheme.hpp>

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

Public Types

typedef Scheme< TSparseSpace, TDenseSpace > BaseType
 
typedef BaseType::DofsArrayType DofsArrayType
 
typedef BaseType::TSystemMatrixType TSystemMatrixType
 
typedef BaseType::TSystemVectorType TSystemVectorType
 
typedef BaseType::LocalSystemVectorType LocalSystemVectorType
 
typedef BaseType::LocalSystemMatrixType LocalSystemMatrixType
 
- Public Types inherited from Kratos::Scheme< TSparseSpace, TDenseSpace >
using ClassType = Scheme< TSparseSpace, TDenseSpace >
 The definition of the current class. More...
 
using TDataType = typename TSparseSpace::DataType
 Data type definition. More...
 
using TSystemMatrixType = typename TSparseSpace::MatrixType
 Matrix type definition. More...
 
using TSystemVectorType = typename TSparseSpace::VectorType
 Vector type definition. More...
 
using LocalSystemMatrixType = typename TDenseSpace::MatrixType
 Local system matrix type definition. More...
 
using LocalSystemVectorType = typename TDenseSpace::VectorType
 Local system vector type definition. More...
 
using TDofType = Dof< double >
 DoF type definition. More...
 
using DofsArrayType = ModelPart::DofsArrayType
 DoF array type definition. More...
 
using ElementsArrayType = ModelPart::ElementsContainerType
 Elements containers definition. More...
 
using ConditionsArrayType = ModelPart::ConditionsContainerType
 Conditions containers definition. More...
 

Public Member Functions

 KRATOS_CLASS_POINTER_DEFINITION (DamUPScheme)
 
 DamUPScheme (double beta, double gamma, double rayleigh_m, double rayleigh_k)
 Constructor. More...
 
virtual ~DamUPScheme ()
 Destructor. More...
 
int Check (ModelPart &r_model_part) override
 
void Initialize (ModelPart &r_model_part) override
 This is the place to initialize the Scheme. More...
 
void InitializeSolutionStep (ModelPart &r_model_part, TSystemMatrixType &A, TSystemVectorType &Dx, TSystemVectorType &b) override
 Function called once at the beginning of each solution step. More...
 
void Predict (ModelPart &r_model_part, DofsArrayType &rDofSet, TSystemMatrixType &A, TSystemVectorType &Dx, TSystemVectorType &b) override
 Performing the prediction of the solution. More...
 
void InitializeNonLinIteration (ModelPart &r_model_part, TSystemMatrixType &A, TSystemVectorType &Dx, TSystemVectorType &b) override
 unction to be called when it is needed to initialize an iteration. It is designed to be called at the beginning of each non linear iteration More...
 
void FinalizeNonLinIteration (ModelPart &r_model_part, TSystemMatrixType &A, TSystemVectorType &Dx, TSystemVectorType &b) override
 Function to be called when it is needed to finalize an iteration. It is designed to be called at the end of each non linear iteration. More...
 
void CalculateSystemContributions (Element &rCurrentElement, LocalSystemMatrixType &LHS_Contribution, LocalSystemVectorType &RHS_Contribution, Element::EquationIdVectorType &EquationId, const ProcessInfo &CurrentProcessInfo) override
 This function is designed to be called in the builder and solver to introduce the selected time integration scheme. More...
 
void CalculateSystemContributions (Condition &rCurrentCondition, LocalSystemMatrixType &LHS_Contribution, LocalSystemVectorType &RHS_Contribution, Element::EquationIdVectorType &EquationId, const ProcessInfo &CurrentProcessInfo) override
 Functions totally analogous to the precedent but applied to the "condition" objects. More...
 
void Calculate_RHS_Contribution (Element &rCurrentElement, LocalSystemVectorType &RHS_Contribution, Element::EquationIdVectorType &EquationId, const ProcessInfo &CurrentProcessInfo)
 
void Calculate_RHS_Contribution (Condition &rCurrentCondition, LocalSystemVectorType &RHS_Contribution, Element::EquationIdVectorType &EquationId, const ProcessInfo &CurrentProcessInfo)
 
void Calculate_LHS_Contribution (Element &rCurrentElement, LocalSystemMatrixType &LHS_Contribution, Element::EquationIdVectorType &EquationId, const ProcessInfo &CurrentProcessInfo)
 
void Calculate_LHS_Contribution (Condition &rCurrentCondition, LocalSystemMatrixType &LHS_Contribution, Element::EquationIdVectorType &EquationId, const ProcessInfo &CurrentProcessInfo)
 
void Update (ModelPart &r_model_part, DofsArrayType &rDofSet, TSystemMatrixType &A, TSystemVectorType &Dx, TSystemVectorType &b) override
 Performing the update of the solution. More...
 
- Public Member Functions inherited from Kratos::Scheme< TSparseSpace, TDenseSpace >
 Scheme ()
 Default Constructor. More...
 
 Scheme (Parameters ThisParameters)
 Constructor with Parameters. More...
 
 Scheme (Scheme &rOther)
 
virtual ~Scheme ()
 
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 (Scheme)
 Pointer definition of Scheme. More...
 
virtual ClassType::Pointer Create (Parameters ThisParameters) const
 Create method. More...
 
virtual Pointer Clone ()
 Clone method. More...
 
bool SchemeIsInitialized ()
 This method returns if the scheme is initialized. More...
 
void SetSchemeIsInitialized (bool SchemeIsInitializedFlag=true)
 This method sets if the elements have been initialized or not (true by default) More...
 
bool ElementsAreInitialized ()
 This method returns if the elements are initialized. More...
 
void SetElementsAreInitialized (bool ElementsAreInitializedFlag=true)
 This method sets if the elements have been initialized or not (true by default) More...
 
bool ConditionsAreInitialized ()
 This method returns if the conditions are initialized. More...
 
void SetConditionsAreInitialized (bool ConditionsAreInitializedFlag=true)
 This method sets if the conditions have been initialized or not (true by default) More...
 
virtual void InitializeElements (ModelPart &rModelPart)
 This is the place to initialize the elements. More...
 
virtual void InitializeConditions (ModelPart &rModelPart)
 This is the place to initialize the conditions. More...
 
virtual void FinalizeSolutionStep (ModelPart &rModelPart, TSystemMatrixType &A, TSystemVectorType &Dx, TSystemVectorType &b)
 Function called once at the end of a solution step, after convergence is reached if an iterative process is needed. More...
 
virtual void CalculateOutputData (ModelPart &rModelPart, DofsArrayType &rDofSet, TSystemMatrixType &A, TSystemVectorType &Dx, TSystemVectorType &b)
 Functions to be called to prepare the data needed for the output of results. More...
 
virtual void CleanOutputData ()
 Functions that cleans the results data. More...
 
virtual void Clean ()
 This function is intended to be called at the end of the solution step to clean up memory storage not needed after the end of the solution step. More...
 
virtual void Clear ()
 Liberate internal storage. More...
 
virtual int Check (const ModelPart &rModelPart) const
 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...
 
virtual void CalculateRHSContribution (Element &rElement, LocalSystemVectorType &RHS_Contribution, Element::EquationIdVectorType &rEquationIdVector, const ProcessInfo &rCurrentProcessInfo)
 This function is designed to calculate just the RHS contribution. More...
 
virtual void CalculateRHSContribution (Condition &rCondition, LocalSystemVectorType &RHS_Contribution, Element::EquationIdVectorType &rEquationIdVector, const ProcessInfo &rCurrentProcessInfo)
 Functions totally analogous to the precedent but applied to the "condition" objects. More...
 
virtual void CalculateLHSContribution (Element &rElement, LocalSystemMatrixType &LHS_Contribution, Element::EquationIdVectorType &rEquationIdVector, const ProcessInfo &rCurrentProcessInfo)
 This function is designed to calculate just the LHS contribution. More...
 
virtual void CalculateLHSContribution (Condition &rCondition, LocalSystemMatrixType &LHS_Contribution, Element::EquationIdVectorType &rEquationIdVector, const ProcessInfo &rCurrentProcessInfo)
 Functions totally analogous to the precedent but applied to the "condition" objects. More...
 
virtual void EquationId (const Element &rElement, Element::EquationIdVectorType &rEquationId, const ProcessInfo &rCurrentProcessInfo)
 This method gets the eqaution id corresponding to the current element. More...
 
virtual void EquationId (const Condition &rCondition, Element::EquationIdVectorType &rEquationId, const ProcessInfo &rCurrentProcessInfo)
 Functions totally analogous to the precedent but applied to the "condition" objects. More...
 
virtual void GetDofList (const Element &rElement, Element::DofsVectorType &rDofList, const ProcessInfo &rCurrentProcessInfo)
 Function that returns the list of Degrees of freedom to be assembled in the system for a Given element. More...
 
virtual void GetDofList (const Condition &rCondition, Element::DofsVectorType &rDofList, const ProcessInfo &rCurrentProcessInfo)
 Function that returns the list of Degrees of freedom to be assembled in the system for a Given condition. More...
 
virtual Parameters GetDefaultParameters () const
 This method provides the defaults parameters to avoid conflicts between the different constructors. More...
 

Protected Member Functions

void UpdateVariablesDerivatives (ModelPart &r_model_part)
 
void AddDynamicsToLHS (LocalSystemMatrixType &LHS_Contribution, LocalSystemMatrixType &M, LocalSystemMatrixType &C, const ProcessInfo &CurrentProcessInfo)
 
void AddDynamicsToRHS (Element &rCurrentElement, LocalSystemVectorType &RHS_Contribution, LocalSystemMatrixType &M, LocalSystemMatrixType &C, const ProcessInfo &CurrentProcessInfo)
 
- Protected Member Functions inherited from Kratos::Scheme< TSparseSpace, TDenseSpace >
virtual Parameters ValidateAndAssignParameters (Parameters ThisParameters, const Parameters DefaultParameters) const
 This method validate and assign default parameters. More...
 
virtual void AssignSettings (const Parameters ThisParameters)
 This method assigns settings to member variables. More...
 

Protected Attributes

double mBeta
 Member Variables. More...
 
double mGamma
 
double mDeltaTime
 
double mrayleigh_m
 
double mrayleigh_k
 
std::vector< MatrixmMassMatrix
 
std::vector< VectormAccelerationVector
 
std::vector< MatrixmDampingMatrix
 
std::vector< VectormVelocityVector
 
- Protected Attributes inherited from Kratos::Scheme< TSparseSpace, TDenseSpace >
bool mSchemeIsInitialized
 
bool mElementsAreInitialized
 Flag to be used in controlling if the Scheme has been initialized or not. More...
 
bool mConditionsAreInitialized
 Flag taking in account if the elements were initialized correctly or not. More...
 

Additional Inherited Members

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

Member Typedef Documentation

◆ BaseType

template<class TSparseSpace , class TDenseSpace >
typedef Scheme<TSparseSpace,TDenseSpace> Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::BaseType

◆ DofsArrayType

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

◆ LocalSystemMatrixType

template<class TSparseSpace , class TDenseSpace >
typedef BaseType::LocalSystemMatrixType Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::LocalSystemMatrixType

◆ LocalSystemVectorType

template<class TSparseSpace , class TDenseSpace >
typedef BaseType::LocalSystemVectorType Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::LocalSystemVectorType

◆ TSystemMatrixType

template<class TSparseSpace , class TDenseSpace >
typedef BaseType::TSystemMatrixType Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::TSystemMatrixType

◆ TSystemVectorType

template<class TSparseSpace , class TDenseSpace >
typedef BaseType::TSystemVectorType Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::TSystemVectorType

Constructor & Destructor Documentation

◆ DamUPScheme()

template<class TSparseSpace , class TDenseSpace >
Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::DamUPScheme ( double  beta,
double  gamma,
double  rayleigh_m,
double  rayleigh_k 
)
inline

Constructor.

◆ ~DamUPScheme()

template<class TSparseSpace , class TDenseSpace >
virtual Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::~DamUPScheme ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ AddDynamicsToLHS()

template<class TSparseSpace , class TDenseSpace >
void Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::AddDynamicsToLHS ( LocalSystemMatrixType LHS_Contribution,
LocalSystemMatrixType M,
LocalSystemMatrixType C,
const ProcessInfo CurrentProcessInfo 
)
inlineprotected

◆ AddDynamicsToRHS()

template<class TSparseSpace , class TDenseSpace >
void Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::AddDynamicsToRHS ( Element rCurrentElement,
LocalSystemVectorType RHS_Contribution,
LocalSystemMatrixType M,
LocalSystemMatrixType C,
const ProcessInfo CurrentProcessInfo 
)
inlineprotected

◆ Calculate_LHS_Contribution() [1/2]

template<class TSparseSpace , class TDenseSpace >
void Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::Calculate_LHS_Contribution ( Condition rCurrentCondition,
LocalSystemMatrixType LHS_Contribution,
Element::EquationIdVectorType EquationId,
const ProcessInfo CurrentProcessInfo 
)
inline

◆ Calculate_LHS_Contribution() [2/2]

template<class TSparseSpace , class TDenseSpace >
void Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::Calculate_LHS_Contribution ( Element rCurrentElement,
LocalSystemMatrixType LHS_Contribution,
Element::EquationIdVectorType EquationId,
const ProcessInfo CurrentProcessInfo 
)
inline

◆ Calculate_RHS_Contribution() [1/2]

template<class TSparseSpace , class TDenseSpace >
void Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::Calculate_RHS_Contribution ( Condition rCurrentCondition,
LocalSystemVectorType RHS_Contribution,
Element::EquationIdVectorType EquationId,
const ProcessInfo CurrentProcessInfo 
)
inline

◆ Calculate_RHS_Contribution() [2/2]

template<class TSparseSpace , class TDenseSpace >
void Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::Calculate_RHS_Contribution ( Element rCurrentElement,
LocalSystemVectorType RHS_Contribution,
Element::EquationIdVectorType EquationId,
const ProcessInfo CurrentProcessInfo 
)
inline

◆ CalculateSystemContributions() [1/2]

template<class TSparseSpace , class TDenseSpace >
void Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::CalculateSystemContributions ( Condition rCondition,
LocalSystemMatrixType LHS_Contribution,
LocalSystemVectorType RHS_Contribution,
Element::EquationIdVectorType rEquationIdVector,
const ProcessInfo rCurrentProcessInfo 
)
inlineoverridevirtual

Functions totally analogous to the precedent but applied to the "condition" objects.

Parameters
rConditionThe condition to compute
LHS_ContributionThe LHS matrix contribution
RHS_ContributionThe RHS vector contribution
rEquationIdVectorThe ID's of the condition degrees of freedom
rCurrentProcessInfoThe current process info instance

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

◆ CalculateSystemContributions() [2/2]

template<class TSparseSpace , class TDenseSpace >
void Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::CalculateSystemContributions ( Element rElement,
LocalSystemMatrixType LHS_Contribution,
LocalSystemVectorType RHS_Contribution,
Element::EquationIdVectorType rEquationIdVector,
const ProcessInfo rCurrentProcessInfo 
)
inlineoverridevirtual

This function is designed to be called in the builder and solver to introduce the selected time integration scheme.

It "asks" the matrix needed to the element and performs the operations needed to introduce the selected time integration scheme. This function calculates at the same time the contribution to the LHS and to the RHS of the system

Parameters
rElementThe element to compute
LHS_ContributionThe LHS matrix contribution
RHS_ContributionThe RHS vector contribution
rEquationIdVectorThe ID's of the element degrees of freedom
rCurrentProcessInfoThe current process info instance

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

◆ Check()

template<class TSparseSpace , class TDenseSpace >
int Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::Check ( ModelPart r_model_part)
inlineoverridevirtual

◆ FinalizeNonLinIteration()

template<class TSparseSpace , class TDenseSpace >
void Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::FinalizeNonLinIteration ( ModelPart rModelPart,
TSystemMatrixType A,
TSystemVectorType Dx,
TSystemVectorType b 
)
inlineoverridevirtual

Function to be called when it is needed to finalize an iteration. It is designed to be called at the end of each non linear iteration.

Parameters
rModelPartThe model part of the problem to solve
ALHS matrix
DxIncremental update of primary variables
bRHS Vector

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

◆ Initialize()

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

This is the place to initialize the Scheme.

This is intended to be called just once when the strategy is initialized

Parameters
rModelPartThe model part of the problem to solve

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

◆ InitializeNonLinIteration()

template<class TSparseSpace , class TDenseSpace >
void Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::InitializeNonLinIteration ( ModelPart rModelPart,
TSystemMatrixType A,
TSystemVectorType Dx,
TSystemVectorType b 
)
inlineoverridevirtual

unction to be called when it is needed to initialize an iteration. It is designed to be called at the beginning of each non linear iteration

Note
Take care: the elemental function with the same name is NOT called here.
Warning
Must be defined in derived classes

The function is called in the builder for memory efficiency

Parameters
rModelPartThe model part of the problem to solve
ALHS matrix
DxIncremental update of primary variables
bRHS Vector

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

◆ InitializeSolutionStep()

template<class TSparseSpace , class TDenseSpace >
void Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::InitializeSolutionStep ( ModelPart rModelPart,
TSystemMatrixType A,
TSystemVectorType Dx,
TSystemVectorType b 
)
inlineoverridevirtual

Function called once at the beginning of each solution step.

The basic operations to be carried in there are the following:

  • managing variables to be kept constant over the time step (for example time-Scheme constants depending on the actual time step)
    Parameters
    rModelPartThe model part of the problem to solve
    ALHS matrix
    DxIncremental update of primary variables
    bRHS Vector

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

◆ KRATOS_CLASS_POINTER_DEFINITION()

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

◆ Predict()

template<class TSparseSpace , class TDenseSpace >
void Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::Predict ( ModelPart rModelPart,
DofsArrayType rDofSet,
TSystemMatrixType A,
TSystemVectorType Dx,
TSystemVectorType b 
)
inlineoverridevirtual

Performing the prediction of the solution.

Warning
Must be defined in derived classes
Parameters
rModelPartThe model part of the problem to solve
ALHS matrix
DxIncremental update of primary variables
bRHS Vector

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

◆ Update()

template<class TSparseSpace , class TDenseSpace >
void Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::Update ( ModelPart rModelPart,
DofsArrayType rDofSet,
TSystemMatrixType A,
TSystemVectorType Dx,
TSystemVectorType b 
)
inlineoverridevirtual

Performing the update of the solution.

Warning
Must be defined in derived classes
Parameters
rModelPartThe model part of the problem to solve
rDofSetSet of all primary variables
ALHS matrix
DxIncremental update of primary variables
bRHS Vector

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

◆ UpdateVariablesDerivatives()

template<class TSparseSpace , class TDenseSpace >
void Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::UpdateVariablesDerivatives ( ModelPart r_model_part)
inlineprotected

Member Data Documentation

◆ mAccelerationVector

template<class TSparseSpace , class TDenseSpace >
std::vector< Vector > Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::mAccelerationVector
protected

◆ mBeta

template<class TSparseSpace , class TDenseSpace >
double Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::mBeta
protected

Member Variables.

◆ mDampingMatrix

template<class TSparseSpace , class TDenseSpace >
std::vector< Matrix > Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::mDampingMatrix
protected

◆ mDeltaTime

template<class TSparseSpace , class TDenseSpace >
double Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::mDeltaTime
protected

◆ mGamma

template<class TSparseSpace , class TDenseSpace >
double Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::mGamma
protected

◆ mMassMatrix

template<class TSparseSpace , class TDenseSpace >
std::vector< Matrix > Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::mMassMatrix
protected

◆ mrayleigh_k

template<class TSparseSpace , class TDenseSpace >
double Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::mrayleigh_k
protected

◆ mrayleigh_m

template<class TSparseSpace , class TDenseSpace >
double Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::mrayleigh_m
protected

◆ mVelocityVector

template<class TSparseSpace , class TDenseSpace >
std::vector< Vector > Kratos::DamUPScheme< TSparseSpace, TDenseSpace >::mVelocityVector
protected

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