MFEM  v4.3.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::TMOPNewtonSolver Class Reference

#include <tmop_tools.hpp>

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

Public Member Functions

 TMOPNewtonSolver (MPI_Comm comm, const IntegrationRule &irule, int type=0)
 
 TMOPNewtonSolver (const IntegrationRule &irule, int type=0)
 
void SetIntegrationRules (IntegrationRules &irules, int order)
 Prescribe a set of integration rules; relevant for mixed meshes. More...
 
void SetMinDetPtr (double *md_ptr)
 
void SetTempMemoryType (MemoryType mt)
 
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...
 
virtual void Mult (const Vector &b, Vector &x) const
 Solve the nonlinear system with right-hand side b. More...
 
virtual void SetSolver (Solver &solver)
 Set the linear solver for inverting the Jacobian. More...
 
virtual void SetPreconditioner (Solver &pr)
 This should be called before SetOperator. More...
 
- Public Member Functions inherited from mfem::LBFGSSolver
 LBFGSSolver ()
 
 LBFGSSolver (MPI_Comm comm_)
 
void SetHistorySize (int dim)
 
- 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...
 
void SetAdaptiveLinRtol (const int type=2, const double rtol0=0.5, const double rtol_max=0.9, const double alpha=0.5 *(1.0+sqrt(5.0)), const double gamma=1.0)
 Enable adaptive linear solver relative tolerance algorithm. 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
 
void SetMonitor (IterativeSolverMonitor &m)
 Set the iterative solver monitor. More...
 
MPI_Comm GetComm () const
 Return the associated MPI communicator, or MPI_COMM_NULL if no communicator is set. 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 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=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

const IntegrationRuleGetIntegrationRule (const FiniteElement &el) const
 
void UpdateDiscreteTC (const TMOP_Integrator &ti, const Vector &x_new) const
 
double ComputeMinDet (const Vector &x_loc, const FiniteElementSpace &fes) const
 
double MinDetJpr_2D (const FiniteElementSpace *, const Vector &) const
 
double MinDetJpr_3D (const FiniteElementSpace *, const Vector &) const
 
- Protected Member Functions inherited from mfem::NewtonSolver
void AdaptiveLinRtolPreSolve (const Vector &x, const int it, const double fnorm) const
 Method for the adaptive linear solver rtol invoked before the linear solve. More...
 
void AdaptiveLinRtolPostSolve (const Vector &x, const Vector &b, const int it, const double fnorm) const
 Method for the adaptive linear solver rtol invoked after the linear solve. More...
 
- Protected Member Functions inherited from mfem::IterativeSolver
double Dot (const Vector &x, const Vector &y) const
 
double Norm (const Vector &x) const
 
void Monitor (int it, double norm, const Vector &r, const Vector &x, bool final=false) 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, using input/output Prolongation matrices Pi corresponds to "P", Po corresponds to "Rt". More...
 

Protected Attributes

int solver_type
 
bool parallel
 
double * min_det_ptr = nullptr
 
const IntegrationRuleir
 
IntegrationRulesIntegRules
 
int integ_order
 
MemoryType temp_mt = MemoryType::DEFAULT
 
- Protected Attributes inherited from mfem::LBFGSSolver
int m = 10
 
- Protected Attributes inherited from mfem::NewtonSolver
Vector r
 
Vector c
 
Operatorgrad
 
int lin_rtol_type = 0
 
double lin_rtol0
 
double lin_rtol_max
 
double fnorm_last = 0.0
 
double lnorm_last = 0.0
 
double eta_last = 0.0
 
double gamma
 
double alpha
 
- Protected Attributes inherited from mfem::IterativeSolver
const Operatoroper
 
Solverprec
 
IterativeSolverMonitormonitor = nullptr
 
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...
 

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
}
 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...
 

Detailed Description

Definition at line 124 of file tmop_tools.hpp.

Constructor & Destructor Documentation

mfem::TMOPNewtonSolver::TMOPNewtonSolver ( MPI_Comm  comm,
const IntegrationRule irule,
int  type = 0 
)
inline

Definition at line 161 of file tmop_tools.hpp.

mfem::TMOPNewtonSolver::TMOPNewtonSolver ( const IntegrationRule irule,
int  type = 0 
)
inline

Definition at line 165 of file tmop_tools.hpp.

Member Function Documentation

double mfem::TMOPNewtonSolver::ComputeMinDet ( const Vector x_loc,
const FiniteElementSpace fes 
) const
protected

Definition at line 652 of file tmop_tools.cpp.

double mfem::TMOPNewtonSolver::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 362 of file tmop_tools.cpp.

const IntegrationRule& mfem::TMOPNewtonSolver::GetIntegrationRule ( const FiniteElement el) const
inlineprotected

Definition at line 142 of file tmop_tools.hpp.

double mfem::TMOPNewtonSolver::MinDetJpr_2D ( const FiniteElementSpace ,
const Vector  
) const
protected
double mfem::TMOPNewtonSolver::MinDetJpr_3D ( const FiniteElementSpace ,
const Vector  
) const
protected
virtual void mfem::TMOPNewtonSolver::Mult ( const Vector b,
Vector x 
) const
inlinevirtual

Solve the nonlinear system with right-hand side b.

If b.Size() != Height(), then b is assumed to be zero.

Reimplemented from mfem::LBFGSSolver.

Definition at line 187 of file tmop_tools.hpp.

void mfem::TMOPNewtonSolver::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 536 of file tmop_tools.cpp.

void mfem::TMOPNewtonSolver::SetIntegrationRules ( IntegrationRules irules,
int  order 
)
inline

Prescribe a set of integration rules; relevant for mixed meshes.

If called, this function has priority over the IntegrationRule given to the constructor of the class.

Definition at line 172 of file tmop_tools.hpp.

void mfem::TMOPNewtonSolver::SetMinDetPtr ( double *  md_ptr)
inline

Definition at line 178 of file tmop_tools.hpp.

virtual void mfem::TMOPNewtonSolver::SetPreconditioner ( Solver pr)
inlinevirtual

This should be called before SetOperator.

Reimplemented from mfem::LBFGSSolver.

Definition at line 212 of file tmop_tools.hpp.

virtual void mfem::TMOPNewtonSolver::SetSolver ( Solver solver)
inlinevirtual

Set the linear solver for inverting the Jacobian.

This method is equivalent to calling SetPreconditioner().

Reimplemented from mfem::LBFGSSolver.

Definition at line 200 of file tmop_tools.hpp.

void mfem::TMOPNewtonSolver::SetTempMemoryType ( MemoryType  mt)
inline

Definition at line 181 of file tmop_tools.hpp.

void mfem::TMOPNewtonSolver::UpdateDiscreteTC ( const TMOP_Integrator ti,
const Vector x_new 
) const
protected

Definition at line 635 of file tmop_tools.cpp.

Member Data Documentation

int mfem::TMOPNewtonSolver::integ_order
protected

Definition at line 138 of file tmop_tools.hpp.

IntegrationRules* mfem::TMOPNewtonSolver::IntegRules
protected

Definition at line 137 of file tmop_tools.hpp.

const IntegrationRule& mfem::TMOPNewtonSolver::ir
protected

Definition at line 135 of file tmop_tools.hpp.

double* mfem::TMOPNewtonSolver::min_det_ptr = nullptr
protected

Definition at line 132 of file tmop_tools.hpp.

bool mfem::TMOPNewtonSolver::parallel
protected

Definition at line 129 of file tmop_tools.hpp.

int mfem::TMOPNewtonSolver::solver_type
protected

Definition at line 128 of file tmop_tools.hpp.

MemoryType mfem::TMOPNewtonSolver::temp_mt = MemoryType::DEFAULT
protected

Definition at line 140 of file tmop_tools.hpp.


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