Automatic Class Reference

#include <SolverNleInterface.h>

Inheritance diagram for Automatic:

Public Member Functions
	Automatic (ObjectiveNleInterface &of)
double	calculateF (void) override
	calculates F; returns the norm of the residuals More...
double	calculateFJ (void) override
	calculates F and J; returns the norm of the residuals More...
void	verifySolution (void) override
	evaluate equation set at the current set up estimates for the unknowns; useful to test for convergence after sequential solution More...
void	verifyDerivatives (void)
Public Member Functions inherited from SolverNleInterface
	SolverNleInterface (ObjectiveNleInterface &of)
int	size (void) const
virtual void	resize (int n)
	sets the number of unknowns More...
void	print_table (double *xmin, double *xmax, int nsteps)
	print dependence on all unknowns More...
void	printResults (void)
	print vector of results More...
void	printMetrics (void)
	print metric counters More...
virtual void	setTolerances (double, double, double, double)=0
	virtual function, has different meaning for the different solvers derived from SolverNleInterface More...
void	setMaximumIterations (int m)
	sets the maximum number of iterations More...
void	setMaximumStepSize (double stpmx)
void	bmpout (char *file_out_name) const
double	residual (int i)
	returns current value of the ith component of the residual vector More...
virtual double	norm (const double *x)=0
	return root mean square (RMS) norm More...
virtual double	calculateF (void)=0
	calculates F; returns the norm of the residuals More...
virtual double	calculateFJ (void)=0
	calculates F and J; returns the norm of the residuals More...
virtual int	solve (void)=0
virtual std::string	message (int code)=0
	convert return code returned by solve method to human-readable message More...
virtual void	verifySolution (void)=0
	evaluate equation set at the current set up estimates for the unknowns; useful to test for convergence after sequential solution More...
bool	nonConverged (void)
Public Member Functions inherited from Diagnostic
	Diagnostic (void)
void	setVerbosity (int verbosity)
	sets the verbosity level for this instance More...
int	verbosity (void) const

Friends
void	testDerivatives (Automatic *a, double tolerance)
void	testIndependent (Automatic *a, int j, double tolerance)

Additional Inherited Members
Public Attributes inherited from SolverNleInterface
int	NITER
double *	F_
	current values of residuals More...
double *	x_
	current values of unknowns More...
Jacobian	J
Protected Member Functions inherited from SolverNleInterface
	~SolverNleInterface (void)
void	clearCounters (void)
Protected Member Functions inherited from Diagnostic
virtual	~Diagnostic ()=default
Protected Attributes inherited from SolverNleInterface
ObjectiveNleInterface *	ofp_
int	MAXITS
	maximum number of Newton iterations More...
int	verbosityLocal
int	nSyst_
	Number of system evaluations. More...
int	nNewt_
	Number of Newton method applications. More...
int	nQuas_
	Number of Quasi Newton method applications. More...
int	nAuto_
	Number of analytical Jacobian evaluations. More...
int	nNume_
	Number of numerical Jacobian evaluations. More...
double	STPMX
	scaled maximum step length allowed in line searches More...
Protected Attributes inherited from Diagnostic
int	verbosityInstance

Detailed Description

Mixin to compute analytical derivatives

#include <libpf/core/SolverNleInterface.h>

Remarks

Warning

Thread safe:

Extendable:

Platform dependencies:

Constructor & Destructor Documentation

Automatic()

Automatic::Automatic

(

ObjectiveNleInterface &

of

)

Member Function Documentation

calculateF()

double Automatic::calculateF ( void  )

overridevirtual

calculates F; returns the norm of the residuals

Implements SolverNleInterface.

calculateFJ()

double Automatic::calculateFJ ( void  )

overridevirtual

calculates F and J; returns the norm of the residuals

Implements SolverNleInterface.

verifyDerivatives()

void Automatic::verifyDerivatives

(

void

)

verifySolution()

void Automatic::verifySolution ( void  )

overridevirtual

evaluate equation set at the current set up estimates for the unknowns; useful to test for convergence after sequential solution

Implements SolverNleInterface.

Friends And Related Function Documentation

testDerivatives

void testDerivatives ( Automatic *  a, double  tolerance  )

friend

testIndependent

void testIndependent ( Automatic *  a, int  j, double  tolerance  )

friend

---

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

• SolverNleInterface.h