MathUtils::Config Struct Reference

Configuration for iterative solvers. Provides common settings for convergence criteria and iteration limits. More...

#include <MathUtils_Config.hxx>

Inheritance diagram for MathUtils::Config:

Public Member Functions
	Config ()=default
	Default constructor with standard tolerances.
	Config (double theTolerance, int theMaxIter=100)
	Constructor with custom tolerance (sets all tolerances to same value).

Data Fields
int	MaxIterations = 100
	Maximum number of iterations allowed.
double	Tolerance = 1.0e-10
	General convergence tolerance.
double	XTolerance = 1.0e-10
	Tolerance for solution change |x_{n+1} - x_n|.
double	FTolerance = 1.0e-10
	Tolerance for function value |f(x)|.
double	StepMin = std::numeric_limits<double>::epsilon()
	Minimum step size before declaring convergence or failure.

Detailed Description

Configuration for iterative solvers. Provides common settings for convergence criteria and iteration limits.

Constructor & Destructor Documentation

Config() [1/2]

MathUtils::Config::Config ( )

default

Default constructor with standard tolerances.

Config() [2/2]

MathUtils::Config::Config ( double theTolerance, int theMaxIter = 100 )

inlineexplicit

Constructor with custom tolerance (sets all tolerances to same value).

Parameters

theTolerance	convergence tolerance
theMaxIter	maximum iterations

Field Documentation

FTolerance

double MathUtils::Config::FTolerance = 1.0e-10

Tolerance for function value |f(x)|.

MaxIterations

int MathUtils::Config::MaxIterations = 100

Maximum number of iterations allowed.

StepMin

double MathUtils::Config::StepMin = std::numeric_limits<double>::epsilon()

Minimum step size before declaring convergence or failure.

Tolerance

double MathUtils::Config::Tolerance = 1.0e-10

General convergence tolerance.

XTolerance

double MathUtils::Config::XTolerance = 1.0e-10

Tolerance for solution change |x_{n+1} - x_n|.

---

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

• MathUtils_Config.hxx