A scheme for the solution of a problem using Aitken iterations. More...

#include <trilinos_residualbased_incremental_aitken_static_scheme.h>

Inheritance diagram for Kratos::TrilinosResidualBasedIncrementalAitkenStaticScheme< TSparseSpace, TDenseSpace >:

Collaboration diagram for Kratos::TrilinosResidualBasedIncrementalAitkenStaticScheme< TSparseSpace, TDenseSpace >:

Public Member Functions
Life Cycle
	TrilinosResidualBasedIncrementalAitkenStaticScheme (double DefaultOmega)
	Default constructor. More...

virtual	~TrilinosResidualBasedIncrementalAitkenStaticScheme ()
	Destructor. More...

Operations
void	InitializeSolutionStep (ModelPart &r_model_part, TSystemMatrixType &A, TSystemVectorType &Dx, TSystemVectorType &b) override
	Initialize the iteration counter at the begining of each solution step. More...

void	Update (ModelPart &r_model_part, DofsArrayType &rDofSet, TSystemMatrixType &A, TSystemVectorType &Dx, TSystemVectorType &b) override
	Update the degrees of freedom of the problem using Aitken's accelerator. More...

void	Clear () override
	Liberate internal storage. More...

Public Member Functions inherited from Kratos::ResidualBasedIncrementalUpdateStaticScheme< TSparseSpace, TDenseSpace >
	ResidualBasedIncrementalUpdateStaticScheme (Parameters ThisParameters)
	Constructor. The pseudo static scheme (parameters) More...

	ResidualBasedIncrementalUpdateStaticScheme ()

	ResidualBasedIncrementalUpdateStaticScheme (ResidualBasedIncrementalUpdateStaticScheme &rOther)

	~ResidualBasedIncrementalUpdateStaticScheme () override

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 (ResidualBasedIncrementalUpdateStaticScheme)
	Pointer definition of ResidualBasedIncrementalUpdateStaticScheme. More...

BaseType::Pointer	Create (Parameters ThisParameters) const override
	Create method. 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 &rLHSContribution, LocalSystemVectorType &rRHSContribution, 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	CalculateSystemContributions (Condition &rCurrentCondition, LocalSystemMatrixType &rLHSContribution, LocalSystemVectorType &rRHSContribution, EquationIdVectorType &rEquationId, const ProcessInfo &rCurrentProcessInfo) override
	Functions totally analogous to the precedent but applied to the "condition" objects. More...

void	CalculateRHSContribution (Element &rCurrentElement, LocalSystemVectorType &rRHSContribution, EquationIdVectorType &rEquationId, const ProcessInfo &rCurrentProcessInfo) override
	This function is designed to calculate just the RHS contribution. More...

void	CalculateRHSContribution (Condition &rCurrentCondition, LocalSystemVectorType &rRHSContribution, EquationIdVectorType &rEquationId, const ProcessInfo &rCurrentProcessInfo) override
	Functions totally analogous to the precedent but applied to the "condition" objects. More...

void	CalculateLHSContribution (Element &rCurrentElement, LocalSystemMatrixType &rLHSContribution, EquationIdVectorType &rEquationId, const ProcessInfo &rCurrentProcessInfo) override
	This function is designed to calculate just the LHS contribution. 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::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 Pointer	Clone ()
	Clone method. More...

virtual void	Initialize (ModelPart &rModelPart)
	This is the place to initialize the Scheme. 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	InitializeNonLinIteration (ModelPart &rModelPart, TSystemMatrixType &A, TSystemVectorType &Dx, TSystemVectorType &b)
	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...

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 (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 int	Check (ModelPart &rModelPart)

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
double	CalculateOmega (TSystemVectorType &Dx)
	Calculate the value of the Aitken relaxation factor for the current iteration. More...

void	UpdateWithRelaxation (DofsArrayType &rDofSet, TSystemVectorType &Dx, const double Omega)

virtual void	InitializeDofImporter (DofsArrayType &rDofSet, TSystemVectorType &Dx)

Protected Access
Kratos::shared_ptr< Epetra_Import >	pGetImporter ()
	Get pointer Epetra_Import instance that can be used to import values from Dx to the owner of each Dof. More...

Protected Inquiry
bool	DofImporterIsInitialized () const

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...

Type Definitions
typedef ResidualBasedIncrementalUpdateStaticScheme< TSparseSpace, TDenseSpace >	BaseType

typedef BaseType::TDataType	TDataType

typedef BaseType::DofsArrayType	DofsArrayType

typedef BaseType::TSystemMatrixType	TSystemMatrixType

typedef BaseType::TSystemVectorType	TSystemVectorType

typedef Kratos::shared_ptr< TSystemVectorType >	SystemVectorPointerType

	KRATOS_CLASS_POINTER_DEFINITION (TrilinosResidualBasedIncrementalAitkenStaticScheme)
	Pointer definition of TrilinosResidualBasedIncrementalAitkenStaticScheme. More...

Additional Inherited Members
Public Types inherited from Kratos::ResidualBasedIncrementalUpdateStaticScheme< TSparseSpace, TDenseSpace >
typedef Scheme< TSparseSpace, TDenseSpace >	BaseType
	Base class definition. More...

typedef ResidualBasedIncrementalUpdateStaticScheme< TSparseSpace, TDenseSpace >	ClassType

typedef BaseType::DofsArrayType	DofsArrayType
	DoF array 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::ElementsContainerType	ElementsArrayType
	Elements containers definition. More...

typedef ModelPart::ConditionsContainerType	ConditionsArrayType
	Conditions containers definition. More...

typedef Element::EquationIdVectorType	EquationIdVectorType
	The definition of the vector containing the equation ids. 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::ResidualBasedIncrementalUpdateStaticScheme< TSparseSpace, TDenseSpace >
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::Scheme< TSparseSpace, TDenseSpace >
static std::string	Name ()
	Returns the name of the class as used in the settings (snake_case format) More...

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...

Detailed Description

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

A scheme for the solution of a problem using Aitken iterations.

Aitken's method intends to improve convergence by introducing a relaxation factor in the update of the solution after each iteration.

Member Typedef Documentation

◆ BaseType

template<class TSparseSpace , class TDenseSpace >

typedef ResidualBasedIncrementalUpdateStaticScheme<TSparseSpace,TDenseSpace> Kratos::TrilinosResidualBasedIncrementalAitkenStaticScheme< TSparseSpace, TDenseSpace >::BaseType

◆ DofsArrayType

template<class TSparseSpace , class TDenseSpace >

typedef BaseType::DofsArrayType Kratos::TrilinosResidualBasedIncrementalAitkenStaticScheme< TSparseSpace, TDenseSpace >::DofsArrayType

◆ SystemVectorPointerType

template<class TSparseSpace , class TDenseSpace >

typedef Kratos::shared_ptr< TSystemVectorType > Kratos::TrilinosResidualBasedIncrementalAitkenStaticScheme< TSparseSpace, TDenseSpace >::SystemVectorPointerType

◆ TDataType

template<class TSparseSpace , class TDenseSpace >

typedef BaseType::TDataType Kratos::TrilinosResidualBasedIncrementalAitkenStaticScheme< TSparseSpace, TDenseSpace >::TDataType

◆ TSystemMatrixType

template<class TSparseSpace , class TDenseSpace >

typedef BaseType::TSystemMatrixType Kratos::TrilinosResidualBasedIncrementalAitkenStaticScheme< TSparseSpace, TDenseSpace >::TSystemMatrixType

◆ TSystemVectorType

template<class TSparseSpace , class TDenseSpace >

typedef BaseType::TSystemVectorType Kratos::TrilinosResidualBasedIncrementalAitkenStaticScheme< TSparseSpace, TDenseSpace >::TSystemVectorType

Constructor & Destructor Documentation

◆ TrilinosResidualBasedIncrementalAitkenStaticScheme()

template<class TSparseSpace , class TDenseSpace >

Kratos::TrilinosResidualBasedIncrementalAitkenStaticScheme< TSparseSpace, TDenseSpace >::TrilinosResidualBasedIncrementalAitkenStaticScheme ( double DefaultOmega )

inline

Default constructor.

Parameters

DefaultOmega Default relaxation factor to use in the first iteration, where Aitken's factor cannot be computed. Use a value between 0 and 1.

◆ ~TrilinosResidualBasedIncrementalAitkenStaticScheme()

template<class TSparseSpace , class TDenseSpace >

virtual Kratos::TrilinosResidualBasedIncrementalAitkenStaticScheme< TSparseSpace, TDenseSpace >::~TrilinosResidualBasedIncrementalAitkenStaticScheme ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ CalculateOmega()

template<class TSparseSpace , class TDenseSpace >

double Kratos::TrilinosResidualBasedIncrementalAitkenStaticScheme< TSparseSpace, TDenseSpace >::CalculateOmega ( TSystemVectorType & Dx )

inlineprotected

Calculate the value of the Aitken relaxation factor for the current iteration.

◆ Clear()

template<class TSparseSpace , class TDenseSpace >

void Kratos::TrilinosResidualBasedIncrementalAitkenStaticScheme< TSparseSpace, TDenseSpace >::Clear ( )

inlineoverridevirtual

Liberate internal storage.

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

◆ DofImporterIsInitialized()

template<class TSparseSpace , class TDenseSpace >

bool Kratos::TrilinosResidualBasedIncrementalAitkenStaticScheme< TSparseSpace, TDenseSpace >::DofImporterIsInitialized ( ) const

inlineprotected

◆ InitializeDofImporter()

template<class TSparseSpace , class TDenseSpace >

virtual void Kratos::TrilinosResidualBasedIncrementalAitkenStaticScheme< TSparseSpace, TDenseSpace >::InitializeDofImporter	(	DofsArrayType &	rDofSet,
		TSystemVectorType &	Dx
	)

inlineprotectedvirtual

◆ InitializeSolutionStep()

template<class TSparseSpace , class TDenseSpace >

void Kratos::TrilinosResidualBasedIncrementalAitkenStaticScheme< TSparseSpace, TDenseSpace >::InitializeSolutionStep	(	ModelPart &	r_model_part,
		TSystemMatrixType &	A,
		TSystemVectorType &	Dx,
		TSystemVectorType &	b
	)

inlineoverridevirtual

Initialize the iteration counter at the begining of each solution step.

Parameters

r_model_part	The problem's ModelPart
A	System matrix
Dx	Solution vector (containing the increment of the unknowns obtained in the present iteration)
b	Right hand side vector

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

◆ KRATOS_CLASS_POINTER_DEFINITION()

template<class TSparseSpace , class TDenseSpace >

Kratos::TrilinosResidualBasedIncrementalAitkenStaticScheme< TSparseSpace, TDenseSpace >::KRATOS_CLASS_POINTER_DEFINITION ( TrilinosResidualBasedIncrementalAitkenStaticScheme< TSparseSpace, TDenseSpace > )

Pointer definition of TrilinosResidualBasedIncrementalAitkenStaticScheme.

◆ pGetImporter()

template<class TSparseSpace , class TDenseSpace >

Kratos::shared_ptr<Epetra_Import> Kratos::TrilinosResidualBasedIncrementalAitkenStaticScheme< TSparseSpace, TDenseSpace >::pGetImporter ( )

inlineprotected

Get pointer Epetra_Import instance that can be used to import values from Dx to the owner of each Dof.

Note: Important: always check that the Importer is initialized before calling using DofImporterIsInitialized or initialize it with InitializeDofImporter.

Returns: Importer

◆ Update()

template<class TSparseSpace , class TDenseSpace >

void Kratos::TrilinosResidualBasedIncrementalAitkenStaticScheme< TSparseSpace, TDenseSpace >::Update	(	ModelPart &	r_model_part,
		DofsArrayType &	rDofSet,
		TSystemMatrixType &	A,
		TSystemVectorType &	Dx,
		TSystemVectorType &	b
	)

inlineoverridevirtual

Update the degrees of freedom of the problem using Aitken's accelerator.

Parameters

r_model_part	The problem's ModelPart
A	System matrix
Dx	Solution vector (containing the increment of the unknowns obtained in the present iteration)
b	Right hand side vector

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

◆ UpdateWithRelaxation()

template<class TSparseSpace , class TDenseSpace >

void Kratos::TrilinosResidualBasedIncrementalAitkenStaticScheme< TSparseSpace, TDenseSpace >::UpdateWithRelaxation	(	DofsArrayType &	rDofSet,
		TSystemVectorType &	Dx,
		const double	Omega
	)

inlineprotected

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

/home/runner/work/Documentation/Documentation/master/applications/TrilinosApplication/custom_strategies/schemes/trilinos_residualbased_incremental_aitken_static_scheme.h

Public Member Functions

Protected Member Functions

Type Definitions

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ BaseType

◆ DofsArrayType

◆ SystemVectorPointerType

◆ TDataType

◆ TSystemMatrixType

◆ TSystemVectorType

Constructor & Destructor Documentation

◆ TrilinosResidualBasedIncrementalAitkenStaticScheme()

◆ ~TrilinosResidualBasedIncrementalAitkenStaticScheme()

Member Function Documentation

◆ CalculateOmega()

◆ Clear()

◆ DofImporterIsInitialized()

◆ InitializeDofImporter()

◆ InitializeSolutionStep()

◆ KRATOS_CLASS_POINTER_DEFINITION()

◆ pGetImporter()

◆ Update()

◆ UpdateWithRelaxation()

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