MFEM v4.7.0
Finite element discretization library
Loading...
Searching...
No Matches
mfem::ParNonlinearForm Class Reference

Parallel non-linear operator on the true dofs. More...

#include <pnonlinearform.hpp>

Inheritance diagram for mfem::ParNonlinearForm:
[legend]
Collaboration diagram for mfem::ParNonlinearForm:
[legend]

Public Member Functions

 ParNonlinearForm (ParFiniteElementSpace *pf)
 
ParFiniteElementSpaceParFESpace () const
 
real_t GetParGridFunctionEnergy (const Vector &x) const
 Compute the energy corresponding to the state x.
 
real_t GetEnergy (const ParGridFunction &x) const
 Compute the energy of a ParGridFunction.
 
virtual real_t GetEnergy (const Vector &x) const
 Compute the energy corresponding to the state x.
 
virtual void Mult (const Vector &x, Vector &y) const
 Evaluate the action of the NonlinearForm.
 
const SparseMatrixGetLocalGradient (const Vector &x) const
 Return the local gradient matrix for the given true-dof vector x.
 
virtual OperatorGetGradient (const Vector &x) const
 Compute the gradient Operator of the NonlinearForm corresponding to the state x.
 
void SetGradientType (Operator::Type tid)
 Set the operator type id for the parallel gradient matrix/operator.
 
virtual void Update ()
 Update the ParNonlinearForm to propagate updates of the associated parallel FE space.
 
virtual ~ParNonlinearForm ()
 
- Public Member Functions inherited from mfem::NonlinearForm
 NonlinearForm (FiniteElementSpace *f)
 Construct a NonlinearForm on the given FiniteElementSpace, f.
 
void SetAssemblyLevel (AssemblyLevel assembly_level)
 Set the desired assembly level. The default is AssemblyLevel::LEGACY.
 
FiniteElementSpaceFESpace ()
 
const FiniteElementSpaceFESpace () const
 
void AddDomainIntegrator (NonlinearFormIntegrator *nlfi)
 Adds new Domain Integrator.
 
void AddDomainIntegrator (NonlinearFormIntegrator *nlfi, Array< int > &elem_marker)
 Adds new Domain Integrator, restricted to specific attributes.
 
Array< NonlinearFormIntegrator * > * GetDNFI ()
 Access all integrators added with AddDomainIntegrator().
 
const Array< NonlinearFormIntegrator * > * GetDNFI () const
 
void AddBoundaryIntegrator (NonlinearFormIntegrator *nlfi)
 Adds new Boundary Integrator.
 
void AddBoundaryIntegrator (NonlinearFormIntegrator *nlfi, Array< int > &elem_marker)
 Adds new Boundary Integrator, restricted to specific attributes.
 
Array< NonlinearFormIntegrator * > * GetBNFI ()
 Access all integrators added with AddBoundaryIntegrator().
 
const Array< NonlinearFormIntegrator * > * GetBNFI () const
 
void AddInteriorFaceIntegrator (NonlinearFormIntegrator *nlfi)
 Adds new Interior Face Integrator.
 
const Array< NonlinearFormIntegrator * > & GetInteriorFaceIntegrators () const
 Access all interior face integrators added with AddInteriorFaceIntegrator().
 
void AddBdrFaceIntegrator (NonlinearFormIntegrator *nlfi)
 Adds new Boundary Face Integrator.
 
void AddBdrFaceIntegrator (NonlinearFormIntegrator *nfi, Array< int > &bdr_marker)
 Adds new Boundary Face Integrator, restricted to specific boundary attributes.
 
const Array< NonlinearFormIntegrator * > & GetBdrFaceIntegrators () const
 Access all boundary face integrators added with AddBdrFaceIntegrator().
 
void SetEssentialBC (const Array< int > &bdr_attr_is_ess, Vector *rhs=NULL)
 Specify essential boundary conditions.
 
void SetEssentialVDofs (const Array< int > &ess_vdofs_list)
 Specify essential boundary conditions.
 
void SetEssentialTrueDofs (const Array< int > &ess_tdof_list_)
 Specify essential boundary conditions.
 
const Array< int > & GetEssentialTrueDofs () const
 Return a (read-only) list of all essential true dofs.
 
real_t GetGridFunctionEnergy (const Vector &x) const
 Compute the energy corresponding to the state x.
 
virtual void Setup ()
 Setup the NonlinearForm: based on the current AssemblyLevel and the current mesh, optionally, precompute and store data that will be reused in subsequent call to Mult().
 
virtual const OperatorGetProlongation () const
 Get the finite element space prolongation matrix.
 
virtual const OperatorGetRestriction () const
 Get the finite element space restriction matrix.
 
void UseExternalIntegrators ()
 Indicate that integrators are not owned by the NonlinearForm.
 
virtual ~NonlinearForm ()
 Destroy the NonlinearForm including the owned NonlinearFormIntegrators and gradient Operator.
 
- 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 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 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 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 OperatorGetOutputProlongation () const
 Prolongation operator from linear algebra (linear system) vectors, to output vectors for the operator. NULL means identity.
 
virtual const OperatorGetOutputRestrictionTranspose () const
 Transpose of GetOutputRestriction, directly available in this form to facilitate matrix-free RAP-type operators.
 
virtual const OperatorGetOutputRestriction () 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.
 

Protected Attributes

ParGridFunction X
 
ParGridFunction Y
 
OperatorHandle pGrad
 
- Protected Attributes inherited from mfem::NonlinearForm
AssemblyLevel assembly
 The assembly level.
 
NonlinearFormExtensionext
 Extension for supporting different AssemblyLevels.
 
FiniteElementSpacefes
 FE space on which the form lives.
 
bool extern_bfs
 Indicates the NonlinearFormIntegrators stored in dnfi, bnfi, fnfi, and bfnfi are not owned by this NonlinearForm.
 
Array< NonlinearFormIntegrator * > dnfi
 Set of Domain Integrators to be assembled (added).
 
Array< Array< int > * > dnfi_marker
 
Array< NonlinearFormIntegrator * > bnfi
 Set of Boundary Integrators to be assembled (added).
 
Array< Array< int > * > bnfi_marker
 
Array< NonlinearFormIntegrator * > fnfi
 Set of interior face Integrators to be assembled (added).
 
Array< NonlinearFormIntegrator * > bfnfi
 Set of boundary face Integrators to be assembled (added).
 
Array< Array< int > * > bfnfi_marker
 
SparseMatrixGrad
 
SparseMatrixcGrad
 
OperatorHandle hGrad
 Gradient Operator when not assembled as a matrix.
 
Array< int > ess_tdof_list
 A list of all essential true dofs.
 
long sequence
 Counter for updates propagated from the FiniteElementSpace.
 
Vector aux1
 Auxiliary Vectors.
 
Vector aux2
 
const OperatorP
 Pointer to the prolongation matrix of fes, may be NULL.
 
const SparseMatrixcP
 The result of dynamic-casting P to SparseMatrix pointer.
 
- 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.
 

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::NonlinearForm
bool Serial () const
 
const VectorProlongate (const Vector &x) const
 
- 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()
 
OperatorSetupRAP (const Operator *Pi, const Operator *Po)
 Returns RAP Operator of this, using input/output Prolongation matrices Pi corresponds to "P", Po corresponds to "Rt".
 

Detailed Description

Parallel non-linear operator on the true dofs.

Definition at line 26 of file pnonlinearform.hpp.

Constructor & Destructor Documentation

◆ ParNonlinearForm()

mfem::ParNonlinearForm::ParNonlinearForm ( ParFiniteElementSpace * pf)

Definition at line 22 of file pnonlinearform.cpp.

◆ ~ParNonlinearForm()

virtual mfem::ParNonlinearForm::~ParNonlinearForm ( )
inlinevirtual

Definition at line 69 of file pnonlinearform.hpp.

Member Function Documentation

◆ GetEnergy() [1/2]

real_t mfem::ParNonlinearForm::GetEnergy ( const ParGridFunction & x) const
inline

Compute the energy of a ParGridFunction.

Definition at line 46 of file pnonlinearform.hpp.

◆ GetEnergy() [2/2]

virtual real_t mfem::ParNonlinearForm::GetEnergy ( const Vector & x) const
inlinevirtual

Compute the energy corresponding to the state x.

In general, x may have non-homogeneous essential boundary values.

The state x must be a true-dof vector.

Reimplemented from mfem::NonlinearForm.

Definition at line 49 of file pnonlinearform.hpp.

◆ GetGradient()

Operator & mfem::ParNonlinearForm::GetGradient ( const Vector & x) const
virtual

Compute the gradient Operator of the NonlinearForm corresponding to the state x.

Any previously specified essential boundary conditions will be automatically imposed on the gradient operator.

The returned object is valid until the next call to this method or the destruction of this object.

In general, x may have non-homogeneous essential boundary values.

The state x must be a true-dof vector.

Reimplemented from mfem::NonlinearForm.

Definition at line 108 of file pnonlinearform.cpp.

◆ GetLocalGradient()

const SparseMatrix & mfem::ParNonlinearForm::GetLocalGradient ( const Vector & x) const

Return the local gradient matrix for the given true-dof vector x.

The returned matrix does NOT have any boundary conditions imposed.

Definition at line 98 of file pnonlinearform.cpp.

◆ GetParGridFunctionEnergy()

real_t mfem::ParNonlinearForm::GetParGridFunctionEnergy ( const Vector & x) const

Compute the energy corresponding to the state x.

In general, x may have non-homogeneous essential boundary values.

The state x must be a "GridFunction size" vector, i.e. its size must be fes->GetVSize().

Definition at line 30 of file pnonlinearform.cpp.

◆ Mult()

void mfem::ParNonlinearForm::Mult ( const Vector & x,
Vector & y ) const
virtual

Evaluate the action of the NonlinearForm.

The input essential dofs in x will, generally, be non-zero. However, the output essential dofs in y will always be set to zero.

Both the input and the output vectors, x and y, must be true-dof vectors, i.e. their size must be fes->GetTrueVSize().

Reimplemented from mfem::NonlinearForm.

Definition at line 48 of file pnonlinearform.cpp.

◆ ParFESpace()

ParFiniteElementSpace * mfem::ParNonlinearForm::ParFESpace ( ) const
inline

Definition at line 35 of file pnonlinearform.hpp.

◆ SetGradientType()

void mfem::ParNonlinearForm::SetGradientType ( Operator::Type tid)
inline

Set the operator type id for the parallel gradient matrix/operator.

Definition at line 61 of file pnonlinearform.hpp.

◆ Update()

void mfem::ParNonlinearForm::Update ( )
virtual

Update the ParNonlinearForm to propagate updates of the associated parallel FE space.

After calling this method, the essential boundary conditions need to be set again.

Reimplemented from mfem::NonlinearForm.

Definition at line 142 of file pnonlinearform.cpp.

Member Data Documentation

◆ pGrad

OperatorHandle mfem::ParNonlinearForm::pGrad
mutableprotected

Definition at line 30 of file pnonlinearform.hpp.

◆ X

ParGridFunction mfem::ParNonlinearForm::X
mutableprotected

Definition at line 29 of file pnonlinearform.hpp.

◆ Y

ParGridFunction mfem::ParNonlinearForm::Y
protected

Definition at line 29 of file pnonlinearform.hpp.


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