AGGREGATED report (whole block, all substeps of one advance) of the implicit-source Newton. More...

#include <implicit_stepper.hpp>

Collaboration diagram for pops::NewtonReport:

Public Member Functions
void	reset ()

Public Attributes
bool	enabled = false
	a report was computed (at least one instrumented substep)

bool	converged = true
	no failed cell over the advance

Real	max_residual = Real(0)
	max over cells/substeps of \|\|F\|\|_inf at exit

Real	max_iters_used = Real(0)
	max over cells/substeps of iterations consumed

double	n_failed
	number of (cells x substeps) failed (non-finite / pivot / non-convergence)

double	failed_i = -1

double	failed_j = -1

double	failed_comp = -1
	one offending cell (-1 if none)

Detailed Description

AGGREGATED report (whole block, all substeps of one advance) of the implicit-source Newton.

Filled by backward_euler_source when a report is requested (OPT-IN diagnostics); max/sum reductions over the cells + MPI all_reduce. reset() at the start of the advance by the caller. OFFENDING CELL: (failed_i, failed_j, failed_comp) designate ONE failed cell – the one with MAXIMAL encoded index (j then i), enough to go inspect the state; -1 if none. failed_comp is the conserved component carrying the worst residual of THAT cell.

Member Function Documentation

◆ reset()

void pops::NewtonReport::reset ( )

inline

Here is the caller graph for this function:

Member Data Documentation

◆ converged

bool pops::NewtonReport::converged = true

no failed cell over the advance

◆ enabled

bool pops::NewtonReport::enabled = false

a report was computed (at least one instrumented substep)

◆ failed_comp

double pops::NewtonReport::failed_comp = -1

one offending cell (-1 if none)

◆ failed_i

double pops::NewtonReport::failed_i = -1

◆ failed_j

double pops::NewtonReport::failed_j = -1

◆ max_iters_used

Real pops::NewtonReport::max_iters_used = Real(0)

max over cells/substeps of iterations consumed

◆ max_residual

Real pops::NewtonReport::max_residual = Real(0)

max over cells/substeps of ||F||_inf at exit

◆ n_failed

double pops::NewtonReport::n_failed

Initial value:

=

0

number of (cells x substeps) failed (non-finite / pivot / non-convergence)

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

include/pops/numerics/time/integrators/implicit_stepper.hpp

NewtonReport Struct Reference¶

Public Member Functions

Public Attributes