MFEM v4.7.0
Finite element discretization library
|
A class representing a general parametric block nonlinear operator defined on the Cartesian product of multiple FiniteElementSpaces. More...
#include <paramnonlinearform.hpp>
Public Member Functions | |
ParametricBNLForm () | |
Construct an empty BlockNonlinearForm. Initialize with SetSpaces(). | |
ParametricBNLForm (Array< FiniteElementSpace * > &statef, Array< FiniteElementSpace * > ¶mf) | |
Construct a BlockNonlinearForm on the given set of FiniteElementSpaces. | |
FiniteElementSpace * | FESpace (int k) |
Return the k-th FE space of the ParametricBNLForm. | |
FiniteElementSpace * | ParamFESpace (int k) |
Return the k-th parametric FE space of the ParametricBNLForm. | |
const FiniteElementSpace * | FESpace (int k) const |
Return the k-th FE space of the BlockNonlinearForm (const version). | |
const FiniteElementSpace * | ParamFESpace (int k) const |
Array< ParametricBNLFormIntegrator * > & | GetDNFI () |
Return the integrators. | |
void | SetSpaces (Array< FiniteElementSpace * > &statef, Array< FiniteElementSpace * > ¶mf) |
(Re)initialize the ParametricBNLForm. | |
const Array< int > & | GetBlockOffsets () const |
Return the regular dof offsets. | |
const Array< int > & | GetBlockTrueOffsets () const |
Return the true-dof offsets. | |
const Array< int > & | ParamGetBlockOffsets () const |
Return the regular dof offsets for the parameters. | |
const Array< int > & | ParamGetBlockTrueOffsets () const |
Return the true-dof offsets for the parameters. | |
void | AddDomainIntegrator (ParametricBNLFormIntegrator *nlfi) |
Adds new Domain Integrator. | |
void | AddInteriorFaceIntegrator (ParametricBNLFormIntegrator *nlfi) |
Adds new Interior Face Integrator. | |
void | AddBdrFaceIntegrator (ParametricBNLFormIntegrator *nlfi) |
Adds new Boundary Face Integrator. | |
void | AddBdrFaceIntegrator (ParametricBNLFormIntegrator *nlfi, Array< int > &bdr_marker) |
Adds new Boundary Face Integrator, restricted to specific boundary attributes. | |
virtual void | SetEssentialBC (const Array< Array< int > * > &bdr_attr_is_ess, Array< Vector * > &rhs) |
Set the essential boundary conditions. | |
virtual void | SetParamEssentialBC (const Array< Array< int > * > &bdr_attr_is_ess, Array< Vector * > &rhs) |
Set the essential boundary conditions on the parametric fields. | |
virtual real_t | GetEnergy (const Vector &x) const |
Computes the energy for a state vector x. | |
virtual void | Mult (const Vector &x, Vector &y) const |
virtual void | ParamMult (const Vector &x, Vector &y) const |
virtual BlockOperator & | GetGradient (const Vector &x) const |
virtual void | SetStateFields (const Vector &xv) const |
Set the state fields. | |
virtual void | SetAdjointFields (const Vector &av) const |
Set the adjoint fields. | |
virtual void | SetParamFields (const Vector &dv) const |
Set the parameters/design fields. | |
virtual | ~ParametricBNLForm () |
Destructor. | |
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 * | 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. | |
Protected Member Functions | |
const BlockVector & | Prolongate (const BlockVector &bx) const |
const BlockVector & | ParamProlongate (const BlockVector &bx) const |
real_t | GetEnergyBlocked (const BlockVector &bx, const BlockVector &dx) const |
void | MultBlocked (const BlockVector &bx, const BlockVector &dx, BlockVector &by) const |
void | MultParamBlocked (const BlockVector &bx, const BlockVector &ax, const BlockVector &dx, BlockVector &dy) const |
void | ComputeGradientBlocked (const BlockVector &bx, const BlockVector &dx) const |
Specialized version of GetGradient() for BlockVector. | |
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 | |
Array< FiniteElementSpace * > | fes |
FE spaces on which the form lives. | |
Array< FiniteElementSpace * > | paramfes |
FE spaces for the parametric fields. | |
int | paramheight |
int | paramwidth |
Array< ParametricBNLFormIntegrator * > | dnfi |
Set of Domain Integrators to be assembled (added). | |
Array< ParametricBNLFormIntegrator * > | fnfi |
Set of interior face Integrators to be assembled (added). | |
Array< ParametricBNLFormIntegrator * > | bfnfi |
Set of Boundary Face Integrators to be assembled (added). | |
Array< Array< int > * > | bfnfi_marker |
BlockVector | xs |
BlockVector | ys |
BlockVector | prmxs |
BlockVector | prmys |
BlockVector | xsv |
BlockVector | xdv |
BlockVector | adv |
Array2D< SparseMatrix * > | Grads |
Array2D< SparseMatrix * > | cGrads |
BlockOperator * | BlockGrad |
Array< int > | block_offsets |
Array< int > | block_trueOffsets |
Array< int > | paramblock_offsets |
Array< int > | paramblock_trueOffsets |
Array< Array< int > * > | ess_tdofs |
Array< Array< int > * > | paramess_tdofs |
Array< const Operator * > | P |
Array of pointers to the prolongation matrix of fes, may be NULL. | |
Array< const Operator * > | Pparam |
Array of pointers to the prolongation matrix of paramfes, may be NULL. | |
Array< const SparseMatrix * > | cP |
Array of results of dynamic-casting P to SparseMatrix pointer. | |
Array< const SparseMatrix * > | cPparam |
Array of results of dynamic-casting Pparam to SparseMatrix pointer. | |
bool | is_serial = true |
Indicator if the Operator is part of a parallel run. | |
bool | needs_prolongation = false |
Indicator if the Operator needs prolongation on assembly. | |
bool | prmneeds_prolongation = false |
Indicator if the Operator needs prolongation on assembly. | |
BlockVector | aux1 |
BlockVector | aux2 |
BlockVector | prmaux1 |
BlockVector | prmaux2 |
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... | |
A class representing a general parametric block nonlinear operator defined on the Cartesian product of multiple FiniteElementSpaces.
Definition at line 98 of file paramnonlinearform.hpp.
mfem::ParametricBNLForm::ParametricBNLForm | ( | ) |
Construct an empty BlockNonlinearForm. Initialize with SetSpaces().
Definition at line 114 of file paramnonlinearform.cpp.
mfem::ParametricBNLForm::ParametricBNLForm | ( | Array< FiniteElementSpace * > & | statef, |
Array< FiniteElementSpace * > & | paramf ) |
Construct a BlockNonlinearForm on the given set of FiniteElementSpaces.
Definition at line 123 of file paramnonlinearform.cpp.
|
virtual |
Destructor.
Definition at line 1254 of file paramnonlinearform.cpp.
|
inline |
Adds new Boundary Face Integrator.
Definition at line 252 of file paramnonlinearform.hpp.
void mfem::ParametricBNLForm::AddBdrFaceIntegrator | ( | ParametricBNLFormIntegrator * | nlfi, |
Array< int > & | bdr_marker ) |
Adds new Boundary Face Integrator, restricted to specific boundary attributes.
Definition at line 250 of file paramnonlinearform.cpp.
|
inline |
Adds new Domain Integrator.
Definition at line 244 of file paramnonlinearform.hpp.
|
inline |
Adds new Interior Face Integrator.
Definition at line 248 of file paramnonlinearform.hpp.
|
protected |
Specialized version of GetGradient() for BlockVector.
Definition at line 956 of file paramnonlinearform.cpp.
|
inline |
Return the k-th FE space of the ParametricBNLForm.
Definition at line 209 of file paramnonlinearform.hpp.
|
inline |
Return the k-th FE space of the BlockNonlinearForm (const version).
Definition at line 216 of file paramnonlinearform.hpp.
|
inline |
Return the regular dof offsets.
Definition at line 232 of file paramnonlinearform.hpp.
|
inline |
Return the true-dof offsets.
Definition at line 235 of file paramnonlinearform.hpp.
|
inline |
Return the integrators.
Definition at line 223 of file paramnonlinearform.hpp.
Computes the energy for a state vector x.
Reimplemented in mfem::ParParametricBNLForm.
Definition at line 389 of file paramnonlinearform.cpp.
|
protected |
Definition at line 257 of file paramnonlinearform.cpp.
|
virtual |
Method is only called in serial, the parallel version calls GetGradientBlocked directly.
Reimplemented from mfem::Operator.
Reimplemented in mfem::ParParametricBNLForm.
Definition at line 1199 of file paramnonlinearform.cpp.
Method is only called in serial, the parallel version calls MultBlocked directly.
Implements mfem::Operator.
Reimplemented in mfem::ParParametricBNLForm.
Definition at line 928 of file paramnonlinearform.cpp.
|
protected |
Specialized version of Mult() for BlockVectors Block L-Vector to Block L-Vector
Definition at line 654 of file paramnonlinearform.cpp.
|
protected |
Specialized version of Mult() for BlockVectors Block L-Vector to Block L-Vector bx - state vector, ax - adjoint vector, dx - parametric fields dy = ax' d(residual(bx))/d(dx)
Definition at line 429 of file paramnonlinearform.cpp.
|
inline |
Return the k-th parametric FE space of the ParametricBNLForm.
Definition at line 212 of file paramnonlinearform.hpp.
|
inline |
Return the k-th parametric FE space of the BlockNonlinearForm (const version).
Definition at line 220 of file paramnonlinearform.hpp.
|
inline |
Return the regular dof offsets for the parameters.
Definition at line 238 of file paramnonlinearform.hpp.
|
inline |
Return the true-dof offsets for the parameters.
Definition at line 241 of file paramnonlinearform.hpp.
Method is only called in serial, the parallel version calls MultBlocked directly.
Reimplemented in mfem::ParParametricBNLForm.
Definition at line 899 of file paramnonlinearform.cpp.
|
protected |
Definition at line 881 of file paramnonlinearform.cpp.
|
protected |
Definition at line 865 of file paramnonlinearform.cpp.
|
virtual |
Set the adjoint fields.
Reimplemented in mfem::ParParametricBNLForm.
Definition at line 356 of file paramnonlinearform.cpp.
|
virtual |
Set the essential boundary conditions.
Reimplemented in mfem::ParParametricBNLForm.
Definition at line 395 of file paramnonlinearform.cpp.
|
virtual |
Set the essential boundary conditions on the parametric fields.
Reimplemented in mfem::ParParametricBNLForm.
Definition at line 412 of file paramnonlinearform.cpp.
|
virtual |
Set the parameters/design fields.
Reimplemented in mfem::ParParametricBNLForm.
Definition at line 373 of file paramnonlinearform.cpp.
void mfem::ParametricBNLForm::SetSpaces | ( | Array< FiniteElementSpace * > & | statef, |
Array< FiniteElementSpace * > & | paramf ) |
(Re)initialize the ParametricBNLForm.
After a call to SetSpaces(), the essential b.c. must be set again.
Definition at line 130 of file paramnonlinearform.cpp.
|
virtual |
Set the state fields.
Reimplemented in mfem::ParParametricBNLForm.
Definition at line 340 of file paramnonlinearform.cpp.
|
mutableprotected |
Auxiliary block-vectors for holding GridFunction-like block-vector data for the adjoint fields (e.g. in parallel).
Definition at line 134 of file paramnonlinearform.hpp.
|
mutableprotected |
Definition at line 173 of file paramnonlinearform.hpp.
|
protected |
Definition at line 173 of file paramnonlinearform.hpp.
|
protected |
Set of Boundary Face Integrators to be assembled (added).
Definition at line 117 of file paramnonlinearform.hpp.
Definition at line 118 of file paramnonlinearform.hpp.
|
protected |
Definition at line 140 of file paramnonlinearform.hpp.
|
protected |
Definition at line 141 of file paramnonlinearform.hpp.
|
mutableprotected |
Definition at line 137 of file paramnonlinearform.hpp.
|
protected |
Definition at line 136 of file paramnonlinearform.hpp.
|
protected |
Array of results of dynamic-casting P to SparseMatrix pointer.
Definition at line 159 of file paramnonlinearform.hpp.
|
protected |
Array of results of dynamic-casting Pparam to SparseMatrix pointer.
Definition at line 162 of file paramnonlinearform.hpp.
|
protected |
Set of Domain Integrators to be assembled (added).
Definition at line 111 of file paramnonlinearform.hpp.
Definition at line 147 of file paramnonlinearform.hpp.
|
protected |
FE spaces on which the form lives.
Definition at line 102 of file paramnonlinearform.hpp.
|
protected |
Set of interior face Integrators to be assembled (added).
Definition at line 114 of file paramnonlinearform.hpp.
|
mutableprotected |
Definition at line 136 of file paramnonlinearform.hpp.
|
protected |
Indicator if the Operator is part of a parallel run.
Definition at line 165 of file paramnonlinearform.hpp.
|
protected |
Indicator if the Operator needs prolongation on assembly.
Definition at line 168 of file paramnonlinearform.hpp.
Array of pointers to the prolongation matrix of fes, may be NULL.
Definition at line 153 of file paramnonlinearform.hpp.
|
protected |
Definition at line 143 of file paramnonlinearform.hpp.
|
protected |
Definition at line 144 of file paramnonlinearform.hpp.
Definition at line 150 of file paramnonlinearform.hpp.
|
protected |
FE spaces for the parametric fields.
Definition at line 105 of file paramnonlinearform.hpp.
|
protected |
Definition at line 107 of file paramnonlinearform.hpp.
|
protected |
Definition at line 108 of file paramnonlinearform.hpp.
Array of pointers to the prolongation matrix of paramfes, may be NULL.
Definition at line 156 of file paramnonlinearform.hpp.
|
mutableprotected |
Definition at line 175 of file paramnonlinearform.hpp.
|
protected |
Definition at line 175 of file paramnonlinearform.hpp.
|
protected |
Indicator if the Operator needs prolongation on assembly.
Definition at line 171 of file paramnonlinearform.hpp.
|
mutableprotected |
Definition at line 123 of file paramnonlinearform.hpp.
|
protected |
Definition at line 123 of file paramnonlinearform.hpp.
|
mutableprotected |
Auxiliary block-vectors for holding GridFunction-like block-vector data for the parameter fields (e.g. in parallel).
Definition at line 131 of file paramnonlinearform.hpp.
|
mutableprotected |
Auxiliary block-vectors for wrapping input and output vectors or holding GridFunction-like block-vector data (e.g. in parallel).
Definition at line 122 of file paramnonlinearform.hpp.
|
mutableprotected |
Auxiliary block-vectors for holding GridFunction-like block-vector data (e.g. in parallel).
Definition at line 127 of file paramnonlinearform.hpp.
|
protected |
Definition at line 122 of file paramnonlinearform.hpp.