Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members
CTestNormDispIncr Class Reference#include <CTestNormDispIncr.h>
Inheritance diagram for CTestNormDispIncr::
List of all members.
Detailed Description
A CTestNormDispIncr object is an object which can be used in an algorithmic class to test if convergence has been achieved. The CTestNormDispIncr class tests using the norm of the solution Vector of a LinearSOE object and a user specified tolerance value. \
Definition at line 56 of file CTestNormDispIncr.h.
Constructor & Destructor Documentation
|
CTestNormDispIncr::CTestNormDispIncr (
|
)
|
|
|
CTestNormDispIncr::CTestNormDispIncr (
|
double tol,
|
|
int maxNumIter,
|
|
int printFlag )
|
|
|
|
The integer {CLASS\_TAGS\_CTestNormDispIncr}, defined in 
classTags.h\form#24, is passed to the ConvergenceTest constructor. Sets the tolerance used in {test()} to be {tol}, the max number of iterations to be performed to {maxNumIter} and the print flag used to determine what, if anything, is printed on each test to {printFlag}.
Definition at line 41 of file CTestNormDispIncr.cpp. |
|
CTestNormDispIncr::~CTestNormDispIncr (
|
)
|
|
|
|
To be used by the FEM\_ObjectBroker object in parallel programs. The integer {CLASS\_TAGS\_CTestNormDispIncr}, 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 49 of file CTestNormDispIncr.cpp. |
Member Function Documentation
|
int CTestNormDispIncr::getMaxNumTests (
|
void ) [virtual]
|
|
|
const Vector & CTestNormDispIncr::getNorms (
|
void ) [virtual]
|
|
|
int CTestNormDispIncr::getNumTests (
|
void ) [virtual]
|
|
|
double CTestNormDispIncr::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 222 of file CTestNormDispIncr.cpp. |
|
int CTestNormDispIncr::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 208 of file CTestNormDispIncr.cpp. |
|
int CTestNormDispIncr::setEquiSolnAlgo (
|
EquiSolnAlgo & theAlgo ) [virtual]
|
|
|
void CTestNormDispIncr::setTolerance (
|
double newTol )
|
|
|
int CTestNormDispIncr::start (
|
void ) [virtual]
|
|
|
int CTestNormDispIncr::test (
|
void ) [virtual]
|
|
The documentation for this class was generated from the following files:
|
Copyright