Convergence test with tolerance threshold. More...

#include <ConvergenceTestTol.h>

Inheritance diagram for XC::ConvergenceTestTol:

Public Member Functions
	ConvergenceTestTol (EntCmd *owr, int classTag)
	Constructor.

	ConvergenceTestTol (EntCmd *owr, int classTag, double tol, int maxNumIter, int printFlag, int normType, int sz_norms=1)
	Constructor.

void	setTolerance (double newTol)

double	getTolerance (void) const

int	sendSelf (CommParameters &)

int	recvSelf (const CommParameters &)

std::string	getRatioMessage (const std::string &) const
	Display current ratio and tolerance.

std::string	getDispIncrMessage (void) const
	Display current displacement increment and tolerance.

std::string	getUnbalanceMessage (void) const
	Display current unbalance and tolerance.

std::string	getEnergyProductMessage (void) const
	Display current energy product and tolerance.

Public Member Functions inherited from XC::ConvergenceTest
	ConvergenceTest (EntCmd *owr, int classTag)

	ConvergenceTest (EntCmd *owr, int clasTag, int maxIter, int prtFlg, int normType, int sz_norms=1)

virtual ConvergenceTest *	getCopy (void) const =0

virtual ConvergenceTest *	getCopy (int iterations) const

virtual std::string	getStatusMsg (const int &flag=1) const =0

virtual int	start (void)

virtual int	test (void)=0

int	getMaxNumIter (void) const

void	setMaxNumIter (const int &)

int	getCurrentIter (void) const

void	setCurrentIter (const int &)

int	getPrintFlag (void) const

void	setPrintFlag (const int &)

int	getNormType (void) const

void	setNormType (const int &)

virtual int	getNumTests (void) const

virtual int	getMaxNumTests (void) const

virtual double	getRatioNumToMax (void) const

virtual const Vector &	getNorms (void) const

std::string	getTestIterationMessage (void) const
	Returns a string with the name of the class and the iteration number.

std::string	getFailedToConvergeMessage (void) const
	Returns a string with the proper failed to converge message.

std::string	getDeltaXRMessage (void) const
	Returns a string with the values of x and b vectors.

std::string	getDeltaXRNormsMessage (void) const
	Returns a string with the values of x and b vector norms.

Public Member Functions inherited from XC::MovableObject
	MovableObject (int classTag, int dbTag)
	Constructor.

	MovableObject (int classTag)
	Constructor.

	MovableObject (const MovableObject &otro)
	Copy constructor.

MovableObject &	operator= (const MovableObject &otro)
	Operacdor asignación.

int	getClassTag (void) const
	Returns the tag de la clase.

int	getDbTag (void) const
	Returns the tag para la database.

int	getDbTag (CommParameters &)
	Returns the tag para la database.

void	setDbTag (int dbTag)
	Asigna el tag para la database.

void	setDbTag (CommParameters &)
	Asigna, sólo si es preciso, el tag para la database.

virtual int	setParameter (const std::vector< std::string > &argv, Parameter &param)

virtual int	updateParameter (int parameterID, Information &info)

virtual int	activateParameter (int parameterID)

virtual int	setVariable (const std::string &variable, Information &)
	Returns the identificador de la variable cuyo nombre being passed as parameter.

virtual int	getVariable (const std::string &variable, Information &)

Public Member Functions inherited from XC::DistributedBase
	DistributedBase (void)
	Constructor.

virtual DbTagData &	getDbTagData (void) const
	Returns a vector to store class dbTags.

const int &	getDbTagDataPos (const int &i) const
	Returns the data at the i-th position.

void	setDbTagDataPos (const int &i, const int &v)
	Sets the data at the i-th position.

void	inicComm (const int &dataSize) const
	Initializes communication.

Protected Member Functions
int	sendData (CommParameters &)
	Send object members through the channel being passed as parameter.

int	recvData (const CommParameters &)
	Receives object members through the channel being passed as parameter.

Protected Member Functions inherited from XC::ConvergenceTest
bool	hasLinearSOE (void) const
	Returns true ifpuede acceder al system of equations.

LinearSOE *	getLinearSOEPtr (void)
	Returns a pointer to the system of equations.

const LinearSOE *	getLinearSOEPtr (void) const
	Returns a const pointer to the system of equations.

const Vector &	getX (void) const
	Returns the vector de incógnitas.

double	getNormX (void) const
	Return the norma del vector de incógnitas.

const Vector &	getB (void) const
	Returns the vector de términos independientes.

double	getNormB (void) const
	Return the norma del vector de términos independientes.

double	getEnergyProduct (void) const
	Returns the the energy increment, which is 0.5 times the absolute value of the product of the rhs and the solution vector of the LinearSOE: \|0.5*(x ^ b)\|.

int	sendData (CommParameters &)
	Send object members through the channel being passed as parameter.

int	recvData (const CommParameters &)
	Receives object members through the channel being passed as parameter.

Protected Attributes
double	tol
	the tol on the energy used to test for convergence

Protected Attributes inherited from XC::ConvergenceTest
int	currentIter
	number of times test() has been invokes since last start()

int	maxNumIter
	max number of iterations

int	printFlag
	a flag indicating if to print on test

int	nType
	type of norm to use (1-norm, 2-norm, p-norm, max-norm)

Vector	norms
	vector to hold the norms

double	lastRatio
	Last calculated ratio (if any).

double	calculatedNormX
	Last calculated \|x\|.

double	calculatedNormB
	Last calculated \|b\|.

double	calculatedEnergyProduct
	Last calculated \|0.5*(x ^ b)\|.

Detailed Description

Convergence test with tolerance threshold.

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

/usr/local/src/prg/xc/src/solution/analysis/convergenceTest/ConvergenceTestTol.h
/usr/local/src/prg/xc/src/solution/analysis/convergenceTest/ConvergenceTestTol.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description