Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members
CTestEnergyIncr Class Reference#include <CTestEnergyIncr.h>
Inheritance diagram for CTestEnergyIncr::
List of all members.
Detailed Description
A CTestEnergyIncr object is an object which can be used in an algorithmic class to test if convergence has been achieved. The CTestEnergyIncr class tests using the energy increment, 0.5 times the absolute value of the dot product of the LinearSOE objects solution and rhs Vectors, and a user specified tolerance value. \
Definition at line 56 of file CTestEnergyIncr.h.
Constructor & Destructor Documentation
|
CTestEnergyIncr::CTestEnergyIncr (
|
)
|
|
|
CTestEnergyIncr::CTestEnergyIncr (
|
double tol,
|
|
int maxNumIter,
|
|
int printFlag )
|
|
|
|
The integer {CLASS\_TAGS\_CTestEnergyIncr}, defined in 
classTags.h\form#24, is passed to the ConvergenceTest constructor. Sets the tolerance used in {test()} to be {tol} and the max number of iterations to be performed to {maxNumIter}.
Definition at line 51 of file CTestEnergyIncr.cpp. |
|
CTestEnergyIncr::~CTestEnergyIncr (
|
)
|
|
|
|
To be used by the FEM\_ObjectBroker object in parallel programs. The integer {CLASS\_TAGS\_CTestEnergyIncr}, defined in
classTags.h\form#24, is passed to the ConvergenceTest constructor. Sets the tolerance used in {test()} to be {0.0} and {maxNumIter} to be 
. These will be set when {recvSelf()} is invoked on the object.
Definition at line 59 of file CTestEnergyIncr.cpp. |
Member Function Documentation
|
int CTestEnergyIncr::getMaxNumTests (
|
void ) [virtual]
|
|
|
const Vector & CTestEnergyIncr::getNorms (
|
void ) [virtual]
|
|
|
int CTestEnergyIncr::getNumTests (
|
void ) [virtual]
|
|
|
double CTestEnergyIncr::getRatioNumToMax (
|
void ) [virtual]
|
|
|
|
This is a pure virtual method, one must be written for each instantiable subclass of MovableObject. Each object has to receive the data needed to be able to recreate itself in the new process after it has been sent through {theChannel}. If the object is an aggregation containing other objects, new objects of the correct type can be constructed using {theBroker}. To return
if successful or a 
if not.
Reimplemented from MovableObject.
Definition at line 236 of file CTestEnergyIncr.cpp. |
|
int CTestEnergyIncr::sendSelf (
|
int commitTag,
|
|
Channel & theChannel ) [virtual]
|
|
|
|
This is a pure virtual method, one must be written for each instantiable subclass of MovableObject. Each object has to send the data needed to be able to reproduce that object in a remote process. The object uses the methods provided by {theChannel} object to send the data to another channel at the remote actor, the address of the channel is set before this method is called. An object of similar type at the remote actor is invoked with a {receiveSelf()} to receive the data. Returns
if successful (successful in that the data got to the channel), or a
if no data was sent.
Reimplemented from MovableObject.
Definition at line 220 of file CTestEnergyIncr.cpp. |
|
int CTestEnergyIncr::setEquiSolnAlgo (
|
EquiSolnAlgo & theAlgo ) [virtual]
|
|
|
void CTestEnergyIncr::setTolerance (
|
double newTol )
|
|
|
int CTestEnergyIncr::start (
|
void ) [virtual]
|
|
|
int CTestEnergyIncr::test (
|
void ) [virtual]
|
|
The documentation for this class was generated from the following files:
|
Copyright