#include <doperator.hpp>

Inheritance diagram for mfem::future::DifferentiableOperator:

Collaboration diagram for mfem::future::DifferentiableOperator:

Public Types
enum	MultLevel { TVECTOR , LVECTOR }

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

Public Member Functions
	DifferentiableOperator (const std::vector< FieldDescriptor > &solutions, const std::vector< FieldDescriptor > &parameters, const ParMesh &mesh)

void	SetMultLevel (MultLevel level)
	Set the MultLevel mode for the DifferentiableOperator. The default is TVECTOR, which means that the Operator will use T->L before Mult and L->T Operators after.

void	Mult (const Vector &solutions_in, Vector &result_in) const override
	Compute the action of the operator on a given vector.

template<typename entity_t , typename qfunc_t , typename input_t , typename output_t , typename derivative_ids_t >
void	AddIntegrator (qfunc_t &qfunc, input_t inputs, output_t outputs, const IntegrationRule &integration_rule, const Array< int > &attributes, derivative_ids_t derivative_ids)
	Add an integrator to the operator. Called only from AddDomainIntegrator() and AddBoundaryIntegrator().

template<typename qfunc_t , typename input_t , typename output_t , typename derivative_ids_t = decltype(std::make_index_sequence<0> {})>
void	AddDomainIntegrator (qfunc_t &qfunc, input_t inputs, output_t outputs, const IntegrationRule &integration_rule, const Array< int > &domain_attributes, derivative_ids_t derivative_ids=std::make_index_sequence< 0 > {})
	Add a domain integrator to the operator.

template<typename qfunc_t , typename input_t , typename output_t , typename derivative_ids_t = decltype(std::make_index_sequence<0> {})>
void	AddBoundaryIntegrator (qfunc_t &qfunc, input_t inputs, output_t outputs, const IntegrationRule &integration_rule, const Array< int > &boundary_attributes, derivative_ids_t derivative_ids=std::make_index_sequence< 0 > {})
	Add a boundary integrator to the operator.

void	SetParameters (std::vector< Vector * > p) const
	Set the parameters for the operator.

void	DisableTensorProductStructure (bool disable=true)
	Disable the use of tensor product structure.

std::shared_ptr< DerivativeOperator >	GetDerivative (size_t derivative_id, std::vector< Vector * > sol_l, std::vector< Vector * > par_l)
	Get the derivative operator for a given derivative ID.

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	MultTranspose (const Vector &x, Vector &y) const
	Action of the transpose operator: `y=A^t(x)`. The default behavior in class Operator is to generate an error.

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
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 a differentiable operator which acts on solution and parameter fields to compute residuals.

This class provides functionality to define differentiable operators by composing functions that compute values at quadrature points. It supports automatic differentiation to compute derivatives with respect to solutions (Jacobians) and parameter fields (general derivative operators).

The operator is constructed with solution fields that it will act on and parameter fields that define coefficients. Quadrature functions are added by e.g. using AddDomainIntegrator() which specify how the operator evaluates those functions and parameters at quadrature points.

Derivatives can be computed by obtaining a DerivativeOperator using GetDerivative().

See also: DerivativeOperator

Definition at line 254 of file doperator.hpp.

Member Enumeration Documentation

◆ MultLevel

enum mfem::future::DifferentiableOperator::MultLevel

MultLevel enum to indicate if the T->L Operators are used in the Mult method.

Enumerator
TVECTOR
LVECTOR

Definition at line 269 of file doperator.hpp.

Constructor & Destructor Documentation

◆ DifferentiableOperator()

DifferentiableOperator::DifferentiableOperator	(	const std::vector< FieldDescriptor > &	solutions,
		const std::vector< FieldDescriptor > &	parameters,
		const ParMesh &	mesh )

Constructor for the DifferentiableOperator class.

Parameters

solutions	The solution fields that the operator will act on.
parameters	The parameter fields that define coefficients.
mesh	The mesh on which the operator is defined.

Definition at line 30 of file doperator.cpp.

Member Function Documentation

◆ AddBoundaryIntegrator()

template<typename qfunc_t , typename input_t , typename output_t , typename derivative_ids_t >

void mfem::future::DifferentiableOperator::AddBoundaryIntegrator	(	qfunc_t &	qfunc,
		input_t	inputs,
		output_t	outputs,
		const IntegrationRule &	integration_rule,
		const Array< int > &	boundary_attributes,
		derivative_ids_t	derivative_ids = std::make_index_sequence<0> {} )

Add a boundary integrator to the operator.

Parameters

qfunc	The quadrature function to be added.
inputs	Tuple of FieldOperators for the inputs of the quadrature function.
outputs	Tuple of FieldOperators for the outputs of the quadrature function.
integration_rule	IntegrationRule to use with this integrator.
boundary_attributes	Boundary attributes marker array indicating over which attributes this integrator will integrate over.
derivative_ids	Derivatives to be made available for this integrator.

Definition at line 544 of file doperator.hpp.

◆ AddDomainIntegrator()

template<typename qfunc_t , typename input_t , typename output_t , typename derivative_ids_t >

void mfem::future::DifferentiableOperator::AddDomainIntegrator	(	qfunc_t &	qfunc,
		input_t	inputs,
		output_t	outputs,
		const IntegrationRule &	integration_rule,
		const Array< int > &	domain_attributes,
		derivative_ids_t	derivative_ids = std::make_index_sequence<0> {} )

Add a domain integrator to the operator.

Parameters

qfunc	The quadrature function to be added.
inputs	Tuple of FieldOperators for the inputs of the quadrature function.
outputs	Tuple of FieldOperators for the outputs of the quadrature function.
integration_rule	IntegrationRule to use with this integrator.
domain_attributes	Domain attributes marker array indicating over which attributes this integrator will integrate over.
derivative_ids	Derivatives to be made available for this integrator.

Definition at line 527 of file doperator.hpp.

◆ AddIntegrator()

template<typename entity_t , typename qfunc_t , typename input_t , typename output_t , typename derivative_ids_t >

void mfem::future::DifferentiableOperator::AddIntegrator	(	qfunc_t &	qfunc,
		input_t	inputs,
		output_t	outputs,
		const IntegrationRule &	integration_rule,
		const Array< int > &	attributes,
		derivative_ids_t	derivative_ids )

Add an integrator to the operator. Called only from AddDomainIntegrator() and AddBoundaryIntegrator().

Definition at line 567 of file doperator.hpp.

◆ DisableTensorProductStructure()

void mfem::future::DifferentiableOperator::DisableTensorProductStructure ( bool disable = true )

inline

Disable the use of tensor product structure.

This function disables the use of tensor product structure for the operator. Usually, DifferentiableOperator creates callbacks based on heuristics that achieve good performance for each element type. Some functionality is not implemented for these performant algorithms but only for generic assembly. Therefore the user can decide to use fallback methods.

Definition at line 399 of file doperator.hpp.

◆ GetDerivative()

std::shared_ptr< DerivativeOperator > mfem::future::DifferentiableOperator::GetDerivative	(	size_t	derivative_id,
		std::vector< Vector * >	sol_l,
		std::vector< Vector * >	par_l )

inline

Get the derivative operator for a given derivative ID.

This function returns a shared pointer to a DerivativeOperator that computes the derivative of the operator with respect to the given derivative ID. The derivative ID is used to identify the specific derivative action to be performed.

Parameters

derivative_id	The ID of the derivative to be computed.
sol_l	The solution vectors to be used for the derivative computation. This should be a vector of pointers to the solution vectors. The vectors have to be L-vectors (e.g. GridFunctions).
par_l	The parameter vectors to be used for the derivative computation. This should be a vector of pointers to the parameter vectors. The vectors have to be L-vectors (e.g. GridFunctions).

Returns: A shared pointer to the DerivativeOperator.

Definition at line 419 of file doperator.hpp.

◆ Mult()

void mfem::future::DifferentiableOperator::Mult	(	const Vector &	solutions_in,
		Vector &	result_in ) const

inlineoverridevirtual

Compute the action of the operator on a given vector.

Parameters

solutions_in	The solution vector in which to compute the action. This has to be a T-dof vector if MultLevel is set to TVECTOR, or L-dof Vector if MultLevel is set to LVECTOR.
result_in	Result vector of the action of the operator on solutions. The result is a T-dof vector or L-dof vector depending on the MultLevel.

Implements mfem::Operator.

Definition at line 291 of file doperator.hpp.

◆ SetMultLevel()

void mfem::future::DifferentiableOperator::SetMultLevel ( MultLevel level )

inline

Set the MultLevel mode for the DifferentiableOperator. The default is TVECTOR, which means that the Operator will use T->L before Mult and L->T Operators after.

Definition at line 278 of file doperator.hpp.

◆ SetParameters()

void DifferentiableOperator::SetParameters ( std::vector< Vector * > p ) const

Set the parameters for the operator.

This has to be called before using Mult() or MultTranspose().

Parameters

p	The parameters to be set. This should be a vector of pointers to the parameter vectors. The vectors have to be L-vectors (e.g. GridFunctions).

Definition at line 19 of file doperator.cpp.

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

fem/dfem/doperator.hpp
fem/dfem/doperator.cpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ MultLevel

Constructor & Destructor Documentation

◆ DifferentiableOperator()

Member Function Documentation

◆ AddBoundaryIntegrator()

◆ AddDomainIntegrator()

◆ AddIntegrator()

◆ DisableTensorProductStructure()

◆ GetDerivative()

◆ Mult()

◆ SetMultLevel()

◆ SetParameters()