MFEM  v3.3
Finite element discretization library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Protected Attributes | List of all members
mfem::ParNonlinearForm Class Reference

Parallel non-linear operator on the true dofs. More...

#include <pnonlinearform.hpp>

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

Public Member Functions

 ParNonlinearForm (ParFiniteElementSpace *pf)
 
ParFiniteElementSpaceParFESpace () const
 
virtual void SetEssentialBC (const Array< int > &bdr_attr_is_ess, Vector *rhs=NULL)
 
virtual double GetEnergy (const ParGridFunction &x) const
 Compute the energy of a ParGridFunction. More...
 
virtual double GetEnergy (const Vector &x) const
 Compute the energy of a true-dof vector 'x'. More...
 
virtual void Mult (const Vector &x, Vector &y) const
 Operator application: y=A(x). More...
 
const SparseMatrixGetLocalGradient (const Vector &x) const
 Return the local gradient matrix for the given true-dof vector 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...
 
void SetGradientType (Operator::Type tid)
 Set the operator type id for the parallel gradient matrix/operator. More...
 
virtual ~ParNonlinearForm ()
 
- Public Member Functions inherited from mfem::NonlinearForm
 NonlinearForm (FiniteElementSpace *f)
 
void AddDomainIntegrator (NonlinearFormIntegrator *nlfi)
 Adds new Domain Integrator. More...
 
void SetEssentialVDofs (const Array< int > &ess_vdofs_list)
 
virtual ~NonlinearForm ()
 
- 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 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...
 

Protected Attributes

ParGridFunction X
 
ParGridFunction Y
 
OperatorHandle pGrad
 
- Protected Attributes inherited from mfem::NonlinearForm
FiniteElementSpacefes
 FE space on which the form lives. More...
 
Array< NonlinearFormIntegrator * > dfi
 Set of Domain Integrators to be assembled (added). More...
 
SparseMatrixGrad
 
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 {
  MFEM_SPARSEMAT, HYPRE_PARCSR, PETSC_MATAIJ, PETSC_MATIS,
  PETSC_MATSHELL, PETSC_MATNEST
}
 Enumeration defining IDs for some classes derived from Operator. More...
 

Detailed Description

Parallel non-linear operator on the true dofs.

Definition at line 26 of file pnonlinearform.hpp.

Constructor & Destructor Documentation

mfem::ParNonlinearForm::ParNonlinearForm ( ParFiniteElementSpace pf)
inline

Definition at line 33 of file pnonlinearform.hpp.

virtual mfem::ParNonlinearForm::~ParNonlinearForm ( )
inlinevirtual

Definition at line 60 of file pnonlinearform.hpp.

Member Function Documentation

double mfem::ParNonlinearForm::GetEnergy ( const ParGridFunction x) const
virtual

Compute the energy of a ParGridFunction.

Definition at line 42 of file pnonlinearform.cpp.

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

Compute the energy of a true-dof vector 'x'.

Reimplemented from mfem::NonlinearForm.

Definition at line 54 of file pnonlinearform.cpp.

Operator & mfem::ParNonlinearForm::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::NonlinearForm.

Definition at line 80 of file pnonlinearform.cpp.

const SparseMatrix & mfem::ParNonlinearForm::GetLocalGradient ( const Vector x) const

Return the local gradient matrix for the given true-dof vector x.

Definition at line 71 of file pnonlinearform.cpp.

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

Operator application: y=A(x).

Reimplemented from mfem::NonlinearForm.

Definition at line 60 of file pnonlinearform.cpp.

ParFiniteElementSpace* mfem::ParNonlinearForm::ParFESpace ( ) const
inline

Definition at line 37 of file pnonlinearform.hpp.

void mfem::ParNonlinearForm::SetEssentialBC ( const Array< int > &  bdr_attr_is_ess,
Vector rhs = NULL 
)
virtual

Reimplemented from mfem::NonlinearForm.

Definition at line 21 of file pnonlinearform.cpp.

void mfem::ParNonlinearForm::SetGradientType ( Operator::Type  tid)
inline

Set the operator type id for the parallel gradient matrix/operator.

Definition at line 58 of file pnonlinearform.hpp.

Member Data Documentation

OperatorHandle mfem::ParNonlinearForm::pGrad
mutableprotected

Definition at line 30 of file pnonlinearform.hpp.

ParGridFunction mfem::ParNonlinearForm::X
mutableprotected

Definition at line 29 of file pnonlinearform.hpp.

ParGridFunction mfem::ParNonlinearForm::Y
mutableprotected

Definition at line 29 of file pnonlinearform.hpp.


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