XC::CTestRelativeTotalNormDispIncr Class Reference

Convergence test that uses the quotient of current and initial norms of the solution vector. More...

#include <CTestRelativeTotalNormDispIncr.h>

Inheritance diagram for XC::CTestRelativeTotalNormDispIncr:

Collaboration diagram for XC::CTestRelativeTotalNormDispIncr:

Public Member Functions
	CTestRelativeTotalNormDispIncr (CommandEntity *owr)
	Default constructor. More...
	CTestRelativeTotalNormDispIncr (CommandEntity *owr, double tol, int maxNumIter, int printFlag, int normType=2)
	Constructor. More...
ConvergenceTest *	getCopy (void) const
virtual std::string	getStatusMsg (const int &flag=1) const
	Returns a message showing the values of the principal parameters.
int	test (void)
	Return a positive number if convergence is achieved. More...
Public Member Functions inherited from XC::ConvergenceTestNorm
	ConvergenceTestNorm (CommandEntity *owr, int classTag)
	Constructor. More...
	ConvergenceTestNorm (CommandEntity *owr, int cTag, double tl, int maxNIter, int printFlag, int normType, int sz)
	Constructor. More...
virtual int	start (void)
	Sets an integer indicating the current number of iterations, {currentNumIter} to \(1\). More...
Public Member Functions inherited from XC::ConvergenceTestTol
	ConvergenceTestTol (CommandEntity *owr, int classTag)
	Constructor. More...
	ConvergenceTestTol (CommandEntity *owr, int classTag, double tol, int maxNumIter, int printFlag, int normType, int sz_norms=1)
	Constructor. More...
void	setTolerance (double newTol)
	Sets the tolerance used in test() to be newTol.
double	getTolerance (void) const
	Gets the tolerance used in test().
int	sendSelf (Communicator &)
	Send the object. More...
int	recvSelf (const Communicator &)
	Receive the object. More...
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 (CommandEntity *owr, int classTag)
	Default constructor. More...
	ConvergenceTest (CommandEntity *owr, int clasTag, int maxIter, int prtFlg, int normType, int sz_norms=1)
	Constructor. More...
virtual ConvergenceTest *	getCopy (int iterations) const
	Virtual constructor.
int	getMaxNumIter (void) const
void	setMaxNumIter (const int &)
int	getCurrentIter (void) const
	Return the current iteration number.
void	setCurrentIter (const int &)
	Set the current iteration number.
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. More...
	MovableObject (int classTag)
	Constructor. More...
	MovableObject (const MovableObject &)
	Copy constructor. Doesn't copy the dbTag.
MovableObject &	operator= (const MovableObject &)
	Assignment operator. Doesn't copy the dbTag.
int	getClassTag (void) const
	Return the class identifier.
int	getDbTag (void) const
	Return the object identifier in the database.
int	getDbTag (Communicator &)
	Return the object identifier in the database.
void	setDbTag (int dbTag)
	Sets the object identifier in the database.
void	setDbTag (Communicator &)
	Sets the object identifier in the database if not already set. More...
virtual int	setParameter (const std::vector< std::string > &argv, Parameter &param)
	Sets the value param to the parameter argv.
virtual int	updateParameter (int parameterID, Information &info)
	Updates the parameter identified by parameterID with info.
virtual int	activateParameter (int parameterID)
	Activates the parameter identified by parameterID.
virtual int	setVariable (const std::string &variable, Information &)
	Set the value of the variable idenfified by var.
virtual int	getVariable (const std::string &variable, Information &)
	Return the value of the variable idenfified by var.
Public Member Functions inherited from XC::DistributedBase
	DistributedBase (void)
	Constructor.
virtual	~DistributedBase (void)
	Destructor.
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.
Public Member Functions inherited from CommandEntity
	CommandEntity (CommandEntity *owr=nullptr)
	Default constructor.
CommandEntity *	Owner (void)
	Return a pointer to the object owner.
const CommandEntity *	Owner (void) const
	Return un puntero al objeto propietario de ESTE.
const StandardOutputWrapper &	getStandardOutputWrapper (void) const
	Return the regular output stream wrapper.
StandardOutputWrapper &	getStandardOutputWrapper (void)
	Return the regular output stream wrapper.
const std::string &	getLogFileName (void) const
	Returns log file name.
void	setLogFileName (const std::string &)
	Sets log file name.
const std::string &	getErrFileName (void) const
	Returns err file name.
void	setErrFileName (const std::string &)
	Sets error file name.
const std::string &	getOutputFileName (void) const
	Returns regular output file name.
void	setOutputFileName (const std::string &)
	Sets regular output file name.
boost::python::object	evalPy (boost::python::object dict, const std::string &)
	Return the Python object that results from evaluating the argument.
boost::python::object	execPy (boost::python::object dict, const std::string &)
	Return the Python objects that results from executing the code in the string argument.
boost::python::object	execFilePy (boost::python::object dict, const std::string &)
	Return the Python object that results from executing the code in the file.
Public Member Functions inherited from EntityWithProperties
	EntityWithProperties (EntityWithProperties *owr=nullptr)
	Default constructor.
void	clearPyProps (void)
	Clear python properties map.
bool	hasPyProp (const std::string &)
	Returns true if property exists.
boost::python::object	getPyProp (const std::string &str)
	Return the Python object with the name being passed as parameter.
void	setPyProp (std::string str, boost::python::object val)
	Sets/appends a value tho the Python object's dictionary.
void	copyPropsFrom (const EntityWithProperties &)
	Copy the properties from the argument.
boost::python::list	getPropNames (void) const
	Return the names of the object properties weightings.
const PythonDict &	getPropertiesDict (void) const
	Return a std::map container with the properties of the object.
boost::python::dict	getPyDict (void) const
	Return a Python dictionary containing the object members values.
void	setPyDict (const boost::python::dict &)
	Set the values of the object members from a Python dictionary.
Public Member Functions inherited from EntityWithOwner
	EntityWithOwner (EntityWithOwner *owr=nullptr)
	Default constructor.
	EntityWithOwner (const EntityWithOwner &)
	Copy constructor.
EntityWithOwner &	operator= (const EntityWithOwner &)
	Assignment operator.
virtual bool	operator== (const EntityWithOwner &) const
	Comparison operator.
virtual	~EntityWithOwner (void)
	Virtual destructor.
virtual std::string	getClassName (void) const
	Returns demangled class name.
void	set_owner (EntityWithOwner *owr)
	Assigns the owner of the object.
EntityWithOwner *	Owner (void)
const EntityWithOwner *	Owner (void) const

Additional Inherited Members
Public Types inherited from EntityWithProperties
typedef std::map< std::string, boost::python::object >	PythonDict
Static Public Member Functions inherited from CommandEntity
static void	resetStandardOutput (void)
	Reset the standard output streams to its defaults buffers.
Static Public Member Functions inherited from EntityWithOwner
static int	getVerbosityLevel (void)
	Get the value of the verbosity level.
static void	setVerbosityLevel (const int &)
	Set the value of the verbosity level.
Protected Member Functions inherited from XC::ConvergenceTestTol
int	sendData (Communicator &)
	Send object members through the communicator argument.
int	recvData (const Communicator &)
	Receives object members through the communicator argument.
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 of unknowns.
double	getNormX (void) const
	Return the norma del vector of unknowns.
const Vector &	getB (void) const
	Return the vector at the right hand side of the equation.
double	getNormB (void) const
	Return the norm of the vector at the right hand side of the equation. More...
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)|. More...
int	sendData (Communicator &)
	Send object members through the communicator argument.
int	recvData (const Communicator &)
	Receives object members through the communicator argument.
Protected Member Functions inherited from CommandEntity
template<class T >
void	string_to (T &, const std::string &) const
Protected Member Functions inherited from EntityWithProperties
bool	isEqual (const EntityWithProperties &) const
	Return true if both objects are equal.
Protected Member Functions inherited from EntityWithOwner
virtual bool	isEqual (const EntityWithOwner &) const
	Return true if both objects are equal.
Static Protected Member Functions inherited from CommandEntity
static CommandEntity *	entcmd_cast (boost::any &data)
Protected Attributes inherited from XC::ConvergenceTestNorm
double	norm0
	norm at first iteration of each step
Protected Attributes inherited from XC::ConvergenceTestTol
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)|.
Static Protected Attributes inherited from EntityWithOwner
static int	verbosity = 1
	Object that owns THIS ONE. More...

Detailed Description

Convergence test that uses the quotient of current and initial norms of the solution vector.

Constructor & Destructor Documentation

CTestRelativeTotalNormDispIncr() [1/2]

XC::CTestRelativeTotalNormDispIncr::CTestRelativeTotalNormDispIncr

(

CommandEntity *

owr

)

Default constructor.

Parameters

owr	object that owns this one.

CTestRelativeTotalNormDispIncr() [2/2]

XC::CTestRelativeTotalNormDispIncr::CTestRelativeTotalNormDispIncr	(	CommandEntity *	owr,
		double	theTol,
		int	maxIter,
		int	printFlag,
		int	normType = 2
	)

Constructor.

Parameters

owr	object that owns this one.
theTol	the tolerance used in test().
maxIter	the max number of iterations to be performed.
printFlag	what, if anything, is printed on each test.
normType	type of norm to use (1-norm, 2-norm, p-norm, max-norm).

Member Function Documentation

test()

int XC::CTestRelativeTotalNormDispIncr::test ( void  )

virtual

Return a positive number if convergence is achieved.

To return a positive number if the convergence criteria defined for the object has been satisfied, the positibe number equal to the number of times since start that test() has been invoked. Otherwise a negative number is to be returned. A {-2} is returned if the test fails to meet the criteria and no more tests are to be performed due to limits set, i.e. the maximum number of iterations, otherwise a {-1} is to be returned.

Implements XC::ConvergenceTest.

---

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

• src/solution/analysis/convergenceTest/CTestRelativeTotalNormDispIncr.h
• src/solution/analysis/convergenceTest/CTestRelativeTotalNormDispIncr.cpp