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

#include <formfinding_strategy.hpp>

Inheritance diagram for Kratos::FormfindingStrategy< TSparseSpace, TDenseSpace, TLinearSolver >:
Collaboration diagram for Kratos::FormfindingStrategy< TSparseSpace, TDenseSpace, TLinearSolver >:

Type Definitions

typedef ConvergenceCriteria< TSparseSpace, TDenseSpace > TConvergenceCriteriaType
 
typedef ResidualBasedNewtonRaphsonStrategy< TSparseSpace, TDenseSpace, TLinearSolver > BaseType
 
typedef BaseType::TBuilderAndSolverType TBuilderAndSolverType
 
typedef BaseType::TSchemeType TSchemeType
 
typedef BaseType::TSystemMatrixType TSystemMatrixType
 
typedef BaseType::TSystemVectorType TSystemVectorType
 
typedef GidIO IterationIOType
 
typedef Kratos::unique_ptr< IterationIOTypeIterationIOPointerType
 
 KRATOS_CLASS_POINTER_DEFINITION (FormfindingStrategy)
 

Life Cycle

 FormfindingStrategy (ModelPart &model_part, typename TSchemeType::Pointer pScheme, typename TConvergenceCriteriaType::Pointer pNewConvergenceCriteria, typename TBuilderAndSolverType::Pointer pNewBuilderAndSolver, ModelPart &rFormFindingModelPart, bool WriteFormFoundGeometryFile, const std::string &rPrintingFormat, Parameters ProjectionSetting, int MaxIterations=30, bool CalculateReactions=false, bool ReformDofSetAtEachStep=false, bool MoveMeshFlag=false)
 
 ~FormfindingStrategy ()=default
 
static void WriteFormFoundMdpa (ModelPart &rModelPart)
 

Additional Inherited Members

- Public Types inherited from Kratos::ResidualBasedNewtonRaphsonStrategy< TSparseSpace, TDenseSpace, TLinearSolver >
typedef ConvergenceCriteria< TSparseSpace, TDenseSpace > TConvergenceCriteriaType
 
typedef SolvingStrategy< TSparseSpace, TDenseSpace > SolvingStrategyType
 
typedef ImplicitSolvingStrategy< TSparseSpace, TDenseSpace, TLinearSolver > BaseType
 
typedef ResidualBasedNewtonRaphsonStrategy< TSparseSpace, TDenseSpace, TLinearSolver > ClassType
 
typedef BaseType::TBuilderAndSolverType TBuilderAndSolverType
 
typedef BaseType::TDataType TDataType
 
typedef TSparseSpace SparseSpaceType
 
typedef BaseType::TSchemeType TSchemeType
 
typedef BaseType::DofsArrayType DofsArrayType
 
typedef BaseType::TSystemMatrixType TSystemMatrixType
 
typedef BaseType::TSystemVectorType TSystemVectorType
 
typedef BaseType::LocalSystemVectorType LocalSystemVectorType
 
typedef BaseType::LocalSystemMatrixType LocalSystemMatrixType
 
typedef BaseType::TSystemMatrixPointerType TSystemMatrixPointerType
 
typedef BaseType::TSystemVectorPointerType TSystemVectorPointerType
 
- Public Types inherited from Kratos::ImplicitSolvingStrategy< TSparseSpace, TDenseSpace, TLinearSolver >
typedef SolvingStrategy< TSparseSpace, TDenseSpace > BaseType
 
typedef BaseType::TDataType TDataType
 
typedef BaseType::TSystemMatrixType TSystemMatrixType
 
typedef BaseType::TSystemVectorType TSystemVectorType
 
typedef BaseType::TSystemMatrixPointerType TSystemMatrixPointerType
 
typedef BaseType::TSystemVectorPointerType TSystemVectorPointerType
 
typedef BaseType::LocalSystemMatrixType LocalSystemMatrixType
 
typedef BaseType::LocalSystemVectorType LocalSystemVectorType
 
typedef Scheme< TSparseSpace, TDenseSpace > TSchemeType
 
typedef BuilderAndSolver< TSparseSpace, TDenseSpace, TLinearSolver > TBuilderAndSolverType
 
typedef ImplicitSolvingStrategy< TSparseSpace, TDenseSpace, TLinearSolver > ClassType
 
typedef BaseType::TDofType TDofType
 
typedef BaseType::DofsArrayType DofsArrayType
 
typedef BaseType::NodesArrayType NodesArrayType
 
typedef BaseType::ElementsArrayType ElementsArrayType
 
typedef BaseType::ConditionsArrayType ConditionsArrayType
 
- Public Types inherited from Kratos::SolvingStrategy< TSparseSpace, TDenseSpace >
typedef TSparseSpace::DataType TDataType
 
typedef TSparseSpace::MatrixType TSystemMatrixType
 
typedef TSparseSpace::VectorType TSystemVectorType
 
typedef TSparseSpace::MatrixPointerType TSystemMatrixPointerType
 
typedef TSparseSpace::VectorPointerType TSystemVectorPointerType
 
typedef TDenseSpace::MatrixType LocalSystemMatrixType
 
typedef TDenseSpace::VectorType LocalSystemVectorType
 
typedef SolvingStrategy< TSparseSpace, TDenseSpace > ClassType
 
typedef ModelPart::DofType TDofType
 
typedef ModelPart::DofsArrayType DofsArrayType
 
typedef ModelPart::NodesContainerType NodesArrayType
 
typedef ModelPart::ElementsContainerType ElementsArrayType
 
typedef ModelPart::ConditionsContainerType ConditionsArrayType
 
- Public Member Functions inherited from Kratos::ResidualBasedNewtonRaphsonStrategy< TSparseSpace, TDenseSpace, TLinearSolver >
TSystemMatrixTypeGetSystemMatrix () override
 This method returns the LHS matrix. More...
 
TSystemVectorTypeGetSystemVector () override
 This method returns the RHS vector. More...
 
TSystemVectorTypeGetSolutionVector () override
 This method returns the solution vector. More...
 
void SetKeepSystemConstantDuringIterations (bool Value)
 Set method for the flag mKeepSystemConstantDuringIterations. More...
 
bool GetKeepSystemConstantDuringIterations ()
 Get method for the flag mKeepSystemConstantDuringIterations. More...
 
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...
 
 KRATOS_CLASS_POINTER_DEFINITION (ResidualBasedNewtonRaphsonStrategy)
 
 ResidualBasedNewtonRaphsonStrategy ()
 Default constructor. More...
 
 ResidualBasedNewtonRaphsonStrategy (ModelPart &rModelPart)
 Default constructor. (with parameters) More...
 
 ResidualBasedNewtonRaphsonStrategy (ModelPart &rModelPart, Parameters ThisParameters)
 Default constructor. (with parameters) More...
 
 ResidualBasedNewtonRaphsonStrategy (ModelPart &rModelPart, typename TSchemeType::Pointer pScheme, typename TLinearSolver::Pointer pNewLinearSolver, typename TConvergenceCriteriaType::Pointer pNewConvergenceCriteria, int MaxIterations=30, bool CalculateReactions=false, bool ReformDofSetAtEachStep=false, bool MoveMeshFlag=false)
 
 ResidualBasedNewtonRaphsonStrategy (ModelPart &rModelPart, typename TSchemeType::Pointer pScheme, typename TConvergenceCriteriaType::Pointer pNewConvergenceCriteria, typename TBuilderAndSolverType::Pointer pNewBuilderAndSolver, int MaxIterations=30, bool CalculateReactions=false, bool ReformDofSetAtEachStep=false, bool MoveMeshFlag=false)
 Constructor specifying the builder and solver. More...
 
 ResidualBasedNewtonRaphsonStrategy (ModelPart &rModelPart, typename TSchemeType::Pointer pScheme, typename TLinearSolver::Pointer pNewLinearSolver, typename TConvergenceCriteriaType::Pointer pNewConvergenceCriteria, typename TBuilderAndSolverType::Pointer pNewBuilderAndSolver, int MaxIterations=30, bool CalculateReactions=false, bool ReformDofSetAtEachStep=false, bool MoveMeshFlag=false)
 Constructor specifying the builder and solver. More...
 
 ResidualBasedNewtonRaphsonStrategy (ModelPart &rModelPart, typename TSchemeType::Pointer pScheme, typename TLinearSolver::Pointer pNewLinearSolver, typename TConvergenceCriteriaType::Pointer pNewConvergenceCriteria, Parameters Settings)
 
 ResidualBasedNewtonRaphsonStrategy (ModelPart &rModelPart, typename TSchemeType::Pointer pScheme, typename TConvergenceCriteriaType::Pointer pNewConvergenceCriteria, typename TBuilderAndSolverType::Pointer pNewBuilderAndSolver, Parameters Settings)
 Constructor specifying the builder and solver and using Parameters. More...
 
 ResidualBasedNewtonRaphsonStrategy (ModelPart &rModelPart, typename TSchemeType::Pointer pScheme, typename TLinearSolver::Pointer pNewLinearSolver, typename TConvergenceCriteriaType::Pointer pNewConvergenceCriteria, typename TBuilderAndSolverType::Pointer pNewBuilderAndSolver, Parameters Settings)
 Constructor specifying the builder and solver and using Parameters. More...
 
 ~ResidualBasedNewtonRaphsonStrategy () override
 Destructor. More...
 
void SetScheme (typename TSchemeType::Pointer pScheme)
 Set method for the time scheme. More...
 
TSchemeType::Pointer GetScheme ()
 Get method for the time scheme. More...
 
void SetBuilderAndSolver (typename TBuilderAndSolverType::Pointer pNewBuilderAndSolver)
 Set method for the builder and solver. More...
 
TBuilderAndSolverType::Pointer GetBuilderAndSolver ()
 Get method for the builder and solver. More...
 
void SetInitializePerformedFlag (bool InitializePerformedFlag=true)
 This method sets the flag mInitializeWasPerformed. More...
 
bool GetInitializePerformedFlag ()
 This method gets the flag mInitializeWasPerformed. More...
 
void SetCalculateReactionsFlag (bool CalculateReactionsFlag)
 This method sets the flag mCalculateReactionsFlag. More...
 
bool GetCalculateReactionsFlag ()
 This method returns the flag mCalculateReactionsFlag. More...
 
void SetUseOldStiffnessInFirstIterationFlag (bool UseOldStiffnessInFirstIterationFlag)
 This method sets the flag mFullUpdateFlag. More...
 
bool GetUseOldStiffnessInFirstIterationFlag ()
 This method returns the flag mFullUpdateFlag. More...
 
void SetReformDofSetAtEachStepFlag (bool Flag)
 This method sets the flag mReformDofSetAtEachStep. More...
 
bool GetReformDofSetAtEachStepFlag ()
 This method returns the flag mReformDofSetAtEachStep. More...
 
void SetMaxIterationNumber (unsigned int MaxIterationNumber)
 This method sets the flag mMaxIterationNumber. More...
 
unsigned int GetMaxIterationNumber ()
 This method gets the flag mMaxIterationNumber. More...
 
void SetEchoLevel (int Level) override
 It sets the level of echo for the solving strategy. More...
 
SolvingStrategyType::Pointer Create (ModelPart &rModelPart, Parameters ThisParameters) const override
 Create method. More...
 
void Predict () override
 Operation to predict the solution ... if it is not called a trivial predictor is used in which the values of the solution step of interest are assumed equal to the old values. More...
 
void Initialize () override
 Initialization of member variables and prior operations. More...
 
void Clear () override
 Clears the internal storage. More...
 
bool IsConverged () override
 This should be considered as a "post solution" convergence check which is useful for coupled analysis - the convergence criteria used is the one used inside the "solve" step. More...
 
void CalculateOutputData () override
 This operations should be called before printing the results when non trivial results (e.g. stresses) Need to be calculated given the solution of the step. More...
 
void InitializeSolutionStep () override
 Performs all the required operations that should be done (for each step) before solving the solution step. More...
 
bool SolveSolutionStep () override
 Solves the current step. This function returns true if a solution has been found, false otherwise. More...
 
int Check () override
 Function to perform expensive checks. More...
 
Parameters GetDefaultParameters () const override
 This method provides the defaults parameters to avoid conflicts between the different constructors. More...
 
- Public Member Functions inherited from Kratos::ImplicitSolvingStrategy< TSparseSpace, TDenseSpace, TLinearSolver >
 ImplicitSolvingStrategy ()
 Default constructor. More...
 
 ImplicitSolvingStrategy (ModelPart &rModelPart, Parameters ThisParameters)
 Default constructor. (with parameters) More...
 
 ImplicitSolvingStrategy (ModelPart &rModelPart, bool MoveMeshFlag=false)
 Default constructor. More...
 
virtual ~ImplicitSolvingStrategy ()
 
void SetRebuildLevel (int Level) override
 This sets the build level. More...
 
int GetRebuildLevel () const override
 This returns the build level. More...
 
void SetStiffnessMatrixIsBuilt (const bool StiffnessMatrixIsBuilt)
 This method sets the flag mStiffnessMatrixIsBuilt. More...
 
bool GetStiffnessMatrixIsBuilt () const
 This method gets the flag mStiffnessMatrixIsBuilt. More...
 
 KRATOS_CLASS_POINTER_DEFINITION (ImplicitSolvingStrategy)
 
- Public Member Functions inherited from Kratos::SolvingStrategy< TSparseSpace, TDenseSpace >
 SolvingStrategy ()
 Default constructor. More...
 
 SolvingStrategy (ModelPart &rModelPart, Parameters ThisParameters)
 Default constructor. (with parameters) More...
 
 SolvingStrategy (ModelPart &rModelPart, bool MoveMeshFlag=false)
 Default constructor. More...
 
virtual ~SolvingStrategy ()
 
 KRATOS_CLASS_POINTER_DEFINITION (SolvingStrategy)
 
virtual double Solve ()
 The problem of interest is solved. More...
 
int GetEchoLevel ()
 This returns the level of echo for the solving strategy. More...
 
void SetMoveMeshFlag (bool Flag)
 This function sets the flag that says if the mesh is moved. More...
 
bool MoveMeshFlag ()
 This function returns the flag that says if the mesh is moved. More...
 
bool GetMoveMeshFlag ()
 This function returns the flag that says if the mesh is moved. More...
 
virtual void MoveMesh ()
 This function is designed to move the mesh. More...
 
ModelPartGetModelPart ()
 Operations to get the pointer to the model. More...
 
const ModelPartGetModelPart () const
 Operations to get the pointer to the model. More...
 
virtual double GetResidualNorm ()
 Operations to get the residual norm. More...
 
- Static Public Member Functions inherited from Kratos::ResidualBasedNewtonRaphsonStrategy< TSparseSpace, TDenseSpace, TLinearSolver >
static std::string Name ()
 Returns the name of the class as used in the settings (snake_case format) More...
 
- Static Public Member Functions inherited from Kratos::ImplicitSolvingStrategy< TSparseSpace, TDenseSpace, TLinearSolver >
static std::string Name ()
 Returns the name of the class as used in the settings (snake_case format) More...
 
- Static Public Member Functions inherited from Kratos::SolvingStrategy< TSparseSpace, TDenseSpace >
static std::string Name ()
 Returns the name of the class as used in the settings (snake_case format) More...
 
- Protected Member Functions inherited from Kratos::ResidualBasedNewtonRaphsonStrategy< TSparseSpace, TDenseSpace, TLinearSolver >
virtual void MaxIterationsExceeded ()
 This method prints information after reach the max number of iterations. More...
 
void AssignSettings (const Parameters ThisParameters) override
 This method assigns settings to member variables. More...
 
void WriteDofInfo (std::string FileName, const TSystemVectorType &rDX)
 
 ResidualBasedNewtonRaphsonStrategy (const ResidualBasedNewtonRaphsonStrategy &Other)
 
Protected Operations
- Protected Member Functions inherited from Kratos::SolvingStrategy< TSparseSpace, TDenseSpace >
virtual Parameters ValidateAndAssignParameters (Parameters ThisParameters, const Parameters DefaultParameters) const
 This method validate and assign default parameters. More...
 
- Protected Attributes inherited from Kratos::ResidualBasedNewtonRaphsonStrategy< TSparseSpace, TDenseSpace, TLinearSolver >
TSchemeType::Pointer mpScheme = nullptr
 
TBuilderAndSolverType::Pointer mpBuilderAndSolver = nullptr
 The pointer to the time scheme employed. More...
 
TConvergenceCriteriaType::Pointer mpConvergenceCriteria = nullptr
 The pointer to the builder and solver employed. More...
 
TSystemVectorPointerType mpDx
 The pointer to the convergence criteria employed. More...
 
TSystemVectorPointerType mpb
 The increment in the solution. More...
 
TSystemMatrixPointerType mpA
 The RHS vector of the system of equations. More...
 
bool mReformDofSetAtEachStep
 The LHS matrix of the system of equations. More...
 
bool mCalculateReactionsFlag
 Flag telling if it is needed or not to compute the reactions. More...
 
bool mUseOldStiffnessInFirstIteration = false
 Flag telling if a full update of the database will be performed at the first iteration. More...
 
unsigned int mMaxIterationNumber
 
bool mInitializeWasPerformed
 The maximum number of iterations, 30 by default. More...
 
bool mKeepSystemConstantDuringIterations
 Flag to set as initialized the strategy. More...
 
- Protected Attributes inherited from Kratos::ImplicitSolvingStrategy< TSparseSpace, TDenseSpace, TLinearSolver >
int mRebuildLevel
 
bool mStiffnessMatrixIsBuilt
 The current rebuild level. More...
 
- Protected Attributes inherited from Kratos::SolvingStrategy< TSparseSpace, TDenseSpace >
int mEchoLevel
 

Member Typedef Documentation

◆ BaseType

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
typedef ResidualBasedNewtonRaphsonStrategy<TSparseSpace, TDenseSpace, TLinearSolver> Kratos::FormfindingStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::BaseType

◆ IterationIOPointerType

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
typedef Kratos::unique_ptr<IterationIOType> Kratos::FormfindingStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::IterationIOPointerType

◆ IterationIOType

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
typedef GidIO Kratos::FormfindingStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::IterationIOType

◆ TBuilderAndSolverType

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
typedef BaseType::TBuilderAndSolverType Kratos::FormfindingStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::TBuilderAndSolverType

◆ TConvergenceCriteriaType

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
typedef ConvergenceCriteria<TSparseSpace, TDenseSpace> Kratos::FormfindingStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::TConvergenceCriteriaType

◆ TSchemeType

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
typedef BaseType::TSchemeType Kratos::FormfindingStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::TSchemeType

◆ TSystemMatrixType

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

◆ TSystemVectorType

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

Constructor & Destructor Documentation

◆ FormfindingStrategy()

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
Kratos::FormfindingStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::FormfindingStrategy ( ModelPart model_part,
typename TSchemeType::Pointer  pScheme,
typename TConvergenceCriteriaType::Pointer  pNewConvergenceCriteria,
typename TBuilderAndSolverType::Pointer  pNewBuilderAndSolver,
ModelPart rFormFindingModelPart,
bool  WriteFormFoundGeometryFile,
const std::string &  rPrintingFormat,
Parameters  ProjectionSetting,
int  MaxIterations = 30,
bool  CalculateReactions = false,
bool  ReformDofSetAtEachStep = false,
bool  MoveMeshFlag = false 
)
inline

Constructor.

◆ ~FormfindingStrategy()

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
Kratos::FormfindingStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::~FormfindingStrategy ( )
default

Member Function Documentation

◆ KRATOS_CLASS_POINTER_DEFINITION()

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

◆ WriteFormFoundMdpa()

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
static void Kratos::FormfindingStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::WriteFormFoundMdpa ( ModelPart rModelPart)
inlinestatic

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