XC Open source finite element analysis program
Public Member Functions | List of all members

Tests for convergence using the ratio of the current norm to the initial norm (the norm when start is invoked) of the which is 0.5 times the absolute value of the product of the rhs and the solution vector of the LinearSOE. More...

#include <CTestRelativeEnergyIncr.h>

Inheritance diagram for XC::CTestRelativeEnergyIncr:
XC::ConvergenceTestNorm XC::ConvergenceTestTol XC::ConvergenceTest XC::MovableObject XC::DistributedBase

Public Member Functions

 CTestRelativeEnergyIncr (EntCmd *owr)
 Constructor.
 
 CTestRelativeEnergyIncr (EntCmd *owr, double tol, int maxNumIter, int printFlag, int normType=2)
 Constructor.
 
ConvergenceTestgetCopy (void) const
 
virtual std::string getStatusMsg (const int &flag=1) const
 Returns a message showing the values of the principal parameters.
 
int test (void)
 Comprueba si se ha producido la convergencia.
 
- Public Member Functions inherited from XC::ConvergenceTestNorm
 ConvergenceTestNorm (EntCmd *owr, int classTag)
 
 ConvergenceTestNorm (EntCmd *owr, int cTag, double tl, int maxNIter, int printFlag, int normType, int sz)
 
virtual int start (void)
 
- Public Member Functions inherited from XC::ConvergenceTestTol
 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 ConvergenceTestgetCopy (int iterations) const
 
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 VectorgetNorms (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.
 
MovableObjectoperator= (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 DbTagDatagetDbTagData (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.
 

Additional Inherited Members

- Protected Member Functions inherited from XC::ConvergenceTestTol
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.
 
LinearSOEgetLinearSOEPtr (void)
 Returns a pointer to the system of equations.
 
const LinearSOEgetLinearSOEPtr (void) const
 Returns a const pointer to the system of equations.
 
const VectorgetX (void) const
 Returns the vector de incógnitas.
 
double getNormX (void) const
 Return the norma del vector de incógnitas.
 
const VectorgetB (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 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)|.
 

Detailed Description

Tests for convergence using the ratio of the current norm to the initial norm (the norm when start is invoked) of the which is 0.5 times the absolute value of the product of the rhs and the solution vector of the LinearSOE.


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