NOX Development
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
LOCA::Abstract::Iterator Class Referenceabstract

An abstract interface for implementing iteration. More...

#include <LOCA_Abstract_Iterator.H>

Inheritance diagram for LOCA::Abstract::Iterator:
Inheritance graph
[legend]

Public Types

enum  IteratorStatus { LastIteration = 2 , Finished = 1 , Failed = 0 , NotFinished = -1 }
 Enumerated type for status of the iterator. More...
enum  StepStatus { Successful = 1 , Unsuccessful = 0 , Provisional = -1 }
 Enumerated type for status of each step of iterator. More...

Public Member Functions

 Iterator (Teuchos::ParameterList &p)
 Constructor.
 Iterator (const Iterator &it)
 Copy Constructor.
virtual ~Iterator ()
 Destructor.
virtual bool resetIterator (Teuchos::ParameterList &p)
 Reset the iterator to start a new iteration.
virtual IteratorStatus getIteratorStatus () const
 Return the status of the iterator.
virtual int getStepNumber () const
 Returns the number of accepted steps.
virtual int getNumFailedSteps () const
 Returns the number of failed steps.
virtual int getNumTotalSteps () const
 Returns the total number of steps attempted.
virtual IteratorStatus run ()
 Run the iterator.

Protected Member Functions

 Iterator ()
 Constructor.
virtual IteratorStatus iterate ()
 Perform iteration.
virtual IteratorStatus stop (StepStatus)
 Check stopping criteria.
virtual IteratorStatus start ()=0
 Intialize iterator.
virtual IteratorStatus finish (IteratorStatus)=0
 Finalize iterator.
virtual StepStatus preprocess (StepStatus)=0
 Preprocess step.
virtual StepStatus compute (StepStatus)=0
 Compute step.
virtual StepStatus postprocess (StepStatus)=0
 Postprocess step.
virtual void setLastIteration ()
 Set iterator status as LastIteration.
virtual bool isLastIteration ()
 Returns true of the iteratorStatus is LastIteration.
virtual StepStatus computeStepStatus (StepStatus preStatus, StepStatus compStatus, StepStatus postStatus)
 Compute step, iterator status from status of each component of step.

Protected Attributes

int stepNumber
 Current step number of continuation algorithm (does not include failed steps).
int numFailedSteps
 Number of continuation steps that have failed.
int numTotalSteps
 Total number of steps attempeted (includes failed and successful steps).
int maxSteps
 Maximum number of continuation steps to take. Defaults to 100.
IteratorStatus iteratorStatus
 Current status of the iterator.

Detailed Description

An abstract interface for implementing iteration.

The LOCA::Abstract::Iterator defines an interface for implementing many kinds of iterative processes. In LOCA, this is used to implement the Stepper which computes points along a continuation curve.

Many iterative processes can be abstracted in the following manner:

  • Initialize iteration (start)
  • Compute iteration (iterate)
    • while iterator is not finished
      • preprocess step (preprocess)
      • compute step (compute)
      • postprocess step (posprocess)
      • check iterator status (stop)
  • Finalize iteration (finish)

The run method of the iterator implements this iterative process with start, finish, preprocess, compute and postprocess left as pure virtual methods to be implemented for the specific iterative process.

The iterator has one parameter, "Max Steps" (default 100) giving the maximum number of steps the iterator should take. The default implementation of stop only stops the iterator when this maximum number of steps has been reached.

Member Enumeration Documentation

◆ IteratorStatus

enum LOCA::Abstract::Iterator::IteratorStatus

Enumerated type for status of the iterator.

Enumerator
LastIteration 

This is the last iteration.

Finished 

The iterator is finished.

Failed 

The iterator has failed.

NotFinished 

The iterator is not finished.

◆ StepStatus

enum LOCA::Abstract::Iterator::StepStatus

Enumerated type for status of each step of iterator.

Enumerator
Successful 

The last step was successful.

Unsuccessful 

The last step was unsuccessful.

Provisional 

One more unsuccessful step means failure.

Constructor & Destructor Documentation

◆ Iterator() [1/3]

LOCA::Abstract::Iterator::Iterator ( Teuchos::ParameterList & p)

Constructor.

References Iterator(), iteratorStatus, maxSteps, NotFinished, numFailedSteps, numTotalSteps, resetIterator(), and stepNumber.

Referenced by Iterator(), Iterator(), LOCA::Stepper::Stepper(), and LOCA::Stepper::Stepper().

◆ Iterator() [2/3]

LOCA::Abstract::Iterator::Iterator ( const Iterator & it)

Copy Constructor.

References iteratorStatus, maxSteps, numFailedSteps, numTotalSteps, and stepNumber.

◆ Iterator() [3/3]

LOCA::Abstract::Iterator::Iterator ( )
protected

Constructor.

References Iterator(), iteratorStatus, maxSteps, NotFinished, numFailedSteps, numTotalSteps, and stepNumber.

Member Function Documentation

◆ compute()

virtual StepStatus LOCA::Abstract::Iterator::compute ( StepStatus )
protectedpure virtual

Compute step.

Implemented in LOCA::AdaptiveStepper, LOCA::Epetra::AdaptiveStepper, and LOCA::Stepper.

Referenced by iterate().

◆ computeStepStatus()

LOCA::Abstract::Iterator::StepStatus LOCA::Abstract::Iterator::computeStepStatus ( StepStatus preStatus,
StepStatus compStatus,
StepStatus postStatus )
protectedvirtual

Compute step, iterator status from status of each component of step.

References Failed, iteratorStatus, Provisional, Successful, and Unsuccessful.

Referenced by iterate(), LOCA::AdaptiveStepper::iterate(), LOCA::Epetra::AdaptiveStepper::iterate(), and postprocess().

◆ finish()

virtual IteratorStatus LOCA::Abstract::Iterator::finish ( IteratorStatus )
protectedpure virtual

Finalize iterator.

Implemented in LOCA::AdaptiveStepper, LOCA::Epetra::AdaptiveStepper, and LOCA::Stepper.

Referenced by run().

◆ getIteratorStatus()

LOCA::Abstract::Iterator::IteratorStatus LOCA::Abstract::Iterator::getIteratorStatus ( ) const
virtual

Return the status of the iterator.

References iteratorStatus.

◆ getNumFailedSteps()

int LOCA::Abstract::Iterator::getNumFailedSteps ( ) const
virtual

Returns the number of failed steps.

References numFailedSteps.

◆ getNumTotalSteps()

int LOCA::Abstract::Iterator::getNumTotalSteps ( ) const
virtual

Returns the total number of steps attempted.

References numTotalSteps.

◆ getStepNumber()

int LOCA::Abstract::Iterator::getStepNumber ( ) const
virtual

Returns the number of accepted steps.

References stepNumber.

Referenced by LOCA::AdaptiveStepper::postprocess(), LOCA::Epetra::AdaptiveStepper::postprocess(), and LOCA::Stepper::postprocess().

◆ isLastIteration()

bool LOCA::Abstract::Iterator::isLastIteration ( )
protectedvirtual

Returns true of the iteratorStatus is LastIteration.

References iteratorStatus, and LastIteration.

Referenced by postprocess(), LOCA::AdaptiveStepper::stop(), LOCA::Epetra::AdaptiveStepper::stop(), and LOCA::Stepper::stopDeprecated().

◆ iterate()

LOCA::Abstract::Iterator::IteratorStatus LOCA::Abstract::Iterator::iterate ( )
protectedvirtual

Perform iteration.

Reimplemented in LOCA::AdaptiveStepper, and LOCA::Epetra::AdaptiveStepper.

References compute(), computeStepStatus(), Failed, iteratorStatus, NotFinished, numFailedSteps, numTotalSteps, postprocess(), preprocess(), stepNumber, stop(), and Successful.

Referenced by run().

◆ postprocess()

virtual StepStatus LOCA::Abstract::Iterator::postprocess ( StepStatus )
protectedpure virtual

Postprocess step.

Implemented in LOCA::AdaptiveStepper, LOCA::Epetra::AdaptiveStepper, and LOCA::Stepper.

References computeStepStatus(), isLastIteration(), and setLastIteration().

Referenced by iterate().

◆ preprocess()

virtual StepStatus LOCA::Abstract::Iterator::preprocess ( StepStatus )
protectedpure virtual

Preprocess step.

Implemented in LOCA::AdaptiveStepper, LOCA::Epetra::AdaptiveStepper, and LOCA::Stepper.

Referenced by iterate().

◆ resetIterator()

bool LOCA::Abstract::Iterator::resetIterator ( Teuchos::ParameterList & p)
virtual

Reset the iterator to start a new iteration.

References iteratorStatus, maxSteps, NotFinished, numFailedSteps, numTotalSteps, and stepNumber.

Referenced by Iterator().

◆ run()

LOCA::Abstract::Iterator::IteratorStatus LOCA::Abstract::Iterator::run ( )
virtual

Run the iterator.

Reimplemented in LOCA::AdaptiveStepper, and LOCA::Epetra::AdaptiveStepper.

References Failed, finish(), iterate(), iteratorStatus, start(), and stepNumber.

◆ setLastIteration()

void LOCA::Abstract::Iterator::setLastIteration ( )
protectedvirtual

Set iterator status as LastIteration.

References iteratorStatus, and LastIteration.

Referenced by LOCA::AdaptiveStepper::computeStepSize(), LOCA::Epetra::AdaptiveStepper::computeStepSize(), LOCA::Stepper::computeStepSize(), and postprocess().

◆ start()

virtual IteratorStatus LOCA::Abstract::Iterator::start ( )
protectedpure virtual

Intialize iterator.

Implemented in LOCA::AdaptiveStepper, LOCA::Epetra::AdaptiveStepper, and LOCA::Stepper.

Referenced by run().

◆ stop()

LOCA::Abstract::Iterator::IteratorStatus LOCA::Abstract::Iterator::stop ( StepStatus )
protectedvirtual

Check stopping criteria.

Reimplemented in LOCA::AdaptiveStepper, LOCA::Epetra::AdaptiveStepper, and LOCA::Stepper.

References Finished, maxSteps, NotFinished, and numTotalSteps.

Referenced by iterate().

Member Data Documentation

◆ iteratorStatus

IteratorStatus LOCA::Abstract::Iterator::iteratorStatus
protected

Current status of the iterator.

Referenced by computeStepStatus(), getIteratorStatus(), isLastIteration(), iterate(), LOCA::AdaptiveStepper::iterate(), LOCA::Epetra::AdaptiveStepper::iterate(), Iterator(), Iterator(), Iterator(), resetIterator(), run(), LOCA::AdaptiveStepper::run(), LOCA::Epetra::AdaptiveStepper::run(), and setLastIteration().

◆ maxSteps

int LOCA::Abstract::Iterator::maxSteps
protected

Maximum number of continuation steps to take. Defaults to 100.

Referenced by Iterator(), Iterator(), Iterator(), LOCA::AdaptiveStepper::printInitializationInfo(), LOCA::Epetra::AdaptiveStepper::printInitializationInfo(), LOCA::Stepper::printInitializationInfo(), resetIterator(), stop(), LOCA::AdaptiveStepper::stop(), LOCA::Epetra::AdaptiveStepper::stop(), and LOCA::Stepper::stopDeprecated().

◆ numFailedSteps

int LOCA::Abstract::Iterator::numFailedSteps
protected

Number of continuation steps that have failed.

Referenced by getNumFailedSteps(), iterate(), LOCA::AdaptiveStepper::iterate(), LOCA::Epetra::AdaptiveStepper::iterate(), Iterator(), Iterator(), Iterator(), and resetIterator().

◆ numTotalSteps

int LOCA::Abstract::Iterator::numTotalSteps
protected

Total number of steps attempeted (includes failed and successful steps).

Referenced by getNumTotalSteps(), iterate(), LOCA::AdaptiveStepper::iterate(), LOCA::Epetra::AdaptiveStepper::iterate(), Iterator(), Iterator(), Iterator(), resetIterator(), stop(), LOCA::AdaptiveStepper::stop(), LOCA::Epetra::AdaptiveStepper::stop(), and LOCA::Stepper::stopDeprecated().

◆ stepNumber

int LOCA::Abstract::Iterator::stepNumber
protected

Current step number of continuation algorithm (does not include failed steps).

Referenced by LOCA::AdaptiveStepper::adapt(), getStepNumber(), iterate(), LOCA::AdaptiveStepper::iterate(), LOCA::Epetra::AdaptiveStepper::iterate(), Iterator(), Iterator(), Iterator(), LOCA::AdaptiveStepper::printEndStep(), LOCA::Epetra::AdaptiveStepper::printEndStep(), LOCA::Stepper::printEndStep(), LOCA::AdaptiveStepper::printRelaxationEndStep(), LOCA::Epetra::AdaptiveStepper::printRelaxationEndStep(), LOCA::AdaptiveStepper::printRelaxationStep(), LOCA::Epetra::AdaptiveStepper::printRelaxationStep(), LOCA::AdaptiveStepper::printStartStep(), LOCA::Epetra::AdaptiveStepper::printStartStep(), LOCA::Stepper::printStartStep(), resetIterator(), run(), LOCA::AdaptiveStepper::run(), and LOCA::Epetra::AdaptiveStepper::run().

The documentation for this class was generated from the following files:
Generated by doxygen 1.18.0