Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

CTestNormUnbalance Class Reference

#include <CTestNormUnbalance.h>

Inheritance diagram for CTestNormUnbalance::

ConvergenceTest MovableObject List of all members.

Public Methods

 CTestNormUnbalance ()
 constructors and destructor. More...

 CTestNormUnbalance (double tol, int maxNumIter, int printFlag)
 ~CTestNormUnbalance ()
ConvergenceTestgetCopy (int interations)
void setTolerance (double newTol)
int setEquiSolnAlgo (EquiSolnAlgo &theAlgo)
int test (void)
int start (void)
int getNumTests (void)
int getMaxNumTests (void)
double getRatioNumToMax (void)
const VectorgetNorms (void)
int sendSelf (int commitTag, Channel &theChannel)
int recvSelf (int commitTag, Channel &theChannel, FEM_ObjectBroker &theBroker)

Detailed Description

A CTestNormUnbalance object is an object which can be used in an algorithmic class to test if convergence has been achieved. The CTestNormUnbalance class tests using the norm of the right hand side Vector of a LinearSOE object and a user specified tolerance value. \

Definition at line 56 of file CTestNormUnbalance.h.


Constructor & Destructor Documentation

CTestNormUnbalance::CTestNormUnbalance ( )
 

constructors and destructor.

Definition at line 33 of file CTestNormUnbalance.cpp.

Referenced by getCopy().

CTestNormUnbalance::CTestNormUnbalance ( double tol,
int maxNumIter,
int printFlag )
 

{CTestNormUnbalance(double tol, int );}

Definition at line 40 of file CTestNormUnbalance.cpp.

CTestNormUnbalance::~CTestNormUnbalance ( )
 

To be used by the FEM\_ObjectBroker object in parallel programs. The integer {CLASS\_TAGS\_CTestNormUnbalance}, 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 48 of file CTestNormUnbalance.cpp.


Member Function Documentation

ConvergenceTest * CTestNormUnbalance::getCopy ( int interations ) [virtual]
 

Reimplemented from ConvergenceTest.

Definition at line 56 of file CTestNormUnbalance.cpp.

int CTestNormUnbalance::getMaxNumTests ( void ) [virtual]
 

Reimplemented from ConvergenceTest.

Definition at line 187 of file CTestNormUnbalance.cpp.

const Vector & CTestNormUnbalance::getNorms ( void ) [virtual]
 

Reimplemented from ConvergenceTest.

Definition at line 200 of file CTestNormUnbalance.cpp.

int CTestNormUnbalance::getNumTests ( void ) [virtual]
 

Reimplemented from ConvergenceTest.

Definition at line 181 of file CTestNormUnbalance.cpp.

double CTestNormUnbalance::getRatioNumToMax ( void ) [virtual]
 

Reimplemented from ConvergenceTest.

Definition at line 193 of file CTestNormUnbalance.cpp.

int CTestNormUnbalance::recvSelf ( int commitTag,
Channel & theChannel,
FEM_ObjectBroker & theBroker ) [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 221 of file CTestNormUnbalance.cpp.

int CTestNormUnbalance::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 207 of file CTestNormUnbalance.cpp.

int CTestNormUnbalance::setEquiSolnAlgo ( EquiSolnAlgo & theAlgo ) [virtual]
 

Reimplemented from ConvergenceTest.

Definition at line 73 of file CTestNormUnbalance.cpp.

void CTestNormUnbalance::setTolerance ( double newTol )
 

Definition at line 67 of file CTestNormUnbalance.cpp.

int CTestNormUnbalance::start ( void ) [virtual]
 

Reimplemented from ConvergenceTest.

Definition at line 166 of file CTestNormUnbalance.cpp.

int CTestNormUnbalance::test ( void ) [virtual]
 

Reimplemented from ConvergenceTest.

Definition at line 86 of file CTestNormUnbalance.cpp.


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