NEML2 2.1.0
Loading...
Searching...
No Matches
[Solvers]

Table of Contents

Note
Clicking on the option with a triangle bullet ▸ next to it will expand/collapse its detailed information.
Type name written in PascalCase typically refer to a NEML2 object type, oftentimes a primitive tensor type.
The 🔗 symbol means that the tensor value can be cross-reference another object. See Model parameters (revisited) for details.
You can always use Ctrl+F or Cmd+F to search the entire page.

Available objects and their input file syntax

Refer to System Documentation for detailed explanation about this system.

DenseLU

Dense LU linear solver. This solver assembles the (possibly) sparse matrix into a dense one and uses a standard LU decomposition to solve the system of equations.

verbose Verbosity of the solver

  • Type: bool
  • Default: false

Detailed documentation link

Newton

The standard Newton-Raphson solver which always takes the 'full' Newton step.

abs_tol Absolute tolerance in the convergence criteria

  • Type: number
  • Default: 1e-10
linear_solver The linear solver to use within the nonlinear solver

  • Type: string
max_its Maximum number of iterations allowed before issuing an error/exception

  • Type: non-negative number
  • Default: 100
rel_tol Relative tolerance in the convergence criteria

  • Type: number
  • Default: 1e-08
verbose Verbosity of the solver

  • Type: bool
  • Default: false

Detailed documentation link

NewtonWithLineSearch

The Newton-Raphson solver with line search.

abs_tol Absolute tolerance in the convergence criteria

  • Type: number
  • Default: 1e-10
check_negative_criterion Whether to check if the threshold used in the convergence criterion for line search becomes negative. If true, and a negative value is detected, a warning message is printed to cerr.

  • Type: bool
  • Default: false
linear_solver The linear solver to use within the nonlinear solver

  • Type: string
linesearch_cutback Linesearch cut-back factor when the current scale factor cannot sufficiently reduce the residual.

  • Type: number
  • Default: 2
linesearch_stopping_criteria The lineseach tolerance slightly relaxing the definition of residual decrease

  • Type: number
  • Default: 0.001
linesearch_type The type of linesearch used.Default: BACKTRACKING. Options are STRONG_WOLFE, BACKTRACKING

  • Type: EnumSelection
  • Default: BACKTRACKING
max_its Maximum number of iterations allowed before issuing an error/exception

  • Type: non-negative number
  • Default: 100
max_linesearch_iterations Maximum allowable linesearch iterations. No error is produced upon reaching the maximum number of iterations, and the scale factor in the last iteration is used to scale the step.

  • Type: non-negative number
  • Default: 10
rel_tol Relative tolerance in the convergence criteria

  • Type: number
  • Default: 1e-08
verbose Verbosity of the solver

  • Type: bool
  • Default: false

Detailed documentation link