MFEM
v4.4.0
Finite element discretization library
|
A class representing a general parallel block nonlinear operator defined on the Cartesian product of multiple ParFiniteElementSpaces. More...
#include <pnonlinearform.hpp>
Public Member Functions | |
virtual double | GetEnergy (const Vector &x) const |
Computes the energy of the system. More... | |
ParBlockNonlinearForm () | |
Construct an empty ParBlockNonlinearForm. Initialize with SetParSpaces(). More... | |
ParBlockNonlinearForm (Array< ParFiniteElementSpace * > &pf) | |
Construct a ParBlockNonlinearForm on the given set of ParFiniteElementSpaces. More... | |
ParFiniteElementSpace * | ParFESpace (int k) |
Return the k-th parallel FE space of the ParBlockNonlinearForm. More... | |
const ParFiniteElementSpace * | ParFESpace (int k) const |
Return the k-th parallel FE space of the ParBlockNonlinearForm (const version). More... | |
void | SetParSpaces (Array< ParFiniteElementSpace * > &pf) |
After a call to SetParSpaces(), the essential b.c. and the gradient-type (if different from the default) must be set again. More... | |
virtual void | SetEssentialBC (const Array< Array< int > * > &bdr_attr_is_ess, Array< Vector * > &rhs) |
virtual void | Mult (const Vector &x, Vector &y) const |
Block T-Vector to Block T-Vector. More... | |
const BlockOperator & | GetLocalGradient (const Vector &x) const |
Return the local block gradient matrix for the given true-dof vector x. More... | |
virtual BlockOperator & | GetGradient (const Vector &x) const |
void | SetGradientType (Operator::Type tid) |
Set the operator type id for the blocks of the parallel gradient matrix/operator. The default type is Operator::Hypre_ParCSR. More... | |
virtual | ~ParBlockNonlinearForm () |
Destructor. More... | |
Public Member Functions inherited from mfem::BlockNonlinearForm | |
BlockNonlinearForm () | |
Construct an empty BlockNonlinearForm. Initialize with SetSpaces(). More... | |
BlockNonlinearForm (Array< FiniteElementSpace * > &f) | |
Construct a BlockNonlinearForm on the given set of FiniteElementSpaces. More... | |
FiniteElementSpace * | FESpace (int k) |
Return the k-th FE space of the BlockNonlinearForm. More... | |
const FiniteElementSpace * | FESpace (int k) const |
Return the k-th FE space of the BlockNonlinearForm (const version). More... | |
void | SetSpaces (Array< FiniteElementSpace * > &f) |
(Re)initialize the BlockNonlinearForm. More... | |
const Array< int > & | GetBlockOffsets () const |
Return the regular dof offsets. More... | |
const Array< int > & | GetBlockTrueOffsets () const |
Return the true-dof offsets. More... | |
void | AddDomainIntegrator (BlockNonlinearFormIntegrator *nlfi) |
Adds new Domain Integrator. More... | |
void | AddInteriorFaceIntegrator (BlockNonlinearFormIntegrator *nlfi) |
Adds new Interior Face Integrator. More... | |
void | AddBdrFaceIntegrator (BlockNonlinearFormIntegrator *nlfi) |
Adds new Boundary Face Integrator. More... | |
void | AddBdrFaceIntegrator (BlockNonlinearFormIntegrator *nlfi, Array< int > &bdr_marker) |
Adds new Boundary Face Integrator, restricted to specific boundary attributes. More... | |
virtual | ~BlockNonlinearForm () |
Destructor. More... | |
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. More... | |
Operator (int s=0) | |
Construct a square Operator with given size s (default 0). More... | |
Operator (int h, int w) | |
Construct an Operator with the given height (output size) and width (input size). More... | |
int | Height () const |
Get the height (size of output) of the Operator. Synonym with NumRows(). More... | |
int | NumRows () const |
Get the number of rows (size of output) of the Operator. Synonym with Height(). More... | |
int | Width () const |
Get the width (size of input) of the Operator. Synonym with NumCols(). More... | |
int | NumCols () const |
Get the number of columns (size of input) of the Operator. Synonym with Width(). More... | |
virtual MemoryClass | GetMemoryClass () const |
Return the MemoryClass preferred by the Operator. More... | |
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. More... | |
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. More... | |
virtual const Operator * | GetProlongation () const |
Prolongation operator from linear algebra (linear system) vectors, to input vectors for the operator. NULL means identity. More... | |
virtual const Operator * | GetRestriction () const |
Restriction operator from input vectors for the operator to linear algebra (linear system) vectors. NULL means identity. More... | |
virtual const Operator * | GetOutputProlongation () const |
Prolongation operator from linear algebra (linear system) vectors, to output vectors for the operator. NULL means identity. More... | |
virtual const Operator * | GetOutputRestrictionTranspose () const |
Transpose of GetOutputRestriction, directly available in this form to facilitate matrix-free RAP-type operators. More... | |
virtual const Operator * | GetOutputRestriction () const |
Restriction operator from output vectors for the operator to linear algebra (linear system) vectors. NULL means identity. More... | |
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. More... | |
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. More... | |
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(). More... | |
void | FormSystemOperator (const Array< int > &ess_tdof_list, Operator *&A) |
Return in A a parallel (on truedofs) version of this square operator. More... | |
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). More... | |
void | FormDiscreteOperator (Operator *&A) |
Return in A a parallel (on truedofs) version of this rectangular operator. More... | |
void | PrintMatlab (std::ostream &out, int n, int m=0) const |
Prints operator with input size n and output size m in Matlab format. More... | |
virtual void | PrintMatlab (std::ostream &out) const |
Prints operator in Matlab format. More... | |
virtual | ~Operator () |
Virtual destructor. More... | |
Type | GetType () const |
Return the type ID of the Operator class. More... | |
Protected Attributes | |
BlockVector | xs_true |
BlockVector | ys_true |
Array2D< OperatorHandle * > | phBlockGrad |
BlockOperator * | pBlockGrad |
Protected Attributes inherited from mfem::BlockNonlinearForm | |
Array< FiniteElementSpace * > | fes |
FE spaces on which the form lives. More... | |
Array < BlockNonlinearFormIntegrator * > | dnfi |
Set of Domain Integrators to be assembled (added). More... | |
Array < BlockNonlinearFormIntegrator * > | fnfi |
Set of interior face Integrators to be assembled (added). More... | |
Array < BlockNonlinearFormIntegrator * > | bfnfi |
Set of Boundary Face Integrators to be assembled (added). More... | |
Array< Array< int > * > | bfnfi_marker |
BlockVector | xs |
BlockVector | ys |
Array2D< SparseMatrix * > | Grads |
Array2D< SparseMatrix * > | cGrads |
BlockOperator * | BlockGrad |
Array< int > | block_offsets |
Array< int > | block_trueOffsets |
Array< Array< int > * > | ess_tdofs |
Array< const Operator * > | P |
Array of pointers to the prolongation matrix of fes, may be NULL. More... | |
Array< const SparseMatrix * > | cP |
Array of results of dynamic-casting P to SparseMatrix pointer. More... | |
bool | is_serial = true |
Indicator if the Operator is part of a parallel run. More... | |
bool | needs_prolongation = false |
Indicator if the Operator needs prolongation on assembly. More... | |
BlockVector | aux1 |
BlockVector | aux2 |
Protected Attributes inherited from mfem::Operator | |
int | height |
Dimension of the output / number of rows in the matrix. More... | |
int | width |
Dimension of the input / number of columns in the matrix. More... | |
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 } |
Enumeration defining IDs for some classes derived from Operator. More... | |
Protected Member Functions inherited from mfem::BlockNonlinearForm | |
const BlockVector & | Prolongate (const BlockVector &bx) const |
double | GetEnergyBlocked (const BlockVector &bx) const |
Specialized version of GetEnergy() for BlockVectors. More... | |
void | MultBlocked (const BlockVector &bx, BlockVector &by) const |
void | ComputeGradientBlocked (const BlockVector &bx) const |
Specialized version of GetGradient() for BlockVector. More... | |
Protected Member Functions inherited from mfem::Operator | |
void | FormConstrainedSystemOperator (const Array< int > &ess_tdof_list, ConstrainedOperator *&Aout) |
see FormSystemOperator() More... | |
void | FormRectangularConstrainedSystemOperator (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, RectangularConstrainedOperator *&Aout) |
see FormRectangularSystemOperator() More... | |
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". More... | |
A class representing a general parallel block nonlinear operator defined on the Cartesian product of multiple ParFiniteElementSpaces.
The ParBlockNonlinearForm takes as input, and returns as output, vectors on the true dofs.
Definition at line 77 of file pnonlinearform.hpp.
|
inline |
Construct an empty ParBlockNonlinearForm. Initialize with SetParSpaces().
Definition at line 89 of file pnonlinearform.hpp.
mfem::ParBlockNonlinearForm::ParBlockNonlinearForm | ( | Array< ParFiniteElementSpace * > & | pf | ) |
Construct a ParBlockNonlinearForm on the given set of ParFiniteElementSpaces.
Definition at line 150 of file pnonlinearform.cpp.
|
virtual |
Destructor.
Definition at line 382 of file pnonlinearform.cpp.
|
virtual |
Computes the energy of the system.
Reimplemented from mfem::BlockNonlinearForm.
Definition at line 219 of file pnonlinearform.cpp.
|
virtual |
Method is only called in serial, the parallel version calls GetGradientBlocked directly.
Reimplemented from mfem::BlockNonlinearForm.
Definition at line 314 of file pnonlinearform.cpp.
const BlockOperator & mfem::ParBlockNonlinearForm::GetLocalGradient | ( | const Vector & | x | ) | const |
Return the local block gradient matrix for the given true-dof vector x.
Return the local gradient matrix for the given true-dof vector x.
Definition at line 273 of file pnonlinearform.cpp.
Block T-Vector to Block T-Vector.
Reimplemented from mfem::BlockNonlinearForm.
Definition at line 239 of file pnonlinearform.cpp.
ParFiniteElementSpace * mfem::ParBlockNonlinearForm::ParFESpace | ( | int | k | ) |
Return the k-th parallel FE space of the ParBlockNonlinearForm.
Definition at line 190 of file pnonlinearform.cpp.
const ParFiniteElementSpace * mfem::ParBlockNonlinearForm::ParFESpace | ( | int | k | ) | const |
Return the k-th parallel FE space of the ParBlockNonlinearForm (const version).
Definition at line 195 of file pnonlinearform.cpp.
|
virtual |
Reimplemented from mfem::BlockNonlinearForm.
Definition at line 201 of file pnonlinearform.cpp.
void mfem::ParBlockNonlinearForm::SetGradientType | ( | Operator::Type | tid | ) |
Set the operator type id for the blocks of the parallel gradient matrix/operator. The default type is Operator::Hypre_ParCSR.
Definition at line 303 of file pnonlinearform.cpp.
void mfem::ParBlockNonlinearForm::SetParSpaces | ( | Array< ParFiniteElementSpace * > & | pf | ) |
After a call to SetParSpaces(), the essential b.c. and the gradient-type (if different from the default) must be set again.
Definition at line 157 of file pnonlinearform.cpp.
|
mutableprotected |
Definition at line 82 of file pnonlinearform.hpp.
|
mutableprotected |
Definition at line 81 of file pnonlinearform.hpp.
|
mutableprotected |
Definition at line 80 of file pnonlinearform.hpp.
|
mutableprotected |
Definition at line 80 of file pnonlinearform.hpp.