Diffpack Documentation

---

              Search  

---

NonLinEqSummary Class Reference

summary of nonlinear solver performace in many runs. More...

#include <NonLinEqSummary.h>

List of all members.

Public Methods
	NonLinEqSummary ()
	~NonLinEqSummary ()
void	init (const char *table_prefix="NonLinEq")
void	update (NonLinEqSolver &stat)
void	writeHeadings (StringList &headings, VerbosityLevel verbosity=COMPACT)
void	writeResults (StringList &results)
void	writeExtendedResults (MultipleReporter &report, VerbosityLevel verbosity=COMPACT)
	ASSIGNMENT_OPERATOR (NonLinEqSummary)
Public Attributes
Extremes	niterations
String	solver
VerbosityLevel	vb

---

Detailed Description

summary of nonlinear solver performace in many runs.

NAME: NonLinEqSummary - summary of nonlinear solver performace in many runs

DESCRIPTION:

The class tracks statistics about the number of iterations, divergence, etc., for a nonlinear solver (e.g., Newton-Raphson) during many runs (f.ex. in time dependent problems). Together with the ".casename.nonlinconv" file this gives the user compact information about the performance of methods for systems of nonlinear algebraic equations.

To use the class, include a "NonLinEqSummary" data member "nstat" in your problem class. Call "nstat.init()" prior to each execution Put the statement together with other initialization statements in, e.g., a "scan" function or particularly dedicated initialization routine. After each "solve" call to the nonlinear solver, say "nlsolver", call "nstat.update(nlsolver)" to add this information to the statistics in "NonLinEqSummary". You can extract the results in two ways: (1) write the results automatically in Diffpack report objects (using "MultipleReporter") or (2) look up the results manually in the data members of "nstat".

---

Constructor & Destructor Documentation

NonLinEqSummary::NonLinEqSummary ( )

NonLinEqSummary::~NonLinEqSummary ( ) [inline]

---

Member Function Documentation

NonLinEqSummary::ASSIGNMENT_OPERATOR ( NonLinEqSummary )

void NonLinEqSummary::init ( const char * table_prefix = "NonLinEq" )

void NonLinEqSummary::update ( NonLinEqSolver & stat )

void NonLinEqSummary::writeExtendedResults ( MultipleReporter & report, VerbosityLevel verbosity = COMPACT )

void NonLinEqSummary::writeHeadings ( StringList & headings, VerbosityLevel verbosity = COMPACT )

void NonLinEqSummary::writeResults ( StringList & results )

---

Member Data Documentation

Extremes NonLinEqSummary::niterations

String NonLinEqSummary::solver

VerbosityLevel NonLinEqSummary::vb

---

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

• NonLinEqSummary.h

---