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

SolutionAlgorithm Class Reference

#include <SolutionAlgorithm.h>

Inheritance diagram for SolutionAlgorithm::

MovableObject DomainDecompAlgo EigenAlgorithm EquiSolnAlgo FrequencyAlgo BFGS Broyden KrylovNewton Linear ModifiedNewton NewtonLineSearch NewtonRaphson List of all members.

Public Methods

 SolutionAlgorithm (int classTag)
virtual ~SolutionAlgorithm ()
virtual int domainChanged (void)
virtual int addRecorder (Recorder &theRecorder)
 methods for monitoring the analysis during an algorithm. More...

virtual int playback (int track)
virtual int record (int track)

Detailed Description

The SolutionAlgorithm class is an abstract base class. Its purpose is to define the interface common among all its subclasses. A SolutionAlgorithm object performs the steps in the analysis by specifying the sequence of operations to be performed by members in the analysis aggregation.\

}

Definition at line 59 of file SolutionAlgorithm.h.

Constructor & Destructor Documentation

SolutionAlgorithm::SolutionAlgorithm ( int classTag )
 

The integer {classTag} is passed to the MovableObject classes constructor.

Definition at line 31 of file SolutionAlgorithm.cpp.

SolutionAlgorithm::~SolutionAlgorithm ( ) [virtual]
 

Invokes the destructor on any recorder object added to the SolutionAlgorithm and releases memory used to hold pointers to the recorder objects.

Definition at line 37 of file SolutionAlgorithm.cpp.

Member Function Documentation

int SolutionAlgorithm::addRecorder ( Recorder & theRecorder ) [virtual]
 

methods for monitoring the analysis during an algorithm.

Definition at line 54 of file SolutionAlgorithm.cpp.

int SolutionAlgorithm::domainChanged ( void ) [virtual]
 

Is called by the Analysis if the domain changes. It is called after {domainChange()} has been called on the ConstraintHandler, DOF\_Numberer and the Integrator and after {setSize()} has been called on the SystemOfEqn object. For base class nothing is done and is returned. The subclasses can provide their own implementation of this method if anything needs to be done, e.g. memory allocation, To return if successful, a negative number if not.

Definition at line 48 of file SolutionAlgorithm.cpp.

Referenced by StaticAnalysis::domainChanged(), EigenAnalysis::domainChanged(), DomainDecompositionAnalysis::domainChanged(), DirectIntegrationAnalysis::domainChanged(), StaticAnalysis::setAlgorithm(), and DirectIntegrationAnalysis::setAlgorithm().

int SolutionAlgorithm::playback ( int track ) [virtual]
 

To invoke {playback(track)} on any Recorder objects which have been added to the SolutionAlgorithm.

Definition at line 84 of file SolutionAlgorithm.cpp.

int SolutionAlgorithm::record ( int track ) [virtual]
 

Definition at line 76 of file SolutionAlgorithm.cpp.

Referenced by NewtonRaphson::solveCurrentStep(), NewtonLineSearch::solveCurrentStep(), ModifiedNewton::solveCurrentStep(), KrylovNewton::solveCurrentStep(), Broyden::solveCurrentStep(), and BFGS::solveCurrentStep().

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