 |
deal.II version GIT relicensing-2287-g6548a49e0a 2024-12-20 18:30:00+00:00
|
Loading...
Searching...
No Matches
|
deal.II version GIT relicensing-2287-g6548a49e0a 2024-12-20 18:30:00+00:00
|
#include <deal.II/trilinos/nox.h>
Classes | |
| struct | AdditionalData |
Public Member Functions | |
| NOXSolver (AdditionalData &additional_data, const Teuchos::RCP< Teuchos::ParameterList > ¶meters=Teuchos::rcp(new Teuchos::ParameterList)) | |
| ~NOXSolver () | |
| void | clear () |
| unsigned int | solve (VectorType &solution) |
Public Attributes | |
| std::function< void(const VectorType &u, VectorType &F)> | residual |
| std::function< void(const VectorType ¤t_u)> | setup_jacobian |
| std::function< void(const VectorType ¤t_u)> | setup_preconditioner |
| std::function< void(const VectorType &x, VectorType &y)> | apply_jacobian |
| std::function< void(const VectorType &y, VectorType &x, const double tolerance)> | solve_with_jacobian |
| std::function< int(const VectorType &y, VectorType &x, const double tolerance)> | solve_with_jacobian_and_track_n_linear_iterations |
| std::function< SolverControl::State(const unsigned int i, const double norm_f, const VectorType ¤t_u, const VectorType &f)> | check_iteration_status |
| std::function< bool()> | update_preconditioner_predicate |
Private Attributes | |
| AdditionalData | additional_data |
| const Teuchos::RCP< Teuchos::ParameterList > | parameters |
| unsigned int | n_residual_evaluations |
| unsigned int | n_jacobian_applications |
| unsigned int | n_nonlinear_iterations |
| unsigned int | n_last_linear_iterations |
| std::exception_ptr | pending_exception |
Wrapper around the nonlinear solver from the NOX package (https://docs.trilinos.org/dev/packages/nox/doc/html/index.html), targeting deal.II data structures.
The following code shows the steps how to use this class:
The functions used in NOX are nearly identical to the functions in SUNDIALS::KINSOL with a few exceptions (for example, SUNDIALS::KINSOL requires a reinit() function where NOX does not). So check the SUNDIALS::KINSOL documentation for more precise details on how these functions are implemented.
| TrilinosWrappers::NOXSolver< VectorType >::NOXSolver | ( | AdditionalData & | additional_data, |
| const Teuchos::RCP< Teuchos::ParameterList > & | parameters = Teuchos::rcp(new Teuchos::ParameterList) |
||
| ) |
Constructor, with class parameters set by the AdditionalData object.
| additional_data | NOX configuration data. |
| parameters | More specific NOX solver configuration. |
If parameters is not filled, a Newton solver with a full step is used. An overview of possible parameters is given at https://docs.trilinos.org/dev/packages/nox/doc/html/parameters.html.
| TrilinosWrappers::NOXSolver< VectorType >::~NOXSolver | ( | ) |
Destructor.
| void TrilinosWrappers::NOXSolver< VectorType >::clear | ( | ) |
Clear the internal state.
| unsigned int TrilinosWrappers::NOXSolver< VectorType >::solve | ( | VectorType & | solution | ) |
Solve the nonlinear problem and return the number of nonlinear iterations executed.
| std::function<void(const VectorType &u, VectorType &F)> TrilinosWrappers::NOXSolver< VectorType >::residual |
A function object that users should supply and that is intended to compute the residual \(F(u)\).
| std::function<void(const VectorType ¤t_u)> TrilinosWrappers::NOXSolver< VectorType >::setup_jacobian |
A user function that sets up the Jacobian, based on the current solution current_u.
| std::function<void(const VectorType ¤t_u)> TrilinosWrappers::NOXSolver< VectorType >::setup_preconditioner |
A user function that sets up the preconditioner for inverting the Jacobian, based on the current solution current_u.
| std::function<void(const VectorType &x, VectorType &y)> TrilinosWrappers::NOXSolver< VectorType >::apply_jacobian |
A user function that applies the Jacobian \(\nabla_u F(u)\) to x and writes the result in y. The Jacobian to be used (i.e., more precisely: the linearization point \(u\) above) is the one computed when the setup_jacobian function was last called.
NOX::LineSearch::Polynomial) is chosen, whereas for the full step case (NOX::LineSearch::FullStep) it won't be called.| std::function< void(const VectorType &y, VectorType &x, const double tolerance)> TrilinosWrappers::NOXSolver< VectorType >::solve_with_jacobian |
A user function that applies the inverse of the Jacobian \([\nabla_u F(u)]^{-1}\) to y and writes the result in x. The parameter tolerance specifies the error reduction if an iterative solver is used in applying the inverse matrix. The Jacobian to be used (i.e., more precisely: the linearization point \(u\) above) is the one computed when the setup_jacobian function was last called.
true (which is, in fact, its default value). If this parameters is set to true, then exceptions of type RecoverableUserCallbackError are eaten for this callback and NOX can safely proceed with a recovery step. Exceptions of other types are still treated as "irrecoverable". | std::function< int(const VectorType &y, VectorType &x, const double tolerance)> TrilinosWrappers::NOXSolver< VectorType >::solve_with_jacobian_and_track_n_linear_iterations |
A user function that applies the inverse of the Jacobian \([\nabla_u F(u)]^{-1}\) to y, writes the result in x and returns the number of linear iterations the linear solver needed. The parameter tolerance species the error reduction if an iterative solver is used. The Jacobian to be used (i.e., more precisely: the linearization point \(u\) above) is the one computed when the setup_jacobian function was last called.
solve_with_jacobian is not provided. Its return value is compared again AdditionalFlags::threshold_n_linear_iterations; if it is larger, the preconditioner will be built before the next linear system is solved. The use of this approach is predicated on the idea that one can keep using a preconditioner built earlier as long as it is a good preconditioner for the matrix currently in use – where "good" is defined as leading to a number of iterations to solve linear systems less than the threshold given by the current variable.true (which is, in fact, its default value). If this parameters is set to true, then exceptions of type RecoverableUserCallbackError are eaten for this callback and NOX can safely proceed with a recovery step. Exceptions of other types are still treated as "irrecoverable". | std::function<SolverControl::State(const unsigned int i, const double norm_f, const VectorType ¤t_u, const VectorType &f)> TrilinosWrappers::NOXSolver< VectorType >::check_iteration_status |
A user function that allows to check convergence in addition to ones checking the l2-norm and the number of iterations (see AdditionalData). It is run after each nonlinear iteration.
The input are the current iteration number i, the l2-norm norm_f of the residual vector, the current solution current_u, and the current residual vector f.
| std::function<bool()> TrilinosWrappers::NOXSolver< VectorType >::update_preconditioner_predicate |
A user function that, in addition to AdditionalData::threshold_nonlinear_iterations, allows to force to update the preconditioner. A reason for wanting to update the preconditioner is when the expected number of linear iterations is exceeded.
false.
|
private |
|
private |
Additional data with advanced settings. An overview of possible parameters is given at https://docs.trilinos.org/dev/packages/nox/doc/html/parameters.html.
|
private |
|
private |
|
private |
|
private |
|
mutableprivate |
1.9.8