Marmot::NumericalAlgorithms::NewtonConvergenceChecker Class Reference

#include <NewtonConvergenceChecker.h>

Public Member Functions
	NewtonConvergenceChecker (const Eigen::VectorXd &residualScaleVector, int nMaxNewtonCycles, int nMaxNewtonCyclesAlt, double newtonTol, double newtonRTol, double newtonTolAlt, double newtonRTolAlt)
double	relativeNorm (const Eigen::VectorXd &increment, const Eigen::VectorXd &reference)
double	residualNorm (const Eigen::VectorXd &Residual)
bool	iterationFinished (const Eigen::VectorXd &residual, const Eigen::VectorXd &X, const Eigen::VectorXd &dX, int numberOfIterations)
bool	isConverged (const Eigen::VectorXd &residual, const Eigen::VectorXd &X, const Eigen::VectorXd &dX, int numberOfIterations)

Private Attributes
const Eigen::VectorXd	residualScaleVector
const int	nMaxNewtonCycles
const int	nMaxNewtonCyclesAlt
const double	newtonTol
const double	newtonRTol
const double	newtonTolAlt
const double	newtonRTolAlt

Constructor & Destructor Documentation

NewtonConvergenceChecker()

Marmot::NumericalAlgorithms::NewtonConvergenceChecker::NewtonConvergenceChecker	(	const Eigen::VectorXd &	residualScaleVector,
		int	nMaxNewtonCycles,
		int	nMaxNewtonCyclesAlt,
		double	newtonTol,
		double	newtonRTol,
		double	newtonTolAlt,
		double	newtonRTolAlt
	)

Member Function Documentation

relativeNorm()

double Marmot::NumericalAlgorithms::NewtonConvergenceChecker::relativeNorm	(	const Eigen::VectorXd &	increment,
		const Eigen::VectorXd &	reference
	)

residualNorm()

double Marmot::NumericalAlgorithms::NewtonConvergenceChecker::residualNorm

(

const Eigen::VectorXd &

Residual

)

iterationFinished()

bool Marmot::NumericalAlgorithms::NewtonConvergenceChecker::iterationFinished	(	const Eigen::VectorXd &	residual,
		const Eigen::VectorXd &	X,
		const Eigen::VectorXd &	dX,
		int	numberOfIterations
	)

isConverged()

bool Marmot::NumericalAlgorithms::NewtonConvergenceChecker::isConverged	(	const Eigen::VectorXd &	residual,
		const Eigen::VectorXd &	X,
		const Eigen::VectorXd &	dX,
		int	numberOfIterations
	)

Member Data Documentation

residualScaleVector

const Eigen::VectorXd Marmot::NumericalAlgorithms::NewtonConvergenceChecker::residualScaleVector

private

nMaxNewtonCycles

const int Marmot::NumericalAlgorithms::NewtonConvergenceChecker::nMaxNewtonCycles

private

nMaxNewtonCyclesAlt

const int Marmot::NumericalAlgorithms::NewtonConvergenceChecker::nMaxNewtonCyclesAlt

private

newtonTol

const double Marmot::NumericalAlgorithms::NewtonConvergenceChecker::newtonTol

private

newtonRTol

const double Marmot::NumericalAlgorithms::NewtonConvergenceChecker::newtonRTol

private

newtonTolAlt

const double Marmot::NumericalAlgorithms::NewtonConvergenceChecker::newtonTolAlt

private

newtonRTolAlt

const double Marmot::NumericalAlgorithms::NewtonConvergenceChecker::newtonRTolAlt

private

---

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

• modules/core/MarmotMathCore/include/Marmot/NewtonConvergenceChecker.h
• modules/core/MarmotMathCore/src/NewtonConvergenceChecker.cpp