MFEM  v4.5.2
Finite element discretization library
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)
 Set the memory type for temporary memory allocations. More...
 
virtual double ComputeScalingFactor (const Vector &x, const Vector &b) const
 
virtual void ProcessNewState (const Vector &x) const
 
Methods for adaptive surface fitting weight. (Experimental)
void EnableAdaptiveSurfaceFitting ()
 
void SetTerminationWithMaxSurfaceFittingError (double max_error)
 
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_)
 
virtual void SetOperator (const Operator &op)
 Also calls SetOperator for the preconditioner if there is one. More...
 
void SetHistorySize (int dim)
 
virtual ~LBFGSSolver ()
 
- Public Member Functions inherited from mfem::NewtonSolver
 NewtonSolver ()
 
 NewtonSolver (MPI_Comm comm_)
 
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 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...
 
void SetRelTol (double rtol)
 
void SetAbsTol (double atol)
 
void SetMaxIter (int max_it)
 
virtual void SetPrintLevel (int print_lvl)
 Legacy method to set the level of verbosity of the solver output. More...
 
virtual void SetPrintLevel (PrintLevel)
 Set the level of verbosity of the solver output. More...
 
int GetNumIterations () const
 Returns the number of iterations taken during the last call to Mult() More...
 
bool GetConverged () const
 Returns true if the last call to Mult() converged successfully. More...
 
double GetInitialNorm () const
 Returns the initial residual norm from the last call to Mult(). More...
 
double GetFinalNorm () const
 Returns the final residual norm after termination of the solver during the last call to Mult(). More...
 
double GetFinalRelNorm () const
 Returns the final residual norm after termination of the solver during the last call to Mult(), divided by the initial residual norm. Returns -1 if one of these norms is left undefined by the solver. 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 void AddMult (const Vector &x, Vector &y, const double a=1.0) const
 Operator application: y+=A(x) (default) or y+=a*A(x). More...
 
virtual void AddMultTranspose (const Vector &x, Vector &y, const double a=1.0) const
 Operator transpose application: y+=A^t(x) (default) or y+=a*A^t(x). More...
 
virtual void ArrayMult (const Array< const Vector *> &X, Array< Vector *> &Y) const
 Operator application on a matrix: Y=A(X). More...
 
virtual void ArrayMultTranspose (const Array< const Vector *> &X, Array< Vector *> &Y) const
 Action of the transpose operator on a matrix: Y=A^t(X). More...
 
virtual void ArrayAddMult (const Array< const Vector *> &X, Array< Vector *> &Y, const double a=1.0) const
 Operator application on a matrix: Y+=A(X) (default) or Y+=a*A(X). More...
 
virtual void ArrayAddMultTranspose (const Array< const Vector *> &X, Array< Vector *> &Y, const double a=1.0) const
 Operator transpose application on a matrix: Y+=A^t(X) (default) or Y+=a*A^t(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 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, int m=0) const
 Prints operator with input size n and output size m in Matlab format. More...
 
virtual void PrintMatlab (std::ostream &out) const
 Prints operator 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, int x_ordering=Ordering::byNODES) 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
 
Methods for adaptive surface fitting weight.
virtual void GetSurfaceFittingError (double &err_avg, double &err_max) const
 
void UpdateSurfaceFittingWeight (double factor) const
 Update surface fitting weight as surf_fit_weight *= factor. More...
 
void GetSurfaceFittingWeight (Array< double > &weights) const
 Get the surface fitting weight for all the TMOP integrators. More...
 
- Protected Member Functions inherited from mfem::LBFGSSolver
void DeleteStorageVectors ()
 
void InitializeStorageVectors ()
 
- 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
 
PrintLevel FromLegacyPrintLevel (int)
 Convert a legacy print level integer to a PrintLevel object. More...
 
- 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
 
bool adaptive_surf_fit = false
 
double surf_fit_err_avg_prvs = 10000.0
 
bool update_surf_fit_coeff = false
 
double surf_fit_max_threshold = -1.0
 
double * min_det_ptr = nullptr
 
bool compute_metric_quantile_flag = true
 
const IntegrationRuleir
 
IntegrationRulesIntegRules
 
int integ_order
 
MemoryType temp_mt = MemoryType::DEFAULT
 
- Protected Attributes inherited from mfem::LBFGSSolver
int m = 10
 
Array< Vector * > skArray
 
Array< Vector * > ykArray
 
- 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
 Limit for the number of iterations the solver is allowed to do. More...
 
double rel_tol
 Relative tolerance. More...
 
double abs_tol
 Absolute tolerance. More...
 
int final_iter = -1
 
bool converged = false
 
double initial_norm = -1.0
 
double final_norm = -1.0
 
int print_level = -1
 (DEPRECATED) Legacy print level definition, which is left for compatibility with custom iterative solvers. More...
 
PrintLevel print_options
 Output behavior for the iterative solver. More...
 
- 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,
  Complex_DenseMat, MFEM_Block_Matrix, MFEM_Block_Operator
}
 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...
 
- Static Protected Member Functions inherited from mfem::IterativeSolver
static int GuessLegacyPrintLevel (PrintLevel)
 Use some heuristics to guess a legacy print level corresponding to the given PrintLevel. More...
 

Detailed Description

Definition at line 130 of file tmop_tools.hpp.

Constructor & Destructor Documentation

◆ TMOPNewtonSolver() [1/2]

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

Definition at line 191 of file tmop_tools.hpp.

◆ TMOPNewtonSolver() [2/2]

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

Definition at line 195 of file tmop_tools.hpp.

Member Function Documentation

◆ ComputeMinDet()

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

Definition at line 846 of file tmop_tools.cpp.

◆ ComputeScalingFactor()

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

Compute scaling factor for the node movement direction using line-search. We impose constraints on TMOP energy, gradient, minimum Jacobian of the mesh, and (optionally) on the surface fitting error.

Reimplemented from mfem::NewtonSolver.

Definition at line 379 of file tmop_tools.cpp.

◆ EnableAdaptiveSurfaceFitting()

void mfem::TMOPNewtonSolver::EnableAdaptiveSurfaceFitting ( )
inline

Enable adaptive surface fitting weight. The weight is modified after each TMOPNewtonSolver iteration.

Definition at line 225 of file tmop_tools.hpp.

◆ GetIntegrationRule()

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

Definition at line 157 of file tmop_tools.hpp.

◆ GetSurfaceFittingError()

void mfem::TMOPNewtonSolver::GetSurfaceFittingError ( double &  err_avg,
double &  err_max 
) const
protectedvirtual

Get the average and maximum surface fitting error at the marked nodes. If there is more than 1 TMOP integrator, we get the maximum of the average and maximum error over all integrators.

Definition at line 638 of file tmop_tools.cpp.

◆ GetSurfaceFittingWeight()

void mfem::TMOPNewtonSolver::GetSurfaceFittingWeight ( Array< double > &  weights) const
protected

Get the surface fitting weight for all the TMOP integrators.

Definition at line 608 of file tmop_tools.cpp.

◆ MinDetJpr_2D()

double mfem::TMOPNewtonSolver::MinDetJpr_2D ( const FiniteElementSpace fes,
const Vector X 
) const
protected

Definition at line 75 of file tmop_pa_jp2.cpp.

◆ MinDetJpr_3D()

double mfem::TMOPNewtonSolver::MinDetJpr_3D ( const FiniteElementSpace fes,
const Vector X 
) const
protected

Definition at line 77 of file tmop_pa_jp3.cpp.

◆ Mult()

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 234 of file tmop_tools.hpp.

◆ ProcessNewState()

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

Update (i) discrete functions at new nodal positions, and (ii) surface fitting weight.

Reimplemented from mfem::NewtonSolver.

Definition at line 678 of file tmop_tools.cpp.

◆ SetIntegrationRules()

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 202 of file tmop_tools.hpp.

◆ SetMinDetPtr()

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

Definition at line 208 of file tmop_tools.hpp.

◆ SetPreconditioner()

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

This should be called before SetOperator.

Reimplemented from mfem::LBFGSSolver.

Definition at line 259 of file tmop_tools.hpp.

◆ SetSolver()

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 247 of file tmop_tools.hpp.

◆ SetTempMemoryType()

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

Set the memory type for temporary memory allocations.

Definition at line 211 of file tmop_tools.hpp.

◆ SetTerminationWithMaxSurfaceFittingError()

void mfem::TMOPNewtonSolver::SetTerminationWithMaxSurfaceFittingError ( double  max_error)
inline

Set the termination criterion for mesh optimization based on the maximum surface fitting error.

Definition at line 229 of file tmop_tools.hpp.

◆ UpdateDiscreteTC()

void mfem::TMOPNewtonSolver::UpdateDiscreteTC ( const TMOP_Integrator ti,
const Vector x_new,
int  x_ordering = Ordering::byNODES 
) const
protected

Definition at line 828 of file tmop_tools.cpp.

◆ UpdateSurfaceFittingWeight()

void mfem::TMOPNewtonSolver::UpdateSurfaceFittingWeight ( double  factor) const
protected

Update surface fitting weight as surf_fit_weight *= factor.

Definition at line 583 of file tmop_tools.cpp.

Member Data Documentation

◆ adaptive_surf_fit

bool mfem::TMOPNewtonSolver::adaptive_surf_fit = false
protected

Definition at line 138 of file tmop_tools.hpp.

◆ compute_metric_quantile_flag

bool mfem::TMOPNewtonSolver::compute_metric_quantile_flag = true
mutableprotected

Definition at line 147 of file tmop_tools.hpp.

◆ integ_order

int mfem::TMOPNewtonSolver::integ_order
protected

Definition at line 153 of file tmop_tools.hpp.

◆ IntegRules

IntegrationRules* mfem::TMOPNewtonSolver::IntegRules
protected

Definition at line 152 of file tmop_tools.hpp.

◆ ir

const IntegrationRule& mfem::TMOPNewtonSolver::ir
protected

Definition at line 150 of file tmop_tools.hpp.

◆ min_det_ptr

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

Definition at line 144 of file tmop_tools.hpp.

◆ parallel

bool mfem::TMOPNewtonSolver::parallel
protected

Definition at line 135 of file tmop_tools.hpp.

◆ solver_type

int mfem::TMOPNewtonSolver::solver_type
protected

Definition at line 134 of file tmop_tools.hpp.

◆ surf_fit_err_avg_prvs

double mfem::TMOPNewtonSolver::surf_fit_err_avg_prvs = 10000.0
mutableprotected

Definition at line 139 of file tmop_tools.hpp.

◆ surf_fit_max_threshold

double mfem::TMOPNewtonSolver::surf_fit_max_threshold = -1.0
protected

Definition at line 141 of file tmop_tools.hpp.

◆ temp_mt

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

Definition at line 155 of file tmop_tools.hpp.

◆ update_surf_fit_coeff

bool mfem::TMOPNewtonSolver::update_surf_fit_coeff = false
mutableprotected

Definition at line 140 of file tmop_tools.hpp.


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