Solver convergence metrics from the last simulation step. More...

Public Member Functions
bool	operator== (SolverStats const &) const =default

Public Attributes
ConvergenceStatus	convergenceStatus = ConvergenceStatus::None
	Aggregate convergence status of the scene in the last call to Scene::Step.
int	maxLineSearchIters = 0
	Maximum number of line-search iterations per Newton solve across all islands and integration stages in the last call to Scene::Step.
int	maxNonLinearIters = 0
	Maximum number of non-linear solver iterations across all islands and integration stages in the last call to Scene::Step.
double	residualNorm = 0.0
	Aggregate residual norm across all islands and integration stages in the last call to Scene::Step.

Detailed Description

Solver convergence metrics from the last simulation step.

Definition at line 513 of file mochi_structs.h.

Member Function Documentation

bool superdex::SolverStats::operator== ( SolverStats const & ) const

default

ConvergenceStatus superdex::SolverStats::convergenceStatus = ConvergenceStatus::None

Aggregate convergence status of the scene in the last call to Scene::Step.

Returns the worst convergence status across all dynamic actors: ConvergenceStatus::Diverged if any actor diverged, ConvergenceStatus::Stopped if any actor's solver was stopped, ConvergenceStatus::Converged if all dynamic actors converged, ConvergenceStatus::None if no dynamic actors exist, Scene::Step has not been called yet or the last call to Scene::Step was with zero time step.

Definition at line 520 of file mochi_structs.h.

int superdex::SolverStats::maxLineSearchIters = 0

Maximum number of line-search iterations per Newton solve across all islands and integration stages in the last call to Scene::Step.

Definition at line 518 of file mochi_structs.h.

int superdex::SolverStats::maxNonLinearIters = 0

Maximum number of non-linear solver iterations across all islands and integration stages in the last call to Scene::Step.

Definition at line 514 of file mochi_structs.h.

double superdex::SolverStats::residualNorm = 0.0

Aggregate residual norm across all islands and integration stages in the last call to Scene::Step.

Computed as the root mean square across integration stages of the L2 norm of per-island residual norms.

Definition at line 516 of file mochi_structs.h.

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