Short class definition. More...

#include <helmholtz_strategy.h>

Inheritance diagram for Kratos::HelmholtzStrategy< TSparseSpace, TDenseSpace, TLinearSolver >:

Collaboration diagram for Kratos::HelmholtzStrategy< TSparseSpace, TDenseSpace, TLinearSolver >:

Public Member Functions
Life Cycle
	HelmholtzStrategy (ModelPart &model_part, typename TLinearSolver::Pointer pNewLinearSolver, bool ReformDofSetAtEachStep=false, bool ComputeReactions=false, int EchoLevel=0, const double PoissonRatio=0.3)

virtual	~HelmholtzStrategy ()

void	Initialize () override
	Initialization of member variables and prior operations. More...

double	Solve () override
	The problem of interest is solved. More...

Inquiry
TSystemMatrixType &	GetSystemMatrix () override
	This method returns the LHS matrix. More...

TSystemVectorType &	GetSystemVector () override
	This method returns the RHS vector. More...

TSystemVectorType &	GetSolutionVector () override
	This method returns the solution vector. More...

void	ExportSystem ()

BaseType::Pointer	GetStrategy ()

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 void	Clear ()
	Clears the internal storage. 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...

virtual bool	SolveSolutionStep ()
	Solves the current step. This function returns true if a solution has been found, false otherwise. More...

virtual void	SetEchoLevel (const int Level)
	This sets the level of echo for the solving strategy. 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...

ModelPart &	GetModelPart ()
	Operations to get the pointer to the model. More...

const ModelPart &	GetModelPart () const
	Operations to get the pointer to the model. More...

virtual double	GetResidualNorm ()
	Operations to get the residual norm. More...

virtual int	Check ()
	Function to perform expensive checks. More...

Type Definitions
typedef ImplicitSolvingStrategy< TSparseSpace, TDenseSpace, TLinearSolver >	BaseType

typedef BaseType::TBuilderAndSolverType	TBuilderAndSolverType

typedef BaseType::TSystemMatrixType	TSystemMatrixType

typedef BaseType::TSystemVectorType	TSystemVectorType

typedef Scheme< TSparseSpace, TDenseSpace >	SchemeType

	KRATOS_CLASS_POINTER_DEFINITION (HelmholtzStrategy)

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::HelmholtzStrategy< TSparseSpace, TDenseSpace, TLinearSolver >

Short class definition.

Detail class definition.

Member Typedef Documentation

◆ BaseType

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >

typedef ImplicitSolvingStrategy<TSparseSpace, TDenseSpace, TLinearSolver> Kratos::HelmholtzStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::BaseType

◆ SchemeType

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >

typedef Scheme<TSparseSpace, TDenseSpace> Kratos::HelmholtzStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::SchemeType

◆ TBuilderAndSolverType

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >

typedef BaseType::TBuilderAndSolverType Kratos::HelmholtzStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::TBuilderAndSolverType

◆ TSystemMatrixType

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >

typedef BaseType::TSystemMatrixType Kratos::HelmholtzStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::TSystemMatrixType

◆ TSystemVectorType

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >

typedef BaseType::TSystemVectorType Kratos::HelmholtzStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::TSystemVectorType

Constructor & Destructor Documentation

◆ HelmholtzStrategy()

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >

Kratos::HelmholtzStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::HelmholtzStrategy	(	ModelPart &	model_part,
		typename TLinearSolver::Pointer	pNewLinearSolver,
		bool	ReformDofSetAtEachStep = `false`,
		bool	ComputeReactions = `false`,
		int	EchoLevel = `0`,
		const double	PoissonRatio = `0.3`
	)

inline

Constructor.

◆ ~HelmholtzStrategy()

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >

virtual Kratos::HelmholtzStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::~HelmholtzStrategy ( )

inlinevirtual

Member Function Documentation

◆ ExportSystem()

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >

void Kratos::HelmholtzStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::ExportSystem ( )

inline

◆ GetSolutionVector()

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >

TSystemVectorType& Kratos::HelmholtzStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::GetSolutionVector ( )

inlineoverridevirtual

This method returns the solution vector.

Returns: The Dx vector

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

◆ GetStrategy()

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >

BaseType::Pointer Kratos::HelmholtzStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::GetStrategy ( )

inline

◆ GetSystemMatrix()

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >

TSystemMatrixType& Kratos::HelmholtzStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::GetSystemMatrix ( )

inlineoverridevirtual

This method returns the LHS matrix.

Returns: The LHS matrix

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

◆ GetSystemVector()

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >

TSystemVectorType& Kratos::HelmholtzStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::GetSystemVector ( )

inlineoverridevirtual

This method returns the RHS vector.

Returns: The RHS vector

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

◆ Initialize()

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >

void Kratos::HelmholtzStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::Initialize ( void )

inlineoverridevirtual

Initialization of member variables and prior operations.

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

◆ KRATOS_CLASS_POINTER_DEFINITION()

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >

Kratos::HelmholtzStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::KRATOS_CLASS_POINTER_DEFINITION ( HelmholtzStrategy< TSparseSpace, TDenseSpace, TLinearSolver > )

Counted pointer of ClassName

◆ Solve()

template<class TSparseSpace , class TDenseSpace , class TLinearSolver >

double Kratos::HelmholtzStrategy< TSparseSpace, TDenseSpace, TLinearSolver >::Solve ( )

inlineoverridevirtual

The problem of interest is solved.

{ This function calls sequentially: Initialize(), InitializeSolutionStep(), Predict(), SolveSolutionStep() and FinalizeSolutionStep(). All those functions can otherwise be called separately. }

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

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

/home/runner/work/Documentation/Documentation/master/applications/OptimizationApplication/custom_strategies/strategies/helmholtz_strategy.h

Public Member Functions

Type Definitions

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ BaseType

◆ SchemeType

◆ TBuilderAndSolverType

◆ TSystemMatrixType

◆ TSystemVectorType

Constructor & Destructor Documentation

◆ HelmholtzStrategy()

◆ ~HelmholtzStrategy()

Member Function Documentation

◆ ExportSystem()

◆ GetSolutionVector()

◆ GetStrategy()

◆ GetSystemMatrix()

◆ GetSystemVector()

◆ Initialize()

◆ KRATOS_CLASS_POINTER_DEFINITION()

◆ Solve()

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