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

BDF integration scheme (for dynamic problems) More...

#include <shallow_water_residual_based_bdf_scheme.h>

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

Public Member Functions

Life Cycle
 ShallowWaterResidualBasedBDFScheme (const std::size_t Order=2, bool UpdateVelocities=false)
 
 ShallowWaterResidualBasedBDFScheme (Parameters ThisParameters)
 
 ShallowWaterResidualBasedBDFScheme (ShallowWaterResidualBasedBDFScheme &rOther)
 
BaseType::Pointer Clone () override
 
 ~ShallowWaterResidualBasedBDFScheme () override
 
Operations
void Update (ModelPart &rModelPart, DofsArrayType &rDofSet, TSystemMatrixType &rA, TSystemVectorType &rDx, TSystemVectorType &rb) override
 Performing the update of the solution within newton iteration. More...
 
void Predict (ModelPart &rModelPart, DofsArrayType &rDofSet, TSystemMatrixType &rA, TSystemVectorType &rDx, TSystemVectorType &rb) override
 Performing the prediction of the solution. More...
 
void CalculateSystemContributions (Element &rCurrentElement, LocalSystemMatrixType &rLHS_Contribution, LocalSystemVectorType &rRHS_Contribution, Element::EquationIdVectorType &rEquationId, const ProcessInfo &rCurrentProcessInfo) override
 This function is designed to be called in the builder and solver to introduce the selected time integration scheme. More...
 
void CalculateRHSContribution (Element &rCurrentElement, LocalSystemVectorType &rRHS_Contribution, Element::EquationIdVectorType &rEquationId, const ProcessInfo &rCurrentProcessInfo) override
 This function is designed to calculate just the RHS contribution. More...
 
void CalculateSystemContributions (Condition &rCurrentCondition, LocalSystemMatrixType &rLHS_Contribution, LocalSystemVectorType &rRHS_Contribution, Element::EquationIdVectorType &rEquationId, const ProcessInfo &rCurrentProcessInfo) override
 This function is designed to be called in the builder and solver to introduce the selected time integration scheme. More...
 
void CalculateRHSContribution (Condition &rCurrentCondition, LocalSystemVectorType &rRHS_Contribution, Element::EquationIdVectorType &rEquationId, const ProcessInfo &rCurrentProcessInfo) override
 This function is designed to calculate just the RHS contribution. More...
 
void Initialize (ModelPart &rModelPart) override
 Initialize the nodal area and the derivatives recovery. More...
 
void InitializeNonLinIteration (ModelPart &rModelPart, TSystemMatrixType &rA, TSystemVectorType &rDx, TSystemVectorType &rb) override
 Calculate the global projection of the dispersive field. More...
 
void Clear () override
 Free memory allocated by this class. More...
 
Parameters GetDefaultParameters () const override
 This method provides the defaults parameters to avoid conflicts between the different constructors. More...
 
Input and output
std::string Info () const override
 Turn back information as a string. More...
 
- Public Member Functions inherited from Kratos::ResidualBasedBDFScheme< TSparseSpace, TDenseSpace >
 ResidualBasedBDFScheme (const std::size_t Order=2)
 Constructor. The BDF method. More...
 
 ResidualBasedBDFScheme (ResidualBasedBDFScheme &rOther)
 
 ~ResidualBasedBDFScheme () override
 
void InitializeSolutionStep (ModelPart &rModelPart, TSystemMatrixType &rA, TSystemVectorType &rDx, TSystemVectorType &rb) override
 It initializes time step solution. Only for reasons if the time step solution is restarted. More...
 
int Check (const ModelPart &rModelPart) const override
 This function is designed to be called once to perform all the checks needed on the input provided. 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 (ResidualBasedBDFScheme)
 
- Public Member Functions inherited from Kratos::ResidualBasedImplicitTimeScheme< TSparseSpace, TDenseSpace >
 ResidualBasedImplicitTimeScheme ()
 
 ResidualBasedImplicitTimeScheme (Parameters ThisParameters)
 Constructor. The implicit method method. More...
 
 ResidualBasedImplicitTimeScheme (ResidualBasedImplicitTimeScheme &rOther)
 
 ~ResidualBasedImplicitTimeScheme () override
 
void InitializeSolutionStep (ModelPart &rModelPart, TSystemMatrixType &rA, TSystemVectorType &rDx, TSystemVectorType &rb) override
 It initializes time step solution. Only for reasons if the time step solution is restarted. More...
 
int Check (const ModelPart &rModelPart) const override
 This function is designed to be called once to perform all the checks needed on the input provided. 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 (ResidualBasedImplicitTimeScheme)
 
- 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 ()
 
 KRATOS_CLASS_POINTER_DEFINITION (Scheme)
 Pointer definition of Scheme. More...
 
virtual ClassType::Pointer Create (Parameters ThisParameters) const
 Create 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 FinalizeNonLinIteration (ModelPart &rModelPart, TSystemMatrixType &A, TSystemVectorType &Dx, TSystemVectorType &b)
 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...
 
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 int Check (ModelPart &rModelPart)
 
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...
 

Protected Member Functions

Protected Operations
Parameters ValidateAndAssignParameters (Parameters ThisParameters, const Parameters DefaultParameters) const override
 This method validate and assign default parameters. More...
 
void AssignSettings (const Parameters ThisParameters) override
 This method assigns settings to member variables. More...
 
void UpdateFirstDerivative (NodesArrayType::iterator itNode) override
 Updating first time derivative. More...
 
void UpdateSecondDerivative (NodesArrayType::iterator itNode) override
 Updating second time derivative. More...
 
void UpdateVelocities (ModelPart &rModelPart)
 Updating the velocities. More...
 
void AddDynamicsToLHS (LocalSystemMatrixType &rLHS_Contribution, LocalSystemMatrixType &rD, LocalSystemMatrixType &rM, const ProcessInfo &rCurrentProcessInfo) override
 It adds the dynamic LHS contribution of the elements. More...
 
void AddDynamicsToRHS (Element &rElement, LocalSystemVectorType &rRHS_Contribution, LocalSystemMatrixType &rD, LocalSystemMatrixType &rM, const ProcessInfo &rCurrentProcessInfo) override
 It adds the dynamic RHS contribution of the elements. More...
 
void AddDynamicsToRHS (Condition &rCondition, LocalSystemVectorType &rRHS_Contribution, LocalSystemMatrixType &rD, LocalSystemMatrixType &rM, const ProcessInfo &rCurrentProcessInfo) override
 It adds the dynamic RHS contribution of the condition. More...
 
void ApplyLaplacianBoundaryConditions (ModelPart &rModelPart)
 
- Protected Member Functions inherited from Kratos::ResidualBasedBDFScheme< TSparseSpace, TDenseSpace >
void UpdateDerivatives (ModelPart &rModelPart, DofsArrayType &rDofSet, TSystemMatrixType &rA, TSystemVectorType &rDx, TSystemVectorType &rb)
 Performing the update of the derivatives. More...
 
template<class TObjectType >
void TemplateAddDynamicsToRHS (TObjectType &rObject, LocalSystemVectorType &rRHS_Contribution, LocalSystemMatrixType &rD, LocalSystemMatrixType &rM, const ProcessInfo &rCurrentProcessInfo)
 It adds the dynamic RHS contribution of the objects. More...
 
Protected Operations
Protected Operations

Protected Attributes

Protected member Variables
TSparseSpace::DofUpdaterPointerType mpDofUpdater = TSparseSpace::CreateDofUpdater()
 
FlowRateSlipToolType mRotationTool
 
bool mUpdateVelocities
 
bool mProjectDispersiveField
 
std::vector< const Variable< double > * > mVariables
 
std::vector< const Variable< double > * > mDerivativeVariables
 
- Protected Attributes inherited from Kratos::ResidualBasedBDFScheme< TSparseSpace, TDenseSpace >
const std::size_t mOrder
 
Vector mBDF
 The integration order. More...
 
GeneralVectors mVector
 The BDF coefficients. More...
 
Kratos::unique_ptr< TimeDiscretization::BDFmpBDFUtility
 The structure containing the derivatives. More...
 
- Protected Attributes inherited from Kratos::ResidualBasedImplicitTimeScheme< TSparseSpace, TDenseSpace >
GeneralMatrices mMatrix
 
- 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...
 

Type Definitions

typedef Scheme< TSparseSpace, TDenseSpace > BaseType
 
typedef ResidualBasedBDFScheme< TSparseSpace, TDenseSpace > BDFBaseType
 
typedef BDFBaseType::DofsArrayType DofsArrayType
 
typedef BDFBaseType::TSystemMatrixType TSystemMatrixType
 
typedef BDFBaseType::TSystemVectorType TSystemVectorType
 
typedef BDFBaseType::LocalSystemVectorType LocalSystemVectorType
 
typedef BDFBaseType::LocalSystemMatrixType LocalSystemMatrixType
 
typedef ModelPart::NodesContainerType NodesArrayType
 
typedef ModelPart::NodeType NodeType
 
typedef FlowRateSlipUtility< LocalSystemMatrixType, LocalSystemVectorType, doubleFlowRateSlipToolType
 
 KRATOS_CLASS_POINTER_DEFINITION (ShallowWaterResidualBasedBDFScheme)
 

Additional Inherited Members

- Public Types inherited from Kratos::ResidualBasedBDFScheme< TSparseSpace, TDenseSpace >
typedef Scheme< TSparseSpace, TDenseSpace > BaseType
 
typedef BaseType::Pointer BaseTypePointer
 
typedef ResidualBasedImplicitTimeScheme< TSparseSpace, TDenseSpace > ImplicitBaseType
 
typedef ImplicitBaseType::TDataType TDataType
 
typedef ImplicitBaseType::DofsArrayType DofsArrayType
 
typedef Element::DofsVectorType DofsVectorType
 
typedef ImplicitBaseType::TSystemMatrixType TSystemMatrixType
 
typedef ImplicitBaseType::TSystemVectorType TSystemVectorType
 
typedef ImplicitBaseType::LocalSystemVectorType LocalSystemVectorType
 
typedef ImplicitBaseType::LocalSystemMatrixType LocalSystemMatrixType
 
typedef ModelPart::NodesContainerType NodesArrayType
 
- Public Types inherited from Kratos::ResidualBasedImplicitTimeScheme< TSparseSpace, TDenseSpace >
typedef Scheme< TSparseSpace, TDenseSpace > BaseType
 Base class definition. More...
 
typedef BaseType::DofsArrayType DofsArrayType
 DoF array type definition. More...
 
typedef Element::DofsVectorType DofsVectorType
 DoF vector type definition. More...
 
typedef BaseType::TDataType TDataType
 Data type definition. More...
 
typedef BaseType::TSystemMatrixType TSystemMatrixType
 Matrix type definition. More...
 
typedef BaseType::TSystemVectorType TSystemVectorType
 Vector type definition. More...
 
typedef BaseType::LocalSystemVectorType LocalSystemVectorType
 Local system matrix type definition. More...
 
typedef BaseType::LocalSystemMatrixType LocalSystemMatrixType
 Local system vector type definition. More...
 
typedef ModelPart::NodesContainerType NodesArrayType
 Nodes containers definition. More...
 
typedef ModelPart::ElementsContainerType ElementsArrayType
 Elements containers definition. More...
 
typedef ModelPart::ConditionsContainerType ConditionsArrayType
 Conditions containers definition. More...
 
typedef std::size_t IndexType
 Index type definition. More...
 
- 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...
 
- 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...
 
- Static Public Attributes inherited from Kratos::ResidualBasedBDFScheme< TSparseSpace, TDenseSpace >
static constexpr double ZeroTolerance = std::numeric_limits<double>::epsilon()
 Definition of epsilon. More...
 

Detailed Description

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

BDF integration scheme (for dynamic problems)

The \(n\) order Backward Differentiation Formula (BDF) method is a two step \(n\) order accurate method. This scheme is designed to solve a system of the type:

\[ \mathbf{M} \frac{du_{n0}}{dt} + \mathbf{K} u_{n0} = \mathbf{f}_{ext} \]

Author
Miguel Maso Sotomayor

Member Typedef Documentation

◆ BaseType

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

◆ BDFBaseType

template<class TSparseSpace , class TDenseSpace >
typedef ResidualBasedBDFScheme<TSparseSpace,TDenseSpace> Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::BDFBaseType

◆ DofsArrayType

template<class TSparseSpace , class TDenseSpace >
typedef BDFBaseType::DofsArrayType Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::DofsArrayType

◆ FlowRateSlipToolType

template<class TSparseSpace , class TDenseSpace >
typedef FlowRateSlipUtility<LocalSystemMatrixType,LocalSystemVectorType,double> Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::FlowRateSlipToolType

◆ LocalSystemMatrixType

template<class TSparseSpace , class TDenseSpace >
typedef BDFBaseType::LocalSystemMatrixType Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::LocalSystemMatrixType

◆ LocalSystemVectorType

template<class TSparseSpace , class TDenseSpace >
typedef BDFBaseType::LocalSystemVectorType Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::LocalSystemVectorType

◆ NodesArrayType

template<class TSparseSpace , class TDenseSpace >
typedef ModelPart::NodesContainerType Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::NodesArrayType

◆ NodeType

template<class TSparseSpace , class TDenseSpace >
typedef ModelPart::NodeType Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::NodeType

◆ TSystemMatrixType

template<class TSparseSpace , class TDenseSpace >
typedef BDFBaseType::TSystemMatrixType Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::TSystemMatrixType

◆ TSystemVectorType

template<class TSparseSpace , class TDenseSpace >
typedef BDFBaseType::TSystemVectorType Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::TSystemVectorType

Constructor & Destructor Documentation

◆ ShallowWaterResidualBasedBDFScheme() [1/3]

template<class TSparseSpace , class TDenseSpace >
Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::ShallowWaterResidualBasedBDFScheme ( const std::size_t  Order = 2,
bool  UpdateVelocities = false 
)
inlineexplicit

◆ ShallowWaterResidualBasedBDFScheme() [2/3]

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

◆ ShallowWaterResidualBasedBDFScheme() [3/3]

template<class TSparseSpace , class TDenseSpace >
Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::ShallowWaterResidualBasedBDFScheme ( ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace > &  rOther)
inlineexplicit

◆ ~ShallowWaterResidualBasedBDFScheme()

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

Member Function Documentation

◆ AddDynamicsToLHS()

template<class TSparseSpace , class TDenseSpace >
void Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::AddDynamicsToLHS ( LocalSystemMatrixType rLHS_Contribution,
LocalSystemMatrixType rD,
LocalSystemMatrixType rM,
const ProcessInfo rCurrentProcessInfo 
)
inlineoverrideprotectedvirtual

It adds the dynamic LHS contribution of the elements.

Parameters
rLHS_ContributionThe dynamic contribution for the LHS
rDThe damping matrix
rMThe mass matrix
rCurrentProcessInfoThe current process info instance

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

◆ AddDynamicsToRHS() [1/2]

template<class TSparseSpace , class TDenseSpace >
void Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::AddDynamicsToRHS ( Condition rCondition,
LocalSystemVectorType rRHS_Contribution,
LocalSystemMatrixType rD,
LocalSystemMatrixType rM,
const ProcessInfo rCurrentProcessInfo 
)
inlineoverrideprotectedvirtual

It adds the dynamic RHS contribution of the condition.

Parameters
rConditionThe condition to compute
RHS_ContributionThe dynamic contribution for the RHS
DThe damping matrix
MThe mass matrix
rCurrentProcessInfoThe current process info instance

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

◆ AddDynamicsToRHS() [2/2]

template<class TSparseSpace , class TDenseSpace >
void Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::AddDynamicsToRHS ( Element rElement,
LocalSystemVectorType rRHS_Contribution,
LocalSystemMatrixType rD,
LocalSystemMatrixType rM,
const ProcessInfo rCurrentProcessInfo 
)
inlineoverrideprotectedvirtual

It adds the dynamic RHS contribution of the elements.

Parameters
rElementThe element to compute
RHS_ContributionThe dynamic contribution for the RHS
DThe damping matrix
MThe mass matrix
rCurrentProcessInfoThe current process info instance

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

◆ ApplyLaplacianBoundaryConditions()

template<class TSparseSpace , class TDenseSpace >
void Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::ApplyLaplacianBoundaryConditions ( ModelPart rModelPart)
inlineprotected

◆ AssignSettings()

template<class TSparseSpace , class TDenseSpace >
void Kratos::ShallowWaterResidualBasedBDFScheme< 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::Scheme< TSparseSpace, TDenseSpace >.

◆ CalculateRHSContribution() [1/2]

template<class TSparseSpace , class TDenseSpace >
void Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::CalculateRHSContribution ( Condition rCurrentCondition,
LocalSystemVectorType rRHS_Contribution,
Element::EquationIdVectorType rEquationId,
const ProcessInfo rCurrentProcessInfo 
)
inlineoverridevirtual

This function is designed to calculate just the RHS contribution.

Parameters
rCurrentConditionThe condition to compute
rRHS_ContributionThe RHS vector contribution
rEquationIdThe ID's of the element degrees of freedom
rCurrentProcessInfoThe current process info instance

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

◆ CalculateRHSContribution() [2/2]

template<class TSparseSpace , class TDenseSpace >
void Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::CalculateRHSContribution ( Element rCurrentElement,
LocalSystemVectorType rRHS_Contribution,
Element::EquationIdVectorType rEquationId,
const ProcessInfo rCurrentProcessInfo 
)
inlineoverridevirtual

This function is designed to calculate just the RHS contribution.

Parameters
rCurrentElementThe element to compute
rRHS_ContributionThe RHS vector contribution
rEquationIdThe ID's of the element degrees of freedom
rCurrentProcessInfoThe current process info instance

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

◆ CalculateSystemContributions() [1/2]

template<class TSparseSpace , class TDenseSpace >
void Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::CalculateSystemContributions ( Condition rCurrentCondition,
LocalSystemMatrixType rLHS_Contribution,
LocalSystemVectorType rRHS_Contribution,
Element::EquationIdVectorType rEquationId,
const ProcessInfo rCurrentProcessInfo 
)
inlineoverridevirtual

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

Parameters
rCurrentConditionThe condition to compute
rLHS_ContributionThe LHS matrix contribution
rRHS_ContributionThe RHS vector contribution
rEquationIdThe ID's of the element degrees of freedom
rCurrentProcessInfoThe current process info instance

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

◆ CalculateSystemContributions() [2/2]

template<class TSparseSpace , class TDenseSpace >
void Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::CalculateSystemContributions ( Element rCurrentElement,
LocalSystemMatrixType rLHS_Contribution,
LocalSystemVectorType rRHS_Contribution,
Element::EquationIdVectorType rEquationId,
const ProcessInfo rCurrentProcessInfo 
)
inlineoverridevirtual

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

Parameters
rCurrentElementThe element to compute
rLHS_ContributionThe LHS matrix contribution
rRHS_ContributionThe RHS vector contribution
rEquationIdThe ID's of the element degrees of freedom
rCurrentProcessInfoThe current process info instance

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

◆ Clear()

template<class TSparseSpace , class TDenseSpace >
void Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::Clear ( )
inlineoverridevirtual

Free memory allocated by this class.

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

◆ Clone()

template<class TSparseSpace , class TDenseSpace >
BaseType::Pointer Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::Clone ( )
inlineoverridevirtual

◆ GetDefaultParameters()

template<class TSparseSpace , class TDenseSpace >
Parameters Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::GetDefaultParameters ( ) const
inlineoverridevirtual

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

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

◆ Info()

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

Turn back information as a string.

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

◆ Initialize()

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

Initialize the nodal area and the derivatives recovery.

The nodal area is used to apply the explicit prediction.

Parameters
rModelPartThe model part of the problem to solve

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

◆ InitializeNonLinIteration()

template<class TSparseSpace , class TDenseSpace >
void Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::InitializeNonLinIteration ( ModelPart rModelPart,
TSystemMatrixType rA,
TSystemVectorType rDx,
TSystemVectorType rb 
)
inlineoverridevirtual

Calculate the global projection of the dispersive field.

Parameters
rModelPartThe model part of the problem to solve
rALHS matrix
rDxIncremental update of primary variables
rbRHS Vector

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

◆ KRATOS_CLASS_POINTER_DEFINITION()

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

◆ Predict()

template<class TSparseSpace , class TDenseSpace >
void Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::Predict ( ModelPart rModelPart,
DofsArrayType rDofSet,
TSystemMatrixType rA,
TSystemVectorType rDx,
TSystemVectorType rb 
)
inlineoverridevirtual

Performing the prediction of the solution.

It predicts the solution for the current step

Parameters
rModelPartThe model of the problem to solve
rDofSetset of all primary variables
rALHS matrix
rDxIncremental update of primary variables
rbRHS Vector

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

◆ Update()

template<class TSparseSpace , class TDenseSpace >
void Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::Update ( ModelPart rModelPart,
DofsArrayType rDofSet,
TSystemMatrixType rA,
TSystemVectorType rDx,
TSystemVectorType rb 
)
inlineoverridevirtual

Performing the update of the solution within newton iteration.

Parameters
rModelPartThe model of the problem to solve
rDofSetSet of all primary variables
rALHS matrix
rDxincremental update of primary variables
rbRHS Vector

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

◆ UpdateFirstDerivative()

template<class TSparseSpace , class TDenseSpace >
void Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::UpdateFirstDerivative ( NodesArrayType::iterator  itNode)
inlineoverrideprotectedvirtual

Updating first time derivative.

Parameters
itNodethe node interator

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

◆ UpdateSecondDerivative()

template<class TSparseSpace , class TDenseSpace >
void Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::UpdateSecondDerivative ( NodesArrayType::iterator  itNode)
inlineoverrideprotectedvirtual

Updating second time derivative.

Parameters
itNodethe node interator

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

◆ UpdateVelocities()

template<class TSparseSpace , class TDenseSpace >
void Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::UpdateVelocities ( ModelPart rModelPart)
inlineprotected

Updating the velocities.

Parameters
rModelPartThe model part to compute

◆ ValidateAndAssignParameters()

template<class TSparseSpace , class TDenseSpace >
Parameters Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::ValidateAndAssignParameters ( Parameters  ThisParameters,
const Parameters  DefaultParameters 
) const
inlineoverrideprotectedvirtual

This method validate and assign default parameters.

Parameters
rParametersParameters to be validated
DefaultParametersThe default parameters
Returns
Returns validated Parameters

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

Member Data Documentation

◆ mDerivativeVariables

template<class TSparseSpace , class TDenseSpace >
std::vector<const Variable<double>*> Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::mDerivativeVariables
protected

◆ mpDofUpdater

template<class TSparseSpace , class TDenseSpace >
TSparseSpace::DofUpdaterPointerType Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::mpDofUpdater = TSparseSpace::CreateDofUpdater()
protected

◆ mProjectDispersiveField

template<class TSparseSpace , class TDenseSpace >
bool Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::mProjectDispersiveField
protected

◆ mRotationTool

template<class TSparseSpace , class TDenseSpace >
FlowRateSlipToolType Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::mRotationTool
protected

◆ mUpdateVelocities

template<class TSparseSpace , class TDenseSpace >
bool Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::mUpdateVelocities
protected

◆ mVariables

template<class TSparseSpace , class TDenseSpace >
std::vector<const Variable<double>*> Kratos::ShallowWaterResidualBasedBDFScheme< TSparseSpace, TDenseSpace >::mVariables
protected

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