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

Strategy for solving generalized eigenvalue problems. More...

#include <harmonic_analysis_strategy.hpp>

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

Public Member Functions

Life Cycle
 HarmonicAnalysisStrategy (ModelPart &rModelPart, SchemePointerType pScheme, BuilderAndSolverPointerType pBuilderAndSolver, bool UseMaterialDampingFlag=false)
 Constructor. More...
 
 HarmonicAnalysisStrategy (const HarmonicAnalysisStrategy &Other)=delete
 Deleted copy constructor. More...
 
 ~HarmonicAnalysisStrategy () override
 Destructor. More...
 
Operations
void SetIsInitialized (bool val)
 
bool GetIsInitialized () const
 
void SetScheme (SchemePointerType pScheme)
 
SchemePointerTypepGetScheme ()
 
void SetBuilderAndSolver (BuilderAndSolverPointerType pNewBuilderAndSolver)
 
BuilderAndSolverPointerTypepGetBuilderAndSolver ()
 
void SetReformDofSetAtEachStepFlag (bool flag)
 
bool GetReformDofSetAtEachStepFlag () const
 
void SetUseMaterialDampingFlag (bool flag)
 
bool GetUseMaterialDampingFlag () const
 
void SetEchoLevel (int Level) override
 Set verbosity level of the solving strategy. More...
 
void Initialize () override
 Initialization to be performed once before using the strategy. More...
 
bool SolveSolutionStep () override
 Solves the current step. This function returns true if a solution has been found, false otherwise. More...
 
void Clear () override
 Clear the strategy. More...
 
int Check () override
 Check whether initial input is valid. 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 ()
 
BaseType::Pointer Create (ModelPart &rModelPart, Parameters ThisParameters) const override
 Create method. More...
 
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...
 
std::string Info () const override
 Turn back information as a string. More...
 
 KRATOS_CLASS_POINTER_DEFINITION (ImplicitSolvingStrategy)
 
Parameters GetDefaultParameters () const override
 This method provides the defaults parameters to avoid conflicts between the different constructors. More...
 
- 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 ()
 
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 (SolvingStrategy)
 
virtual void Predict ()
 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...
 
virtual double Solve ()
 The problem of interest is solved. More...
 
virtual bool IsConverged ()
 This should be considered as a "post solution" convergence check which is useful for coupled analysis. More...
 
virtual void CalculateOutputData ()
 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...
 
virtual void InitializeSolutionStep ()
 Performs all the required operations that should be done (for each step) before solving the solution step. More...
 
virtual void FinalizeSolutionStep ()
 Performs all the required operations that should be done (for each step) after solving the solution step. 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...
 
virtual TSystemMatrixTypeGetSystemMatrix ()
 This method returns the LHS matrix. More...
 
virtual TSystemVectorTypeGetSystemVector ()
 This method returns the RHS vector. More...
 
virtual TSystemVectorTypeGetSolutionVector ()
 This method returns the solution vector. More...
 

Type Definitions

typedef ImplicitSolvingStrategy< TSparseSpace, TDenseSpace, TLinearSolver > BaseType
 
typedef BaseType::TSchemeType::Pointer SchemePointerType
 
typedef BaseType::TBuilderAndSolverType::Pointer BuilderAndSolverPointerType
 
typedef TDenseSpace DenseSpaceType
 
typedef TDenseSpace::VectorType DenseVectorType
 
typedef TDenseSpace::MatrixType DenseMatrixType
 
typedef TDenseSpace::MatrixPointerType DenseMatrixPointerType
 
typedef TSparseSpace SparseSpaceType
 
typedef TSparseSpace::VectorPointerType SparseVectorPointerType
 
typedef std::complex< doubleComplexType
 
typedef DenseVector< ComplexTypeComplexVectorType
 
 KRATOS_CLASS_POINTER_DEFINITION (HarmonicAnalysisStrategy)
 

Additional Inherited Members

- 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
 
- 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::ImplicitSolvingStrategy< TSparseSpace, TDenseSpace, TLinearSolver >
void AssignSettings (const Parameters ThisParameters) override
 This method assigns settings to member variables. More...
 
- 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::ImplicitSolvingStrategy< TSparseSpace, TDenseSpace, TLinearSolver >
int mRebuildLevel
 
bool mStiffnessMatrixIsBuilt
 The current rebuild level. More...
 
- Protected Attributes inherited from Kratos::SolvingStrategy< TSparseSpace, TDenseSpace >
int mEchoLevel
 

Detailed Description

template<class TSparseSpace, class TDenseSpace, class TLinearSolver>
class Kratos::HarmonicAnalysisStrategy< TSparseSpace, TDenseSpace, TLinearSolver >

Strategy for solving generalized eigenvalue problems.

Member Typedef Documentation

◆ BaseType

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
typedef ImplicitSolvingStrategy<TSparseSpace, TDenseSpace, TLinearSolver> Kratos::HarmonicAnalysisStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::BaseType

◆ BuilderAndSolverPointerType

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
typedef BaseType::TBuilderAndSolverType::Pointer Kratos::HarmonicAnalysisStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::BuilderAndSolverPointerType

◆ ComplexType

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
typedef std::complex<double> Kratos::HarmonicAnalysisStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::ComplexType

◆ ComplexVectorType

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
typedef DenseVector<ComplexType> Kratos::HarmonicAnalysisStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::ComplexVectorType

◆ DenseMatrixPointerType

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
typedef TDenseSpace::MatrixPointerType Kratos::HarmonicAnalysisStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::DenseMatrixPointerType

◆ DenseMatrixType

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
typedef TDenseSpace::MatrixType Kratos::HarmonicAnalysisStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::DenseMatrixType

◆ DenseSpaceType

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
typedef TDenseSpace Kratos::HarmonicAnalysisStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::DenseSpaceType

◆ DenseVectorType

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
typedef TDenseSpace::VectorType Kratos::HarmonicAnalysisStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::DenseVectorType

◆ SchemePointerType

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
typedef BaseType::TSchemeType::Pointer Kratos::HarmonicAnalysisStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::SchemePointerType

◆ SparseSpaceType

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
typedef TSparseSpace Kratos::HarmonicAnalysisStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::SparseSpaceType

◆ SparseVectorPointerType

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
typedef TSparseSpace::VectorPointerType Kratos::HarmonicAnalysisStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::SparseVectorPointerType

Constructor & Destructor Documentation

◆ HarmonicAnalysisStrategy() [1/2]

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
Kratos::HarmonicAnalysisStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::HarmonicAnalysisStrategy ( ModelPart rModelPart,
SchemePointerType  pScheme,
BuilderAndSolverPointerType  pBuilderAndSolver,
bool  UseMaterialDampingFlag = false 
)
inline

Constructor.

◆ HarmonicAnalysisStrategy() [2/2]

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
Kratos::HarmonicAnalysisStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::HarmonicAnalysisStrategy ( const HarmonicAnalysisStrategy< TSparseSpace, TDenseSpace, TLinearSolver > &  Other)
delete

Deleted copy constructor.

◆ ~HarmonicAnalysisStrategy()

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

Destructor.

Member Function Documentation

◆ Check()

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
int Kratos::HarmonicAnalysisStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::Check ( )
inlineoverridevirtual

Check whether initial input is valid.

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

◆ Clear()

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

Clear the strategy.

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

◆ GetIsInitialized()

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
bool Kratos::HarmonicAnalysisStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::GetIsInitialized ( ) const
inline

◆ GetReformDofSetAtEachStepFlag()

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
bool Kratos::HarmonicAnalysisStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::GetReformDofSetAtEachStepFlag ( ) const
inline

◆ GetUseMaterialDampingFlag()

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
bool Kratos::HarmonicAnalysisStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::GetUseMaterialDampingFlag ( ) const
inline

◆ Initialize()

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
void Kratos::HarmonicAnalysisStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::Initialize ( void  )
inlineoverridevirtual

Initialization to be performed once before using the strategy.

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

◆ KRATOS_CLASS_POINTER_DEFINITION()

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

◆ pGetBuilderAndSolver()

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
BuilderAndSolverPointerType& Kratos::HarmonicAnalysisStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::pGetBuilderAndSolver ( )
inline

◆ pGetScheme()

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
SchemePointerType& Kratos::HarmonicAnalysisStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::pGetScheme ( )
inline

◆ SetBuilderAndSolver()

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
void Kratos::HarmonicAnalysisStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::SetBuilderAndSolver ( BuilderAndSolverPointerType  pNewBuilderAndSolver)
inline

◆ SetEchoLevel()

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
void Kratos::HarmonicAnalysisStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::SetEchoLevel ( int  Level)
inlineoverridevirtual

Set verbosity level of the solving strategy.

  • 0 -> mute... no echo at all
  • 1 -> print time and basic information
  • 2 -> print linear solver data
  • 3 -> print debug information

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

◆ SetIsInitialized()

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
void Kratos::HarmonicAnalysisStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::SetIsInitialized ( bool  val)
inline

◆ SetReformDofSetAtEachStepFlag()

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
void Kratos::HarmonicAnalysisStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::SetReformDofSetAtEachStepFlag ( bool  flag)
inline

◆ SetScheme()

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
void Kratos::HarmonicAnalysisStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::SetScheme ( SchemePointerType  pScheme)
inline

◆ SetUseMaterialDampingFlag()

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
void Kratos::HarmonicAnalysisStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::SetUseMaterialDampingFlag ( bool  flag)
inline

◆ SolveSolutionStep()

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >
bool Kratos::HarmonicAnalysisStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::SolveSolutionStep ( )
inlineoverridevirtual

Solves the current step. This function returns true if a solution has been found, false otherwise.

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


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