MFEM  v4.5.2
Finite element discretization library
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
mfem::BlockNonlinearForm Class Reference

A class representing a general block nonlinear operator defined on the Cartesian product of multiple FiniteElementSpaces. More...

#include <nonlinearform.hpp>

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

Public Member Functions

 BlockNonlinearForm ()
 Construct an empty BlockNonlinearForm. Initialize with SetSpaces(). More...
 
 BlockNonlinearForm (Array< FiniteElementSpace *> &f)
 Construct a BlockNonlinearForm on the given set of FiniteElementSpaces. More...
 
FiniteElementSpaceFESpace (int k)
 Return the k-th FE space of the BlockNonlinearForm. More...
 
const FiniteElementSpaceFESpace (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 void SetEssentialBC (const Array< Array< int > *> &bdr_attr_is_ess, Array< Vector *> &rhs)
 
virtual double GetEnergy (const Vector &x) const
 
virtual void Mult (const Vector &x, Vector &y) const
 
virtual OperatorGetGradient (const Vector &x) const
 
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 AddMult (const Vector &x, Vector &y, const double a=1.0) const
 Operator application: y+=A(x) (default) or y+=a*A(x). More...
 
virtual void AddMultTranspose (const Vector &x, Vector &y, const double a=1.0) const
 Operator transpose application: y+=A^t(x) (default) or y+=a*A^t(x). More...
 
virtual void ArrayMult (const Array< const Vector *> &X, Array< Vector *> &Y) const
 Operator application on a matrix: Y=A(X). More...
 
virtual void ArrayMultTranspose (const Array< const Vector *> &X, Array< Vector *> &Y) const
 Action of the transpose operator on a matrix: Y=A^t(X). More...
 
virtual void ArrayAddMult (const Array< const Vector *> &X, Array< Vector *> &Y, const double a=1.0) const
 Operator application on a matrix: Y+=A(X) (default) or Y+=a*A(X). More...
 
virtual void ArrayAddMultTranspose (const Array< const Vector *> &X, Array< Vector *> &Y, const double a=1.0) const
 Operator transpose application on a matrix: Y+=A^t(X) (default) or Y+=a*A^t(X). 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 OperatorGetProlongation () const
 Prolongation operator from linear algebra (linear system) vectors, to input vectors for the operator. NULL means identity. More...
 
virtual const OperatorGetRestriction () const
 Restriction operator from input vectors for the operator to linear algebra (linear system) vectors. NULL means identity. More...
 
virtual const OperatorGetOutputProlongation () const
 Prolongation operator from linear algebra (linear system) vectors, to output vectors for the operator. NULL means identity. More...
 
virtual const OperatorGetOutputRestrictionTranspose () const
 Transpose of GetOutputRestriction, directly available in this form to facilitate matrix-free RAP-type operators. More...
 
virtual const OperatorGetOutputRestriction () 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 Member Functions

const BlockVectorProlongate (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...
 
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". More...
 

Protected Attributes

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
 
BlockOperatorBlockGrad
 
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,
  Complex_DenseMat, MFEM_Block_Matrix, MFEM_Block_Operator
}
 Enumeration defining IDs for some classes derived from Operator. More...
 

Detailed Description

A class representing a general block nonlinear operator defined on the Cartesian product of multiple FiniteElementSpaces.

Definition at line 222 of file nonlinearform.hpp.

Constructor & Destructor Documentation

◆ BlockNonlinearForm() [1/2]

mfem::BlockNonlinearForm::BlockNonlinearForm ( )

Construct an empty BlockNonlinearForm. Initialize with SetSpaces().

Definition at line 481 of file nonlinearform.cpp.

◆ BlockNonlinearForm() [2/2]

mfem::BlockNonlinearForm::BlockNonlinearForm ( Array< FiniteElementSpace *> &  f)

Construct a BlockNonlinearForm on the given set of FiniteElementSpaces.

Definition at line 558 of file nonlinearform.cpp.

◆ ~BlockNonlinearForm()

mfem::BlockNonlinearForm::~BlockNonlinearForm ( )
virtual

Destructor.

Definition at line 1099 of file nonlinearform.cpp.

Member Function Documentation

◆ AddBdrFaceIntegrator() [1/2]

void mfem::BlockNonlinearForm::AddBdrFaceIntegrator ( BlockNonlinearFormIntegrator nlfi)
inline

Adds new Boundary Face Integrator.

Definition at line 308 of file nonlinearform.hpp.

◆ AddBdrFaceIntegrator() [2/2]

void mfem::BlockNonlinearForm::AddBdrFaceIntegrator ( BlockNonlinearFormIntegrator nlfi,
Array< int > &  bdr_marker 
)

Adds new Boundary Face Integrator, restricted to specific boundary attributes.

Definition at line 564 of file nonlinearform.cpp.

◆ AddDomainIntegrator()

void mfem::BlockNonlinearForm::AddDomainIntegrator ( BlockNonlinearFormIntegrator nlfi)
inline

Adds new Domain Integrator.

Definition at line 300 of file nonlinearform.hpp.

◆ AddInteriorFaceIntegrator()

void mfem::BlockNonlinearForm::AddInteriorFaceIntegrator ( BlockNonlinearFormIntegrator nlfi)
inline

Adds new Interior Face Integrator.

Definition at line 304 of file nonlinearform.hpp.

◆ ComputeGradientBlocked()

void mfem::BlockNonlinearForm::ComputeGradientBlocked ( const BlockVector bx) const
protected

Specialized version of GetGradient() for BlockVector.

Definition at line 849 of file nonlinearform.cpp.

◆ FESpace() [1/2]

FiniteElementSpace* mfem::BlockNonlinearForm::FESpace ( int  k)
inline

Return the k-th FE space of the BlockNonlinearForm.

Definition at line 286 of file nonlinearform.hpp.

◆ FESpace() [2/2]

const FiniteElementSpace* mfem::BlockNonlinearForm::FESpace ( int  k) const
inline

Return the k-th FE space of the BlockNonlinearForm (const version).

Definition at line 288 of file nonlinearform.hpp.

◆ GetBlockOffsets()

const Array<int>& mfem::BlockNonlinearForm::GetBlockOffsets ( ) const
inline

Return the regular dof offsets.

Definition at line 295 of file nonlinearform.hpp.

◆ GetBlockTrueOffsets()

const Array<int>& mfem::BlockNonlinearForm::GetBlockTrueOffsets ( ) const
inline

Return the true-dof offsets.

Definition at line 297 of file nonlinearform.hpp.

◆ GetEnergy()

double mfem::BlockNonlinearForm::GetEnergy ( const Vector x) const
virtual

Reimplemented in mfem::ParBlockNonlinearForm.

Definition at line 641 of file nonlinearform.cpp.

◆ GetEnergyBlocked()

double mfem::BlockNonlinearForm::GetEnergyBlocked ( const BlockVector bx) const
protected

Specialized version of GetEnergy() for BlockVectors.

Definition at line 587 of file nonlinearform.cpp.

◆ GetGradient()

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

Method is only called in serial, the parallel version calls GetGradientBlocked directly.

Reimplemented from mfem::Operator.

Reimplemented in mfem::ParBlockNonlinearForm.

Definition at line 1045 of file nonlinearform.cpp.

◆ Mult()

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

Method is only called in serial, the parallel version calls MultBlocked directly.

Implements mfem::Operator.

Reimplemented in mfem::ParBlockNonlinearForm.

Definition at line 823 of file nonlinearform.cpp.

◆ MultBlocked()

void mfem::BlockNonlinearForm::MultBlocked ( const BlockVector bx,
BlockVector by 
) const
protected

Specialized version of Mult() for BlockVectors Block L-Vector to Block L-Vector

Definition at line 647 of file nonlinearform.cpp.

◆ Prolongate()

const BlockVector & mfem::BlockNonlinearForm::Prolongate ( const BlockVector bx) const
protected

Definition at line 807 of file nonlinearform.cpp.

◆ SetEssentialBC()

void mfem::BlockNonlinearForm::SetEssentialBC ( const Array< Array< int > *> &  bdr_attr_is_ess,
Array< Vector *> &  rhs 
)
virtual

Reimplemented in mfem::ParBlockNonlinearForm.

Definition at line 571 of file nonlinearform.cpp.

◆ SetSpaces()

void mfem::BlockNonlinearForm::SetSpaces ( Array< FiniteElementSpace *> &  f)

(Re)initialize the BlockNonlinearForm.

After a call to SetSpaces(), the essential b.c. must be set again.

Definition at line 488 of file nonlinearform.cpp.

Member Data Documentation

◆ aux1

BlockVector mfem::BlockNonlinearForm::aux1
mutableprotected

Definition at line 264 of file nonlinearform.hpp.

◆ aux2

BlockVector mfem::BlockNonlinearForm::aux2
mutableprotected

Definition at line 264 of file nonlinearform.hpp.

◆ bfnfi

Array<BlockNonlinearFormIntegrator*> mfem::BlockNonlinearForm::bfnfi
protected

Set of Boundary Face Integrators to be assembled (added).

Definition at line 235 of file nonlinearform.hpp.

◆ bfnfi_marker

Array<Array<int>*> mfem::BlockNonlinearForm::bfnfi_marker
protected

Definition at line 236 of file nonlinearform.hpp.

◆ block_offsets

Array<int> mfem::BlockNonlinearForm::block_offsets
protected

Definition at line 246 of file nonlinearform.hpp.

◆ block_trueOffsets

Array<int> mfem::BlockNonlinearForm::block_trueOffsets
protected

Definition at line 247 of file nonlinearform.hpp.

◆ BlockGrad

BlockOperator* mfem::BlockNonlinearForm::BlockGrad
mutableprotected

Definition at line 243 of file nonlinearform.hpp.

◆ cGrads

Array2D<SparseMatrix*> mfem::BlockNonlinearForm::cGrads
mutableprotected

Definition at line 242 of file nonlinearform.hpp.

◆ cP

Array<const SparseMatrix *> mfem::BlockNonlinearForm::cP
protected

Array of results of dynamic-casting P to SparseMatrix pointer.

Definition at line 256 of file nonlinearform.hpp.

◆ dnfi

Array<BlockNonlinearFormIntegrator*> mfem::BlockNonlinearForm::dnfi
protected

Set of Domain Integrators to be assembled (added).

Definition at line 229 of file nonlinearform.hpp.

◆ ess_tdofs

Array<Array<int> *> mfem::BlockNonlinearForm::ess_tdofs
protected

Definition at line 250 of file nonlinearform.hpp.

◆ fes

Array<FiniteElementSpace*> mfem::BlockNonlinearForm::fes
protected

FE spaces on which the form lives.

Definition at line 226 of file nonlinearform.hpp.

◆ fnfi

Array<BlockNonlinearFormIntegrator*> mfem::BlockNonlinearForm::fnfi
protected

Set of interior face Integrators to be assembled (added).

Definition at line 232 of file nonlinearform.hpp.

◆ Grads

Array2D<SparseMatrix*> mfem::BlockNonlinearForm::Grads
mutableprotected

Definition at line 242 of file nonlinearform.hpp.

◆ is_serial

bool mfem::BlockNonlinearForm::is_serial = true
protected

Indicator if the Operator is part of a parallel run.

Definition at line 259 of file nonlinearform.hpp.

◆ needs_prolongation

bool mfem::BlockNonlinearForm::needs_prolongation = false
protected

Indicator if the Operator needs prolongation on assembly.

Definition at line 262 of file nonlinearform.hpp.

◆ P

Array<const Operator *> mfem::BlockNonlinearForm::P
protected

Array of pointers to the prolongation matrix of fes, may be NULL.

Definition at line 253 of file nonlinearform.hpp.

◆ xs

BlockVector mfem::BlockNonlinearForm::xs
mutableprotected

Auxiliary block-vectors for wrapping input and output vectors or holding GridFunction-like block-vector data (e.g. in parallel).

Definition at line 240 of file nonlinearform.hpp.

◆ ys

BlockVector mfem::BlockNonlinearForm::ys
mutableprotected

Definition at line 240 of file nonlinearform.hpp.


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