MFEM  v4.0
Finite element discretization library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
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
 Operator application: y=A(x). More...
 
virtual OperatorGetGradient (const Vector &x) const
 Evaluate the gradient operator at the point x. The default behavior in class Operator is to generate an error. More...
 
virtual ~BlockNonlinearForm ()
 Destructor. More...
 
- Public Member Functions inherited from mfem::Operator
 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 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...
 
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...
 
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(). More...
 
void PrintMatlab (std::ostream &out, int n=0, int m=0) const
 Prints operator with input size n and output size m in Matlab format. More...
 
virtual ~Operator ()
 Virtual destructor. More...
 
Type GetType () const
 Return the type ID of the Operator class. More...
 

Protected Member Functions

double GetEnergyBlocked (const BlockVector &bx) const
 Specialized version of GetEnergy() for BlockVectors. More...
 
void MultBlocked (const BlockVector &bx, BlockVector &by) const
 Specialized version of Mult() for BlockVectors. More...
 
OperatorGetGradientBlocked (const BlockVector &bx) const
 Specialized version of GetGradient() for BlockVector. 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
 
BlockOperatorBlockGrad
 
Array< int > block_offsets
 
Array< int > block_trueOffsets
 
Array< Array< int > * > ess_vdofs
 
- 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  Type {
  ANY_TYPE, MFEM_SPARSEMAT, Hypre_ParCSR, PETSC_MATAIJ,
  PETSC_MATIS, PETSC_MATSHELL, PETSC_MATNEST, PETSC_MATHYPRE,
  PETSC_MATGENERIC
}
 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 161 of file nonlinearform.hpp.

Constructor & Destructor Documentation

mfem::BlockNonlinearForm::BlockNonlinearForm ( )

Construct an empty BlockNonlinearForm. Initialize with SetSpaces().

Definition at line 400 of file nonlinearform.cpp.

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

Construct a BlockNonlinearForm on the given set of FiniteElementSpaces.

Definition at line 453 of file nonlinearform.cpp.

mfem::BlockNonlinearForm::~BlockNonlinearForm ( )
virtual

Destructor.

Definition at line 944 of file nonlinearform.cpp.

Member Function Documentation

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

Adds new Boundary Face Integrator.

Definition at line 230 of file nonlinearform.hpp.

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

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

Definition at line 459 of file nonlinearform.cpp.

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

Adds new Domain Integrator.

Definition at line 222 of file nonlinearform.hpp.

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

Adds new Interior Face Integrator.

Definition at line 226 of file nonlinearform.hpp.

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

Return the k-th FE space of the BlockNonlinearForm.

Definition at line 208 of file nonlinearform.hpp.

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

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

Definition at line 210 of file nonlinearform.hpp.

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

Return the regular dof offsets.

Definition at line 217 of file nonlinearform.hpp.

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

Return the true-dof offsets.

Definition at line 219 of file nonlinearform.hpp.

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

Definition at line 554 of file nonlinearform.cpp.

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

Specialized version of GetEnergy() for BlockVectors.

Definition at line 509 of file nonlinearform.cpp.

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

Evaluate the gradient operator at the point x. The default behavior in class Operator is to generate an error.

Reimplemented from mfem::Operator.

Reimplemented in mfem::ParBlockNonlinearForm.

Definition at line 938 of file nonlinearform.cpp.

Operator & mfem::BlockNonlinearForm::GetGradientBlocked ( const BlockVector bx) const
protected

Specialized version of GetGradient() for BlockVector.

Definition at line 721 of file nonlinearform.cpp.

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

Operator application: y=A(x).

Implements mfem::Operator.

Reimplemented in mfem::ParBlockNonlinearForm.

Definition at line 714 of file nonlinearform.cpp.

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

Specialized version of Mult() for BlockVectors.

Definition at line 560 of file nonlinearform.cpp.

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

Reimplemented in mfem::ParBlockNonlinearForm.

Definition at line 466 of file nonlinearform.cpp.

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 407 of file nonlinearform.cpp.

Member Data Documentation

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

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

Definition at line 174 of file nonlinearform.hpp.

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

Definition at line 175 of file nonlinearform.hpp.

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

Definition at line 185 of file nonlinearform.hpp.

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

Definition at line 186 of file nonlinearform.hpp.

BlockOperator* mfem::BlockNonlinearForm::BlockGrad
mutableprotected

Definition at line 182 of file nonlinearform.hpp.

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

Set of Domain Integrators to be assembled (added).

Definition at line 168 of file nonlinearform.hpp.

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

Definition at line 189 of file nonlinearform.hpp.

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

FE spaces on which the form lives.

Definition at line 165 of file nonlinearform.hpp.

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

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

Definition at line 171 of file nonlinearform.hpp.

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

Definition at line 181 of file nonlinearform.hpp.

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 179 of file nonlinearform.hpp.

BlockVector mfem::BlockNonlinearForm::ys
mutableprotected

Definition at line 179 of file nonlinearform.hpp.


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