A scheme for static adjoint equations. More...

#include <residual_based_adjoint_static_scheme.h>

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

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

Public Member Functions
Life Cycle
	ResidualBasedAdjointStaticScheme (AdjointResponseFunction::Pointer pResponseFunction)
	Constructor. More...

	~ResidualBasedAdjointStaticScheme () override
	Destructor. More...

Operations
void	SetResponseFunction (AdjointResponseFunction::Pointer pResponseFunction)
	Set the Response Function. More...

void	Initialize (ModelPart &rModelPart) override
	This is the place to initialize the Scheme. More...

void	Update (ModelPart &rModelPart, DofsArrayType &rDofSet, SystemMatrixType &rA, SystemVectorType &rDx, SystemVectorType &rb) override
	Performing the update of the solution. More...

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

void	CalculateRHSContribution (Element &rCurrentElement, LocalSystemVectorType &rRHSContribution, 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 &rRHSContribution, Condition::EquationIdVectorType &rEquationId, const ProcessInfo &rCurrentProcessInfo) override
	Functions totally analogous to the precedent but applied to the "condition" objects. More...

void	CalculateLHSContribution (Condition &rCurrentCondition, LocalSystemMatrixType &rLHS_Contribution, Condition::EquationIdVectorType &rEquationId, const ProcessInfo &rCurrentProcessInfo) override
	Functions totally analogous to the precedent but applied to the "condition" objects. More...

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

void	Clear () override
	Liberate internal storage. 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 ()

virtual std::string	Info () const
	Turn back information as a string. More...

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

virtual ClassType::Pointer	Create (Parameters ThisParameters) const
	Create method. More...

virtual Pointer	Clone ()
	Clone 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	InitializeSolutionStep (ModelPart &rModelPart, TSystemMatrixType &A, TSystemVectorType &Dx, TSystemVectorType &b)
	Function called once at the beginning of each solution step. 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	Predict (ModelPart &rModelPart, DofsArrayType &rDofSet, TSystemMatrixType &A, TSystemVectorType &Dx, TSystemVectorType &b)
	Performing the prediction of the solution. 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	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...

virtual Parameters	GetDefaultParameters () const
	This method provides the defaults parameters to avoid conflicts between the different constructors. More...

Protected Attributes
Protected member Variables
AdjointResponseFunction::Pointer	mpResponseFunction

std::vector< LocalSystemVectorType >	mAdjointValues

std::vector< LocalSystemMatrixType >	mLHS

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 BaseType::TSystemMatrixType	SystemMatrixType

typedef BaseType::TSystemVectorType	SystemVectorType

typedef BaseType::LocalSystemVectorType	LocalSystemVectorType

typedef BaseType::LocalSystemMatrixType	LocalSystemMatrixType

typedef BaseType::DofsArrayType	DofsArrayType

	KRATOS_CLASS_POINTER_DEFINITION (ResidualBasedAdjointStaticScheme)

Additional Inherited Members
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...

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

Detailed Description

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

A scheme for static adjoint equations.

Solves the adjoint equations:

\[ \partial_{\mathbf{u}}\mathbf{r}^T \lambda = -\partial_{\mathbf{u}}J^{T} \]

\(\lambda\) is returned by Element::GetValuesVector. \(\partial_{\mathbf{u}}\mathbf{r}^T\) is returned by Element::CalculateLeftHandSide. \(\partial_{\mathbf{u}}J^{T}\) is returned by ResponseFunction::CalculateGradient.

Member Typedef Documentation

◆ BaseType

template<class TSparseSpace , class TDenseSpace >

typedef Scheme<TSparseSpace, TDenseSpace> Kratos::ResidualBasedAdjointStaticScheme< TSparseSpace, TDenseSpace >::BaseType

◆ DofsArrayType

template<class TSparseSpace , class TDenseSpace >

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

◆ LocalSystemMatrixType

template<class TSparseSpace , class TDenseSpace >

typedef BaseType::LocalSystemMatrixType Kratos::ResidualBasedAdjointStaticScheme< TSparseSpace, TDenseSpace >::LocalSystemMatrixType

◆ LocalSystemVectorType

template<class TSparseSpace , class TDenseSpace >

typedef BaseType::LocalSystemVectorType Kratos::ResidualBasedAdjointStaticScheme< TSparseSpace, TDenseSpace >::LocalSystemVectorType

◆ SystemMatrixType

template<class TSparseSpace , class TDenseSpace >

typedef BaseType::TSystemMatrixType Kratos::ResidualBasedAdjointStaticScheme< TSparseSpace, TDenseSpace >::SystemMatrixType

◆ SystemVectorType

template<class TSparseSpace , class TDenseSpace >

typedef BaseType::TSystemVectorType Kratos::ResidualBasedAdjointStaticScheme< TSparseSpace, TDenseSpace >::SystemVectorType

Constructor & Destructor Documentation

◆ ResidualBasedAdjointStaticScheme()

template<class TSparseSpace , class TDenseSpace >

Kratos::ResidualBasedAdjointStaticScheme< TSparseSpace, TDenseSpace >::ResidualBasedAdjointStaticScheme ( AdjointResponseFunction::Pointer pResponseFunction )

inlineexplicit

Constructor.

◆ ~ResidualBasedAdjointStaticScheme()

template<class TSparseSpace , class TDenseSpace >

Kratos::ResidualBasedAdjointStaticScheme< TSparseSpace, TDenseSpace >::~ResidualBasedAdjointStaticScheme ( )

inlineoverride

Destructor.

Member Function Documentation

◆ CalculateLHSContribution() [1/2]

template<class TSparseSpace , class TDenseSpace >

void Kratos::ResidualBasedAdjointStaticScheme< TSparseSpace, TDenseSpace >::CalculateLHSContribution	(	Condition &	rCondition,
		LocalSystemMatrixType &	LHS_Contribution,
		Condition::EquationIdVectorType &	rEquationIdVector,
		const ProcessInfo &	rCurrentProcessInfo
	)

inlineoverridevirtual

Functions totally analogous to the precedent but applied to the "condition" objects.

Parameters

rCondition	The condition to compute
LHS_Contribution	The RHS vector contribution
rEquationIdVector	The ID's of the condition degrees of freedom
rCurrentProcessInfo	The current process info instance

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

Reimplemented in Kratos::ResidualBasedAdjointSteadyScheme< TSparseSpace, TDenseSpace >.

◆ CalculateLHSContribution() [2/2]

template<class TSparseSpace , class TDenseSpace >

void Kratos::ResidualBasedAdjointStaticScheme< TSparseSpace, TDenseSpace >::CalculateLHSContribution	(	Element &	rElement,
		LocalSystemMatrixType &	LHS_Contribution,
		Element::EquationIdVectorType &	rEquationIdVector,
		const ProcessInfo &	rCurrentProcessInfo
	)

inlineoverridevirtual

This function is designed to calculate just the LHS contribution.

Parameters

rElement	The element to compute
LHS_Contribution	The RHS vector contribution
rEquationIdVector	The ID's of the element degrees of freedom
rCurrentProcessInfo	The current process info instance

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

Reimplemented in Kratos::ResidualBasedAdjointSteadyScheme< TSparseSpace, TDenseSpace >.

◆ CalculateRHSContribution() [1/2]

template<class TSparseSpace , class TDenseSpace >

void Kratos::ResidualBasedAdjointStaticScheme< TSparseSpace, TDenseSpace >::CalculateRHSContribution	(	Condition &	rCondition,
		LocalSystemVectorType &	RHS_Contribution,
		Condition::EquationIdVectorType &	rEquationIdVector,
		const ProcessInfo &	rCurrentProcessInfo
	)

inlineoverridevirtual

Functions totally analogous to the precedent but applied to the "condition" objects.

Parameters

rCondition	The condition to compute
RHS_Contribution	The RHS vector contribution
rEquationIdVector	The ID's of the condition degrees of freedom
rCurrentProcessInfo	The current process info instance

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

◆ CalculateRHSContribution() [2/2]

template<class TSparseSpace , class TDenseSpace >

void Kratos::ResidualBasedAdjointStaticScheme< TSparseSpace, TDenseSpace >::CalculateRHSContribution	(	Element &	rElement,
		LocalSystemVectorType &	RHS_Contribution,
		Element::EquationIdVectorType &	rEquationIdVector,
		const ProcessInfo &	rCurrentProcessInfo
	)

inlineoverridevirtual

This function is designed to calculate just the RHS contribution.

Parameters

rElement	The element to compute
RHS_Contribution	The RHS vector contribution
rEquationIdVector	The ID's of the element degrees of freedom
rCurrentProcessInfo	The current process info instance

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

◆ CalculateSystemContributions() [1/2]

template<class TSparseSpace , class TDenseSpace >

void Kratos::ResidualBasedAdjointStaticScheme< TSparseSpace, TDenseSpace >::CalculateSystemContributions	(	Condition &	rCondition,
		LocalSystemMatrixType &	LHS_Contribution,
		LocalSystemVectorType &	RHS_Contribution,
		Condition::EquationIdVectorType &	rEquationIdVector,
		const ProcessInfo &	rCurrentProcessInfo
	)

inlineoverridevirtual

Functions totally analogous to the precedent but applied to the "condition" objects.

Parameters

rCondition	The condition to compute
LHS_Contribution	The LHS matrix contribution
RHS_Contribution	The RHS vector contribution
rEquationIdVector	The ID's of the condition degrees of freedom
rCurrentProcessInfo	The current process info instance

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

Reimplemented in Kratos::ResidualBasedAdjointSteadyScheme< TSparseSpace, TDenseSpace >.

◆ CalculateSystemContributions() [2/2]

template<class TSparseSpace , class TDenseSpace >

void Kratos::ResidualBasedAdjointStaticScheme< TSparseSpace, TDenseSpace >::CalculateSystemContributions	(	Element &	rElement,
		LocalSystemMatrixType &	LHS_Contribution,
		LocalSystemVectorType &	RHS_Contribution,
		Element::EquationIdVectorType &	rEquationIdVector,
		const ProcessInfo &	rCurrentProcessInfo
	)

inlineoverridevirtual

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

It "asks" the matrix needed to the element and performs the operations needed to introduce the selected time integration scheme. This function calculates at the same time the contribution to the LHS and to the RHS of the system

Parameters

rElement	The element to compute
LHS_Contribution	The LHS matrix contribution
RHS_Contribution	The RHS vector contribution
rEquationIdVector	The ID's of the element degrees of freedom
rCurrentProcessInfo	The current process info instance

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

Reimplemented in Kratos::ResidualBasedAdjointSteadyScheme< TSparseSpace, TDenseSpace >.

◆ Clear()

template<class TSparseSpace , class TDenseSpace >

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

inlineoverridevirtual

Liberate internal storage.

Warning: Must be implemented in the derived classes

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

◆ Initialize()

template<class TSparseSpace , class TDenseSpace >

void Kratos::ResidualBasedAdjointStaticScheme< TSparseSpace, TDenseSpace >::Initialize ( ModelPart & rModelPart )

inlineoverridevirtual

This is the place to initialize the Scheme.

This is intended to be called just once when the strategy is initialized

Parameters

rModelPart The model part of the problem to solve

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

◆ KRATOS_CLASS_POINTER_DEFINITION()

template<class TSparseSpace , class TDenseSpace >

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

◆ SetResponseFunction()

template<class TSparseSpace , class TDenseSpace >

void Kratos::ResidualBasedAdjointStaticScheme< TSparseSpace, TDenseSpace >::SetResponseFunction ( AdjointResponseFunction::Pointer pResponseFunction )

inline

Set the Response Function.

This sets the response function used in the sensitivity builder. This is useful in cases where the LHS of the adjoint problem does not change, but the RHS changes due to change in the the response function. In these cases, this allows re-use of the already constructed LHS with different RHSs.

Parameters

pResponseFunction New Response function to be set.

◆ Update()

template<class TSparseSpace , class TDenseSpace >

void Kratos::ResidualBasedAdjointStaticScheme< TSparseSpace, TDenseSpace >::Update	(	ModelPart &	rModelPart,
		DofsArrayType &	rDofSet,
		SystemMatrixType &	A,
		SystemVectorType &	Dx,
		SystemVectorType &	b
	)

inlineoverridevirtual

Performing the update of the solution.

Warning: Must be defined in derived classes

Parameters

rModelPart	The model part of the problem to solve
rDofSet	Set of all primary variables
A	LHS matrix
Dx	Incremental update of primary variables
b	RHS Vector

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

Member Data Documentation

◆ mAdjointValues

template<class TSparseSpace , class TDenseSpace >

std::vector<LocalSystemVectorType> Kratos::ResidualBasedAdjointStaticScheme< TSparseSpace, TDenseSpace >::mAdjointValues

protected

◆ mLHS

template<class TSparseSpace , class TDenseSpace >

std::vector<LocalSystemMatrixType> Kratos::ResidualBasedAdjointStaticScheme< TSparseSpace, TDenseSpace >::mLHS

protected

◆ mpResponseFunction

template<class TSparseSpace , class TDenseSpace >

AdjointResponseFunction::Pointer Kratos::ResidualBasedAdjointStaticScheme< TSparseSpace, TDenseSpace >::mpResponseFunction

protected

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

/home/runner/work/Documentation/Documentation/master/kratos/solving_strategies/schemes/residual_based_adjoint_static_scheme.h

Public Member Functions

Protected Attributes

Type Definitions

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ BaseType

◆ DofsArrayType

◆ LocalSystemMatrixType

◆ LocalSystemVectorType

◆ SystemMatrixType

◆ SystemVectorType

Constructor & Destructor Documentation

◆ ResidualBasedAdjointStaticScheme()

◆ ~ResidualBasedAdjointStaticScheme()

Member Function Documentation

◆ CalculateLHSContribution() [1/2]

◆ CalculateLHSContribution() [2/2]

◆ CalculateRHSContribution() [1/2]

◆ CalculateRHSContribution() [2/2]

◆ CalculateSystemContributions() [1/2]

◆ CalculateSystemContributions() [2/2]

◆ Clear()

◆ Initialize()

◆ KRATOS_CLASS_POINTER_DEFINITION()

◆ SetResponseFunction()

◆ Update()

Member Data Documentation

◆ mAdjointValues

◆ mLHS

◆ mpResponseFunction

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