MFEM  v4.1.0
Finite element discretization library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | List of all members
mfem::TMOPDescentNewtonSolver Class Reference

Allows negative Jacobians. Used for untangling. More...

#include <tmop_tools.hpp>

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

Public Member Functions

 TMOPDescentNewtonSolver (MPI_Comm comm, const IntegrationRule &irule)
 
 TMOPDescentNewtonSolver (const IntegrationRule &irule)
 
virtual double ComputeScalingFactor (const Vector &x, const Vector &b) const
 This method can be overloaded in derived classes to implement line search algorithms. More...
 
virtual void ProcessNewState (const Vector &x) const
 This method can be overloaded in derived classes to perform computations that need knowledge of the newest Newton state. More...
 
- Public Member Functions inherited from mfem::NewtonSolver
 NewtonSolver ()
 
 NewtonSolver (MPI_Comm _comm)
 
virtual void SetOperator (const Operator &op)
 Also calls SetOperator for the preconditioner if there is one. More...
 
virtual void SetSolver (Solver &solver)
 Set the linear solver for inverting the Jacobian. More...
 
virtual void Mult (const Vector &b, Vector &x) const
 Solve the nonlinear system with right-hand side b. More...
 
- Public Member Functions inherited from mfem::IterativeSolver
 IterativeSolver ()
 
 IterativeSolver (MPI_Comm _comm)
 
void SetRelTol (double rtol)
 
void SetAbsTol (double atol)
 
void SetMaxIter (int max_it)
 
void SetPrintLevel (int print_lvl)
 
int GetNumIterations () const
 
int GetConverged () const
 
double GetFinalNorm () const
 
virtual void SetPreconditioner (Solver &pr)
 This should be called before SetOperator. More...
 
- Public Member Functions inherited from mfem::Solver
 Solver (int s=0, bool iter_mode=false)
 Initialize a square Solver with size s. More...
 
 Solver (int h, int w, bool iter_mode=false)
 Initialize a Solver with height h and width w. 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 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 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 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=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...
 

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, Complex_Operator, MFEM_ComplexSparseMat, Complex_Hypre_ParCSR
}
 Enumeration defining IDs for some classes derived from Operator. More...
 
- Public Attributes inherited from mfem::Solver
bool iterative_mode
 If true, use the second argument of Mult() as an initial guess. More...
 
- Protected Member Functions inherited from mfem::IterativeSolver
double Dot (const Vector &x, const Vector &y) const
 
double Norm (const Vector &x) const
 
- 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, taking in input/output Prolongation matrices. More...
 
- Protected Attributes inherited from mfem::NewtonSolver
Vector r
 
Vector c
 
- Protected Attributes inherited from mfem::IterativeSolver
const Operatoroper
 
Solverprec
 
int max_iter
 
int print_level
 
double rel_tol
 
double abs_tol
 
int final_iter
 
int converged
 
double final_norm
 
- 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...
 

Detailed Description

Allows negative Jacobians. Used for untangling.

Definition at line 106 of file tmop_tools.hpp.

Constructor & Destructor Documentation

mfem::TMOPDescentNewtonSolver::TMOPDescentNewtonSolver ( MPI_Comm  comm,
const IntegrationRule irule 
)
inline

Definition at line 118 of file tmop_tools.hpp.

mfem::TMOPDescentNewtonSolver::TMOPDescentNewtonSolver ( const IntegrationRule irule)
inline

Definition at line 121 of file tmop_tools.hpp.

Member Function Documentation

double mfem::TMOPDescentNewtonSolver::ComputeScalingFactor ( const Vector x,
const Vector b 
) const
virtual

This method can be overloaded in derived classes to implement line search algorithms.

The base class implementation (NewtonSolver) simply returns 1. A return value of 0 indicates a failure, interrupting the Newton iteration.

Reimplemented from mfem::NewtonSolver.

Definition at line 355 of file tmop_tools.cpp.

void mfem::TMOPDescentNewtonSolver::ProcessNewState ( const Vector x) const
virtual

This method can be overloaded in derived classes to perform computations that need knowledge of the newest Newton state.

Reimplemented from mfem::NewtonSolver.

Definition at line 452 of file tmop_tools.cpp.


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