LOCA::StepSize::Generic Class Reference

Generic step size control interface. More...

#include <LOCA_StepSize_Generic.H>

Inheritance diagram for LOCA::StepSize::Generic:

[legend]
List of all members.

Public Member Functions

 Generic ()
 Constructor.
virtual ~Generic ()
 Destructor.
virtual NOX::Abstract::Group::ReturnType reset (NOX::Parameter::List &params)=0
 Reset parameters.
virtual NOX::Abstract::Group::ReturnType compute (LOCA::Continuation::ExtendedGroup &curGroup, const LOCA::Continuation::ExtendedVector &predictor, const NOX::Solver::Generic &solver, const LOCA::Abstract::Iterator::StepStatus &stepStatus, const LOCA::Stepper &stepper, double &stepSize)=0
 Compute the step size.
virtual NOX::Abstract::Group::ReturnType compute (LOCA::MultiContinuation::ExtendedGroup &curGroup, const LOCA::MultiContinuation::ExtendedVector &predictor, const NOX::Solver::Generic &solver, const LOCA::Abstract::Iterator::StepStatus &stepStatus, const LOCA::NewStepper &stepper, double &stepSize)=0
 Compute the step size.
virtual double getPrevStepSize () const =0
 Return the previous step size.
virtual double getStartStepSize () const =0
 Return the initial step size.

Detailed Description

Generic step size control interface.

Generic interface for computing a step size. Any step size control strategy class should be derived from this class and implement the pure virtual methods of this class.


Constructor & Destructor Documentation

LOCA::StepSize::Generic::Generic  )  [inline]
 

Constructor.

Constructors of derived objects should look like reset.


Member Function Documentation

virtual NOX::Abstract::Group::ReturnType LOCA::StepSize::Generic::compute LOCA::MultiContinuation::ExtendedGroup curGroup,
const LOCA::MultiContinuation::ExtendedVector predictor,
const NOX::Solver::Generic solver,
const LOCA::Abstract::Iterator::StepStatus stepStatus,
const LOCA::NewStepper stepper,
double &  stepSize
[pure virtual]
 

Compute the step size.

Returns NOX::Abstract::Group::Failed if the computed step size fails certain criteria (e.g., if it is too small)

Implemented in LOCA::StepSize::Adaptive, LOCA::StepSize::Constant, and LOCA::StepSize::Manager.

virtual NOX::Abstract::Group::ReturnType LOCA::StepSize::Generic::compute LOCA::Continuation::ExtendedGroup curGroup,
const LOCA::Continuation::ExtendedVector predictor,
const NOX::Solver::Generic solver,
const LOCA::Abstract::Iterator::StepStatus stepStatus,
const LOCA::Stepper stepper,
double &  stepSize
[pure virtual]
 

Compute the step size.

Returns NOX::Abstract::Group::Failed if the computed step size fails certain criteria (e.g., if it is too small)

Implemented in LOCA::StepSize::Adaptive, LOCA::StepSize::Constant, and LOCA::StepSize::Manager.


The documentation for this class was generated from the following file:
Generated on Thu Sep 18 12:42:26 2008 for NOX by doxygen 1.3.9.1