MFEM v4.7.0
Finite element discretization library
|
#include <nonlinearform.hpp>
Public Member Functions | |
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. | |
FiniteElementSpace * | FESpace () |
const FiniteElementSpace * | FESpace () 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 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. | |
virtual Operator & | GetGradient (const Vector &x) const |
Compute the gradient Operator of the NonlinearForm corresponding to the state x. | |
virtual void | Update () |
Update the NonlinearForm to propagate updates of the associated FE space. | |
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 Operator * | GetProlongation () const |
Get the finite element space prolongation matrix. | |
virtual const Operator * | GetRestriction () 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 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. | |
Protected Member Functions | |
bool | Serial () const |
const Vector & | Prolongate (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() | |
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 | |
AssemblyLevel | assembly |
The assembly level. | |
NonlinearFormExtension * | ext |
Extension for supporting different AssemblyLevels. | |
FiniteElementSpace * | fes |
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 |
SparseMatrix * | Grad |
SparseMatrix * | cGrad |
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 Operator * | P |
Pointer to the prolongation matrix of fes, may be NULL. | |
const SparseMatrix * | cP |
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... | |
Definition at line 24 of file nonlinearform.hpp.
|
inline |
Construct a NonlinearForm on the given FiniteElementSpace, f.
As an Operator, the NonlinearForm has input and output size equal to the number of true degrees of freedom, i.e. f->GetTrueVSize().
Definition at line 82 of file nonlinearform.hpp.
|
virtual |
Destroy the NonlinearForm including the owned NonlinearFormIntegrators and gradient Operator.
Definition at line 686 of file nonlinearform.cpp.
|
inline |
Adds new Boundary Face Integrator, restricted to specific boundary attributes.
Definition at line 159 of file nonlinearform.hpp.
|
inline |
Adds new Boundary Face Integrator.
Definition at line 154 of file nonlinearform.hpp.
|
inline |
Adds new Boundary Integrator.
Definition at line 132 of file nonlinearform.hpp.
|
inline |
Adds new Boundary Integrator, restricted to specific attributes.
Definition at line 136 of file nonlinearform.hpp.
|
inline |
Adds new Domain Integrator.
Definition at line 119 of file nonlinearform.hpp.
|
inline |
Adds new Domain Integrator, restricted to specific attributes.
Definition at line 123 of file nonlinearform.hpp.
|
inline |
Adds new Interior Face Integrator.
Definition at line 145 of file nonlinearform.hpp.
|
inline |
Definition at line 115 of file nonlinearform.hpp.
|
inline |
Definition at line 116 of file nonlinearform.hpp.
|
inline |
Access all boundary face integrators added with AddBdrFaceIntegrator().
Definition at line 165 of file nonlinearform.hpp.
|
inline |
Access all integrators added with AddBoundaryIntegrator().
Definition at line 141 of file nonlinearform.hpp.
|
inline |
Definition at line 142 of file nonlinearform.hpp.
|
inline |
Access all integrators added with AddDomainIntegrator().
Definition at line 128 of file nonlinearform.hpp.
|
inline |
Definition at line 129 of file nonlinearform.hpp.
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 in mfem::ParNonlinearForm.
Definition at line 198 of file nonlinearform.hpp.
|
inline |
Return a (read-only) list of all essential true dofs.
Definition at line 185 of file nonlinearform.hpp.
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::Operator.
Reimplemented in mfem::ParNonlinearForm.
Definition at line 434 of file nonlinearform.cpp.
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 86 of file nonlinearform.cpp.
|
inline |
Access all interior face integrators added with AddInteriorFaceIntegrator().
Definition at line 150 of file nonlinearform.hpp.
|
inlinevirtual |
Get the finite element space prolongation matrix.
Reimplemented from mfem::Operator.
Definition at line 236 of file nonlinearform.hpp.
|
inlinevirtual |
Get the finite element space restriction matrix.
Reimplemented from mfem::Operator.
Definition at line 238 of file nonlinearform.hpp.
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().
Implements mfem::Operator.
Reimplemented in mfem::ParNonlinearForm.
Definition at line 215 of file nonlinearform.cpp.
Definition at line 203 of file nonlinearform.cpp.
|
inlineprotected |
Definition at line 75 of file nonlinearform.hpp.
void mfem::NonlinearForm::SetAssemblyLevel | ( | AssemblyLevel | assembly_level | ) |
Set the desired assembly level. The default is AssemblyLevel::LEGACY.
For nonlinear operators, the "matrix" assembly levels usually do not make sense, so only LEGACY, NONE (matrix-free) and PARTIAL are supported.
Currently, AssemblyLevel::LEGACY uses the standard nonlinear action methods like AssembleElementVector of the NonlinearFormIntegrator class which work only on CPU and do not utilize features such as fast tensor-product basis evaluations. In this mode, the gradient operator is constructed as a SparseMatrix (or, in parallel, format such as HypreParMatrix).
When using AssemblyLevel::PARTIAL, the action is performed using methods like AddMultPA of the NonlinearFormIntegrator class which typically support both CPU and GPU backends and utilize features such as fast tensor-product basis evaluations. In this mode, the gradient operator also uses partial assembly with support for CPU and GPU backends.
When using AssemblyLevel::NONE, the action is performed using methods like AddMultMF of the NonlinearFormIntegrator class which typically support both CPU and GPU backends and utilize features such as fast tensor-product basis evaluations. In this mode, the gradient operator is currently not supported.
This method must be called before "assembly" with Setup().
Definition at line 18 of file nonlinearform.cpp.
void mfem::NonlinearForm::SetEssentialBC | ( | const Array< int > & | bdr_attr_is_ess, |
Vector * | rhs = NULL ) |
Specify essential boundary conditions.
This method calls FiniteElementSpace::GetEssentialTrueDofs() and stores the result internally for use by other methods. If the rhs pointer is not NULL, its essential true dofs will be set to zero. This makes it "compatible" with the output vectors from the Mult() method which also have zero entries at the essential true dofs.
Definition at line 41 of file nonlinearform.cpp.
|
inline |
Specify essential boundary conditions.
Definition at line 181 of file nonlinearform.hpp.
void mfem::NonlinearForm::SetEssentialVDofs | ( | const Array< int > & | ess_vdofs_list | ) |
Specify essential boundary conditions.
Use either SetEssentialBC() or SetEssentialTrueDofs() if possible.
Definition at line 56 of file nonlinearform.cpp.
|
virtual |
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().
Typically, this method has to be called before Mult() when using AssemblyLevel::PARTIAL, after calling Update(), or after modifying the mesh coordinates.
Definition at line 681 of file nonlinearform.cpp.
|
virtual |
Update the NonlinearForm to propagate updates of the associated FE space.
After calling this method, the essential boundary conditions need to be set again.
Reimplemented in mfem::ParNonlinearForm.
Definition at line 664 of file nonlinearform.cpp.
|
inline |
Indicate that integrators are not owned by the NonlinearForm.
Definition at line 242 of file nonlinearform.hpp.
|
protected |
The assembly level.
Definition at line 28 of file nonlinearform.hpp.
|
mutableprotected |
Auxiliary Vectors.
Definition at line 68 of file nonlinearform.hpp.
|
protected |
Definition at line 68 of file nonlinearform.hpp.
|
protected |
Set of boundary face Integrators to be assembled (added).
Definition at line 54 of file nonlinearform.hpp.
Definition at line 55 of file nonlinearform.hpp.
|
protected |
Set of Boundary Integrators to be assembled (added).
Definition at line 47 of file nonlinearform.hpp.
Definition at line 48 of file nonlinearform.hpp.
|
protected |
Definition at line 57 of file nonlinearform.hpp.
|
protected |
The result of dynamic-casting P to SparseMatrix pointer.
Definition at line 73 of file nonlinearform.hpp.
|
protected |
Set of Domain Integrators to be assembled (added).
Definition at line 43 of file nonlinearform.hpp.
Definition at line 44 of file nonlinearform.hpp.
|
protected |
A list of all essential true dofs.
Definition at line 62 of file nonlinearform.hpp.
|
protected |
Extension for supporting different AssemblyLevels.
For nonlinear operators, the "matrix" assembly levels usually do not make sense, so only PARTIAL and NONE (matrix-free) are supported.
Definition at line 33 of file nonlinearform.hpp.
|
protected |
Indicates the NonlinearFormIntegrators stored in dnfi, bnfi, fnfi, and bfnfi are not owned by this NonlinearForm.
Definition at line 40 of file nonlinearform.hpp.
|
protected |
FE space on which the form lives.
Definition at line 36 of file nonlinearform.hpp.
|
protected |
Set of interior face Integrators to be assembled (added).
Definition at line 51 of file nonlinearform.hpp.
|
mutableprotected |
Definition at line 57 of file nonlinearform.hpp.
|
mutableprotected |
Gradient Operator when not assembled as a matrix.
Definition at line 59 of file nonlinearform.hpp.
|
protected |
Pointer to the prolongation matrix of fes, may be NULL.
Definition at line 71 of file nonlinearform.hpp.
|
protected |
Counter for updates propagated from the FiniteElementSpace.
Definition at line 65 of file nonlinearform.hpp.