Rythmos_FirstOrderErrorStepControlStrategy_decl.hpp

//@HEADER
// ***********************************************************************
//
//                           Rythmos Package
//                 Copyright (2006) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
// USA
// Questions? Contact Todd S. Coffey (tscoffe@sandia.gov)
//
// ***********************************************************************
//@HEADER

#ifndef Rythmos_FIRSTORDERERROR_STEP_CONTROL_STRATEGY_DECL_H
#define Rythmos_FIRSTORDERERROR_STEP_CONTROL_STRATEGY_DECL_H

#include "Rythmos_StepControlStrategyBase.hpp"
#include "Thyra_VectorBase.hpp"
#include "Teuchos_VerboseObject.hpp"

namespace Rythmos {

// Step Control Strategy object for FirstOrderErrorStepControlStrategy
//
// Order of calls:
// setRequestedStepSize()
// nextStepSize()
// optional:  nextStepOrder()
// setCorrection
// acceptStep
// completeStep or rejectStep
// repeat
//
template<class Scalar>
class FirstOrderErrorStepControlStrategy
  : virtual public StepControlStrategyBase<Scalar>
{
  public:

    typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType ScalarMag;

    void setRequestedStepSize(const StepperBase<Scalar>& stepper,
      const Scalar& stepSize, const StepSizeType& stepSizeType);

    void nextStepSize(const StepperBase<Scalar>& stepper, Scalar* stepSize,
      StepSizeType* stepSizeType, int* order);

    void setCorrection(
         const StepperBase<Scalar>& stepper
        ,const RCP<const Thyra::VectorBase<Scalar> >& soln
        ,const RCP<const Thyra::VectorBase<Scalar> >& ee
        ,int solveStatus
        );

    bool acceptStep(const StepperBase<Scalar>& stepper, Scalar* LETValue);

    void completeStep(const StepperBase<Scalar>& stepper);

    AttemptedStepStatusFlag rejectStep(const StepperBase<Scalar>& stepper);

    StepControlStrategyState getCurrentState();

    int getMaxOrder() const;

    void setStepControlData(const StepperBase<Scalar>& stepper);

    bool supportsCloning() const;

    RCP<StepControlStrategyBase<Scalar> > cloneStepControlStrategyAlgorithm() const;


    FirstOrderErrorStepControlStrategy();

    void describe(
      Teuchos::FancyOStream &out,
      const Teuchos::EVerbosityLevel verbLevel
      ) const;

    void setParameterList(RCP<Teuchos::ParameterList> const& paramList);

    RCP<Teuchos::ParameterList> getNonconstParameterList();

    RCP<Teuchos::ParameterList> unsetParameterList();

    RCP<const Teuchos::ParameterList> getValidParameters() const;


    void initialize(const StepperBase<Scalar>& stepper);


  private:

    // Private data members

    void defaultInitializeAllData_();

    StepControlStrategyState stepControlState_;

    RCP<Teuchos::ParameterList> parameterList_;

    Scalar initialStepSize_;
    Scalar requestedStepSize_;
    Scalar currentStepSize_;
    Scalar nextStepSize_;
    Scalar stepSizeFactor_;
    StepSizeType stepSizeType_;

    Scalar minStepSize_;
    Scalar maxStepSize_;
    Scalar maxStepSizeIncreaseFactor_;
    Scalar minStepSizeDecreaseFactor_;
    int numStepFailures_;
    int maxStepFailures_;
    int maxOrder_;
    Scalar errorRelativeTolerance_;
    Scalar errorAbsoluteTolerance_;
    int solveStatus_;

    RCP<const Thyra::VectorBase<Scalar> > x_;
    RCP<const Thyra::VectorBase<Scalar> > dx_;
    RCP<Thyra::VectorBase<Scalar> > errWtVec_;


    static const std::string initialStepSizeName_;
    static const double initialStepSizeDefault_;

    static const std::string minStepSizeName_;
    static const double minStepSizeDefault_;

    static const std::string maxStepSizeName_;
    static const double maxStepSizeDefault_;

    static const std::string maxStepSizeIncreaseFactorName_;
    static const double maxStepSizeIncreaseFactorDefault_;

    static const std::string minStepSizeDecreaseFactorName_;
    static const double minStepSizeDecreaseFactorDefault_;

    static const std::string maxStepFailuresName_;
    static const int maxStepFailuresDefault_;

    static const std::string errorRelativeToleranceName_;
    static const double errorRelativeToleranceDefault_;

    static const std::string errorAbsoluteToleranceName_;
    static const double errorAbsoluteToleranceDefault_;


    // Private member functions

    void setStepControlState_(StepControlStrategyState state);

};

} // namespace Rythmos

#endif // Rythmos_FIRSTORDERERROR_STEP_CONTROL_STRATEGY_DECL_H