#include <doperator.hpp>

Inheritance diagram for mfem::future::DerivativeOperator:

Collaboration diagram for mfem::future::DerivativeOperator:

Public Member Functions
	DerivativeOperator (const int &height, const int &width, const std::vector< derivative_action_t > &derivative_actions, const FieldDescriptor &direction, const int &daction_l_size, const std::vector< derivative_action_t > &derivative_actions_transpose, const FieldDescriptor &transpose_direction, const int &daction_transpose_l_size, const std::vector< Vector * > &solutions_l, const std::vector< Vector * > &parameters_l, const restriction_callback_t &restriction_callback, const std::function< void(Vector &, Vector &)> &prolongation_transpose, const std::vector< assemble_derivative_sparsematrix_callback_t > &assemble_derivative_sparsematrix_callbacks, const std::vector< assemble_derivative_hypreparmatrix_callback_t > &assemble_derivative_hypreparmatrix_callbacks)

void	Mult (const Vector &direction_t, Vector &result_t) const override
	Compute the action of the derivative operator on a given vector.

void	MultTranspose (const Vector &direction_t, Vector &result_t) const override
	Compute the transpose of the derivative operator on a given vector.

void	Assemble (SparseMatrix *&A)
	Assemble the derivative operator into a SparseMatrix.

void	Assemble (HypreParMatrix *&A)
	Assemble the derivative operator into a HypreParMatrix.

Public Member Functions inherited from mfem::Operator
void	InitTVectors (const Operator Po, const Operator Ri, const Operator *Pi, Vector &x, Vector &b, Vector &X, Vector &B) const
	Initializes memory for true vectors of linear system.

	Operator (int s=0)
	Construct a square Operator with given size s (default 0).

	Operator (int h, int w)
	Construct an Operator with the given height (output size) and width (input size).

int	Height () const
	Get the height (size of output) of the Operator. Synonym with NumRows().

int	NumRows () const
	Get the number of rows (size of output) of the Operator. Synonym with Height().

int	Width () const
	Get the width (size of input) of the Operator. Synonym with NumCols().

int	NumCols () const
	Get the number of columns (size of input) of the Operator. Synonym with Width().

virtual MemoryClass	GetMemoryClass () const
	Return the MemoryClass preferred by the Operator.

virtual void	AbsMult (const Vector &x, Vector &y) const
	Action of the absolute-value operator: `y=\|A\|(x)`. The default behavior in class Operator is to generate an error. If the Operator is a composition of several operators, the composition unfold into a product of absolute-value operators too.

virtual void	AbsMultTranspose (const Vector &x, Vector &y) const
	Action of the transpose absolute-value operator: `y=\|A\|^t(x)`. The default behavior in class Operator is to generate an error.

virtual void	AddMult (const Vector &x, Vector &y, const real_t a=1.0) const
	Operator application: `y+=A(x)` (default) or `y+=a*A(x)`.

virtual void	AddMultTranspose (const Vector &x, Vector &y, const real_t a=1.0) const
	Operator transpose application: `y+=A^t(x)` (default) or `y+=a*A^t(x)`.

virtual void	ArrayMult (const Array< const Vector * > &X, Array< Vector * > &Y) const
	Operator application on a matrix: `Y=A(X)`.

virtual void	ArrayMultTranspose (const Array< const Vector * > &X, Array< Vector * > &Y) const
	Action of the transpose operator on a matrix: `Y=A^t(X)`.

virtual void	ArrayAddMult (const Array< const Vector * > &X, Array< Vector * > &Y, const real_t a=1.0) const
	Operator application on a matrix: `Y+=A(X)` (default) or `Y+=a*A(X)`.

virtual void	ArrayAddMultTranspose (const Array< const Vector * > &X, Array< Vector * > &Y, const real_t a=1.0) const
	Operator transpose application on a matrix: `Y+=A^t(X)` (default) or `Y+=a*A^t(X)`.

virtual Operator &	GetGradient (const Vector &x) const
	Evaluate the gradient operator at the point x. The default behavior in class Operator is to generate an error.

virtual void	AssembleDiagonal (Vector &diag) const
	Computes the diagonal entries into diag. Typically, this operation only makes sense for linear Operators. In some cases, only an approximation of the diagonal is computed.

virtual const Operator *	GetProlongation () const
	Prolongation operator from linear algebra (linear system) vectors, to input vectors for the operator. `NULL` means identity.

virtual const Operator *	GetRestriction () const
	Restriction operator from input vectors for the operator to linear algebra (linear system) vectors. `NULL` means identity.

virtual const Operator *	GetOutputProlongation () const
	Prolongation operator from linear algebra (linear system) vectors, to output vectors for the operator. `NULL` means identity.

virtual const Operator *	GetOutputRestrictionTranspose () const
	Transpose of GetOutputRestriction, directly available in this form to facilitate matrix-free RAP-type operators.

virtual const Operator *	GetOutputRestriction () const
	Restriction operator from output vectors for the operator to linear algebra (linear system) vectors. `NULL` means identity.

void	FormLinearSystem (const Array< int > &ess_tdof_list, Vector &x, Vector &b, Operator *&A, Vector &X, Vector &B, int copy_interior=0)
	Form a constrained linear system using a matrix-free approach.

void	FormRectangularLinearSystem (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, Vector &x, Vector &b, Operator *&A, Vector &X, Vector &B)
	Form a column-constrained linear system using a matrix-free approach.

virtual void	RecoverFEMSolution (const Vector &X, const Vector &b, Vector &x)
	Reconstruct a solution vector x (e.g. a GridFunction) from the solution X of a constrained linear system obtained from Operator::FormLinearSystem() or Operator::FormRectangularLinearSystem().

void	FormSystemOperator (const Array< int > &ess_tdof_list, Operator *&A)
	Return in A a parallel (on truedofs) version of this square operator.

void	FormRectangularSystemOperator (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, Operator *&A)
	Return in A a parallel (on truedofs) version of this rectangular operator (including constraints).

void	FormDiscreteOperator (Operator *&A)
	Return in A a parallel (on truedofs) version of this rectangular operator.

void	PrintMatlab (std::ostream &out, int n, int m=0) const
	Prints operator with input size n and output size m in Matlab format.

virtual void	PrintMatlab (std::ostream &out) const
	Prints operator in Matlab format.

virtual	~Operator ()
	Virtual destructor.

Type	GetType () const
	Return the type ID of the Operator class.

Additional Inherited Members
Public Types inherited from mfem::Operator
enum	DiagonalPolicy { DIAG_ZERO , DIAG_ONE , DIAG_KEEP }
	Defines operator diagonal policy upon elimination of rows and/or columns. More...

enum	Type { ANY_TYPE , MFEM_SPARSEMAT , Hypre_ParCSR , PETSC_MATAIJ , PETSC_MATIS , PETSC_MATSHELL , PETSC_MATNEST , PETSC_MATHYPRE , PETSC_MATGENERIC , Complex_Operator , MFEM_ComplexSparseMat , Complex_Hypre_ParCSR , Complex_DenseMat , MFEM_Block_Matrix , MFEM_Block_Operator }
	Enumeration defining IDs for some classes derived from Operator. More...

Protected Member Functions inherited from mfem::Operator
void	FormConstrainedSystemOperator (const Array< int > &ess_tdof_list, ConstrainedOperator *&Aout)
	see FormSystemOperator()

void	FormRectangularConstrainedSystemOperator (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, RectangularConstrainedOperator *&Aout)
	see FormRectangularSystemOperator()

Operator *	SetupRAP (const Operator Pi, const Operator Po)
	Returns RAP Operator of this, using input/output Prolongation matrices Pi corresponds to "P", Po corresponds to "Rt".

Protected Attributes inherited from mfem::Operator
int	height
	Dimension of the output / number of rows in the matrix.

int	width
	Dimension of the input / number of columns in the matrix.

Detailed Description

Class representing the derivative (Jacobian) operator of a DifferentiableOperator.

This class implements a derivative operator that computes directional derivatives for a given set of solution and parameter fields. It supports both forward and transpose operations, as well as assembly into sparse matrices.

Note: The derivative operator uses only forward mode differentiation in Mult and MultTranspose. It does not support reverse mode differentiation. The MultTranspose operation is achieved by using the transpose of the derivative actions on each quadrature point.

See also: DifferentiableOperator

Definition at line 73 of file doperator.hpp.

Constructor & Destructor Documentation

◆ DerivativeOperator()

mfem::future::DerivativeOperator::DerivativeOperator	(	const int &	height,
		const int &	width,
		const std::vector< derivative_action_t > &	derivative_actions,
		const FieldDescriptor &	direction,
		const int &	daction_l_size,
		const std::vector< derivative_action_t > &	derivative_actions_transpose,
		const FieldDescriptor &	transpose_direction,
		const int &	daction_transpose_l_size,
		const std::vector< Vector * > &	solutions_l,
		const std::vector< Vector * > &	parameters_l,
		const restriction_callback_t &	restriction_callback,
		const std::function< void(Vector &, Vector &)> &	prolongation_transpose,
		const std::vector< assemble_derivative_sparsematrix_callback_t > &	assemble_derivative_sparsematrix_callbacks,
		const std::vector< assemble_derivative_hypreparmatrix_callback_t > &	assemble_derivative_hypreparmatrix_callbacks )

inline

Constructor for the DerivativeOperator class.

This is usually not called directly from a user. A DifferentiableOperator calls this constructor when using DifferentiableOperator::GetDerivative().

Definition at line 81 of file doperator.hpp.

Member Function Documentation

◆ Assemble() [1/2]

void mfem::future::DerivativeOperator::Assemble ( HypreParMatrix *& A )

inline

Assemble the derivative operator into a HypreParMatrix.

Parameters

A	The HypreParMatrix to assemble the derivative operator into. Can be an uninitialized object.

Definition at line 192 of file doperator.hpp.

◆ Assemble() [2/2]

void mfem::future::DerivativeOperator::Assemble ( SparseMatrix *& A )

inline

Assemble the derivative operator into a SparseMatrix.

Parameters

A	The SparseMatrix to assemble the derivative operator into. Can be an uninitialized object.

Definition at line 177 of file doperator.hpp.

◆ Mult()

void mfem::future::DerivativeOperator::Mult	(	const Vector &	direction_t,
		Vector &	result_t ) const

inlineoverridevirtual

Compute the action of the derivative operator on a given vector.

Parameters

direction_t	The direction vector in which to compute the derivative. This has to be a T-dof vector.
result_t	Result vector of the action of the derivative on direction_t on T-dofs.

Implements mfem::Operator.

Definition at line 133 of file doperator.hpp.

◆ MultTranspose()

void mfem::future::DerivativeOperator::MultTranspose	(	const Vector &	direction_t,
		Vector &	result_t ) const

inlineoverridevirtual

Compute the transpose of the derivative operator on a given vector.

This function computes the transpose of the derivative operator on a given vector by transposing the quadrature point local forward derivative action. It does not use reverse mode automatic differentiation.

Parameters

direction_t	The direction vector in which to compute the derivative. This has to be a T-dof vector.
result_t	Result vector of the transpose action of the derivative on direction_t on T-dofs.

Reimplemented from mfem::Operator.

Definition at line 157 of file doperator.hpp.

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

fem/dfem/doperator.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DerivativeOperator()

Member Function Documentation

◆ Assemble() [1/2]

◆ Assemble() [2/2]

◆ Mult()

◆ MultTranspose()