TrilinosWrappers::NOXSolver< VectorType >::AdditionalData Struct Reference

#include <deal.II/trilinos/nox.h>

Detailed Description

template<typename VectorType>
struct TrilinosWrappers::NOXSolver< VectorType >::AdditionalData

Struct that helps to configure NOXSolver. More advanced parameters are passed to the constructor NOXSolver directly via a Teuchos::ParameterList.

Definition at line 95 of file nox.h.

Public Member Functions
	AdditionalData (const unsigned int max_iter=10, const double abs_tol=1.e-20, const double rel_tol=1.e-5, const unsigned int threshold_nonlinear_iterations=1, const unsigned int threshold_n_linear_iterations=0, const bool reuse_solver=false)

Public Attributes
unsigned int	max_iter
double	abs_tol
double	rel_tol
unsigned int	threshold_nonlinear_iterations
unsigned int	threshold_n_linear_iterations
bool	reuse_solver

Constructor & Destructor Documentation

AdditionalData()

template<typename VectorType>

TrilinosWrappers::NOXSolver< VectorType >::AdditionalData::AdditionalData	(	const unsigned int	max_iter = 10,
		const double	abs_tol = 1.e-20,
		const double	rel_tol = 1.e-5,
		const unsigned int	threshold_nonlinear_iterations = 1,
		const unsigned int	threshold_n_linear_iterations = 0,
		const bool	reuse_solver = false )

Constructor.

Member Data Documentation

max_iter

template<typename VectorType>

unsigned int TrilinosWrappers::NOXSolver< VectorType >::AdditionalData::max_iter

Max number of nonlinear iterations.

Definition at line 111 of file nox.h.

abs_tol

template<typename VectorType>

double TrilinosWrappers::NOXSolver< VectorType >::AdditionalData::abs_tol

Absolute l2 tolerance of the residual to be reached.

Note

Solver terminates successfully if either the absolute or the relative tolerance has been reached.

Definition at line 119 of file nox.h.

rel_tol

template<typename VectorType>

double TrilinosWrappers::NOXSolver< VectorType >::AdditionalData::rel_tol

Relative l2 tolerance of the residual to be reached.

Note

Solver terminates successfully if either the absolute or the relative tolerance has been reached.

Definition at line 127 of file nox.h.

threshold_nonlinear_iterations

template<typename VectorType>

unsigned int TrilinosWrappers::NOXSolver< VectorType >::AdditionalData::threshold_nonlinear_iterations

Number of nonlinear iterations after which the preconditioner should be updated.

Definition at line 133 of file nox.h.

threshold_n_linear_iterations

template<typename VectorType>

unsigned int TrilinosWrappers::NOXSolver< VectorType >::AdditionalData::threshold_n_linear_iterations

A number that indicates how many iterations a linear solver should at most perform before the preconditioner should be updated. The use of this variable 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.

This variable is only used if the NOXSolver::solve_with_jacobian_and_track_n_linear_iterations function object has been given a target (i.e., it is not empty).

Definition at line 149 of file nox.h.

reuse_solver

template<typename VectorType>

bool TrilinosWrappers::NOXSolver< VectorType >::AdditionalData::reuse_solver

Reuse nonlinear solver the next time solve() is called. In particular, this parameter allows to reuse the preconditioner from the last solution step, enabling preconditioner lagging over multiple nonlinear solutions.

Definition at line 157 of file nox.h.

---

The documentation for this struct was generated from the following file:

• include/deal.II/trilinos/nox.h