mfem::NonlinearForm Class Reference

#include <nonlinearform.hpp>

Inheritance diagram for mfem::NonlinearForm:

Collaboration diagram for mfem::NonlinearForm:

Public Member Functions
	NonlinearForm (FiniteElementSpace *f)
void	AddDomainIntegrator (NonlinearFormIntegrator *nlfi)
	Adds new Domain Integrator. More...
virtual void	SetEssentialBC (const Array< int > &bdr_attr_is_ess, Vector *rhs=NULL)
void	SetEssentialVDofs (const Array< int > &ess_vdofs_list)
virtual double	GetEnergy (const Vector &x) const
virtual void	Mult (const Vector &x, Vector &y) const
	Operator application: y=A(x). More...
virtual Operator &	GetGradient (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	~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 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...
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
FiniteElementSpace *	fes
	FE space on which the form lives. More...
Array< NonlinearFormIntegrator * >	dfi
	Set of Domain Integrators to be assembled (added). More...
SparseMatrix *	Grad
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

Definition at line 22 of file nonlinearform.hpp.

Constructor & Destructor Documentation

mfem::NonlinearForm::NonlinearForm ( FiniteElementSpace *  f )

inline

Definition at line 37 of file nonlinearform.hpp.

mfem::NonlinearForm::~NonlinearForm ( )

virtual

Definition at line 148 of file nonlinearform.cpp.

Member Function Documentation

void mfem::NonlinearForm::AddDomainIntegrator ( NonlinearFormIntegrator *  nlfi )

inline

Adds new Domain Integrator.

Definition at line 41 of file nonlinearform.hpp.

double mfem::NonlinearForm::GetEnergy ( const Vector &  x ) const

virtual

Reimplemented in mfem::ParNonlinearForm.

Definition at line 48 of file nonlinearform.cpp.

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

Definition at line 102 of file nonlinearform.cpp.

void mfem::NonlinearForm::Mult ( const Vector &  x, Vector &  y  ) const

virtual

Operator application: y=A(x).

Implements mfem::Operator.

Reimplemented in mfem::ParNonlinearForm.

Definition at line 72 of file nonlinearform.cpp.

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

virtual

Reimplemented in mfem::ParNonlinearForm.

Definition at line 17 of file nonlinearform.cpp.

void mfem::NonlinearForm::SetEssentialVDofs ( const Array< int > &  ess_vdofs_list )

inline

Definition at line 47 of file nonlinearform.hpp.

Member Data Documentation

Array<NonlinearFormIntegrator*> mfem::NonlinearForm::dfi

protected

Set of Domain Integrators to be assembled (added).

Definition at line 29 of file nonlinearform.hpp.

Array<int> mfem::NonlinearForm::ess_vdofs

protected

Definition at line 34 of file nonlinearform.hpp.

FiniteElementSpace* mfem::NonlinearForm::fes

protected

FE space on which the form lives.

Definition at line 26 of file nonlinearform.hpp.

SparseMatrix* mfem::NonlinearForm::Grad

mutableprotected

Definition at line 31 of file nonlinearform.hpp.

---

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

• nonlinearform.hpp
• nonlinearform.cpp