Stokhos Development
Loading...
Searching...
No Matches
StatusTestGenResNorm Class Reference

An implementation of StatusTestResNorm using a family of residual norms. More...

#include <Belos_StatusTest_GenResNorm_MP_Vector.hpp>

Detailed Description

An implementation of StatusTestResNorm using a family of residual norms.

StatusTestGenResNorm is an implementation of StatusTestResNorm that allows a user to construct one of a family of residual tests for use as a status/convergence test for Belos. The form of the test is

\‍[ \frac{\|r_i\|}{\sigma_i} \le \tau
\‍]

where

  • $r_i$ is the i-th residual std::vector, implicitly or explicitly computed (determined by enum ResType),
  • $\|r_i\|$ is the i-th residual norm determined by the enum NormType (1-norm, 2-norm or inf-norm),
  • $\sigma_i$ is the i-th scale factor that can be passed in as a precomputed number of the templated type, or can be selected from by the enum ScaleType (norm of RHS, norm of initial residual).
  • $\tau$ is the tolerance that is passed in as a number of the templated type to the constructor. The value of $\tau$ can be reset using the setTolerance() method.

This implementation is the same as the default, but is specialized for the Sacado::MP::Vector scalar type to keep track of when each component of the ensemble converges.


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