libtrilinos-rythmos-dev 12.10.1-3 / usr / include / trilinos / Rythmos_BackwardEulerStepper_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_BACKWARD_EULER_STEPPER_DECL_H
#define Rythmos_BACKWARD_EULER_STEPPER_DECL_H

#include "Rythmos_SolverAcceptingStepperBase.hpp"
#include "Rythmos_StepControlStrategyAcceptingStepperBase.hpp"
#include "Rythmos_InterpolatorAcceptingObjectBase.hpp"
#include "Rythmos_SingleResidualModelEvaluator.hpp"
#include "Rythmos_MomentoBase.hpp"

#include "Thyra_VectorBase.hpp"
#include "Thyra_ModelEvaluator.hpp"
#include "Thyra_NonlinearSolverBase.hpp"
#include "Teuchos_ParameterListAcceptorDefaultBase.hpp"


namespace Rythmos {


/** \brief Concrete momento class for the BackwardEulerStepper.
 *
 * Note:  The model and solver is not contained in the momento and must be
 *        set on the stepper in addition to the momento.
 */
template<class Scalar>
  class BackwardEulerStepperMomento :
    virtual public MomentoBase<Scalar>,
    virtual public Teuchos::ParameterListAcceptorDefaultBase
{
  public:
    BackwardEulerStepperMomento() {}
    virtual ~BackwardEulerStepperMomento() {}

    RCP<MomentoBase<Scalar> > clone() const
    {
      RCP<BackwardEulerStepperMomento<Scalar> > m =
        rcp(new BackwardEulerStepperMomento<Scalar>());
      m->set_scaled_x_old(scaled_x_old_);
      m->set_x_dot_old(x_dot_old_);
      m->set_x(x_);
      m->set_x_old(x_old_);
      m->set_x_dot(x_dot_);
      m->set_dx(dx_);
      m->set_t(t_);
      m->set_t_old(t_old_);
      m->set_dt(dt_);
      m->set_numSteps(numSteps_);
      m->set_isInitialized(isInitialized_);
      m->set_haveInitialCondition(haveInitialCondition_);
      m->set_parameterList(parameterList_);
      m->set_basePoint(basePoint_);
      m->set_neModel(neModel_);
      m->set_interpolator(interpolator_);
      m->set_stepControl(stepControl_);
      if (!Teuchos::is_null(this->getMyParamList())) {
        m->setParameterList(Teuchos::parameterList(*(this->getMyParamList())));
      }
      // How do I copy the VerboseObject data?
      // 07/10/09 tscoffe:  Its not set up in Teuchos to do this yet
      return m;
    }

    void serialize(
        const StateSerializerStrategy<Scalar>& stateSerializer,
        std::ostream& oStream
        ) const
    { }

    void deSerialize(
        const StateSerializerStrategy<Scalar>& stateSerializer,
        std::istream& iStream
        )
    { }

    void set_scaled_x_old(const RCP<const VectorBase<Scalar> >& scaled_x_old )
    {
      scaled_x_old_ = Teuchos::null;
      if (!Teuchos::is_null(scaled_x_old)) {
        scaled_x_old_ = scaled_x_old->clone_v();
      }
    }
    RCP<VectorBase<Scalar> > get_scaled_x_old() const
    { return scaled_x_old_; }

    void set_x_dot_old(const RCP<const VectorBase<Scalar> >& x_dot_old )
    {
      x_dot_old_ = Teuchos::null;
      if (!Teuchos::is_null(x_dot_old)) {
        x_dot_old_ = x_dot_old->clone_v();
      }
    }
    RCP<VectorBase<Scalar> > get_x_dot_old() const
    { return x_dot_old_; }

    void set_x_old(const RCP<const VectorBase<Scalar> >& x_old )
    {
      x_old_ = Teuchos::null;
      if (!Teuchos::is_null(x_old)) {
        x_old_ = x_old->clone_v();
      }
    }
    RCP<VectorBase<Scalar> > get_x_old() const
    { return x_old_; }

    void set_x(const RCP<const VectorBase<Scalar> >& x )
    {
      x_ = Teuchos::null;
      if (!Teuchos::is_null(x)) {
        x_ = x->clone_v();
      }
    }
    RCP<VectorBase<Scalar> > get_x() const
    { return x_; }

    void set_dx(const RCP<const VectorBase<Scalar> >& dx )
    {
      dx_ = Teuchos::null;
      if (!Teuchos::is_null(dx)) {
        dx_ = dx->clone_v();
      }
    }
    RCP<VectorBase<Scalar> > get_dx() const
    { return dx_; }

    void set_x_dot(const RCP<const VectorBase<Scalar> >& x_dot )
    {
      x_dot_ = Teuchos::null;
      if (!Teuchos::is_null(x_dot)) {
        x_dot_ = x_dot->clone_v();
      }
    }
    RCP<VectorBase<Scalar> > get_x_dot() const
    { return x_dot_; }

    void set_t(const Scalar & t)
    { t_ = t; }
    Scalar get_t() const
    { return t_; }

    void set_t_old(const Scalar & t_old)
    { t_old_ = t_old; }
    Scalar get_t_old() const
    { return t_old_; }

    void set_dt(const Scalar & dt)
    { dt_ = dt; }
    Scalar get_dt() const
    { return dt_; }

    void set_numSteps(const int & numSteps)
    { numSteps_ = numSteps; }
    int get_numSteps() const
    { return numSteps_; }

    void set_newtonConvergenceStatus(const int & newtonConvergenceStatus)
    { newtonConvergenceStatus_ = newtonConvergenceStatus; }
    int get_newtonConvergenceStatus() const
    { return newtonConvergenceStatus_; }

    void set_isInitialized(const bool & isInitialized)
    { isInitialized_ = isInitialized; }
    bool get_isInitialized() const
    { return isInitialized_; }

    void set_haveInitialCondition(const bool & haveInitialCondition)
    { haveInitialCondition_ = haveInitialCondition; }
    bool get_haveInitialCondition() const
    { return haveInitialCondition_; }

    void set_parameterList(const RCP<const ParameterList>& pl)
    {
      parameterList_ = Teuchos::null;
      if (!Teuchos::is_null(pl)) {
        parameterList_ = Teuchos::parameterList(*pl);
      }
    }
    RCP<ParameterList> get_parameterList() const
    { return parameterList_; }

    void set_basePoint(Thyra::ModelEvaluatorBase::InArgs<Scalar> basePoint)
    { basePoint_ = basePoint; };
    Thyra::ModelEvaluatorBase::InArgs<Scalar> get_basePoint() const
    { return basePoint_; }

    void set_neModel(const RCP<Rythmos::SingleResidualModelEvaluator<Scalar> >& neModel)
    {
      neModel_ = Teuchos::null;
      if (!Teuchos::is_null(neModel)) {
        neModel_ = Teuchos::rcp(new Rythmos::SingleResidualModelEvaluator<Scalar>);
      }
    }
    RCP<Rythmos::SingleResidualModelEvaluator<Scalar> > get_neModel() const
    { return neModel_; }

    void set_interpolator(const RCP<InterpolatorBase<Scalar> >& interpolator)
    {
      interpolator_ = Teuchos::null;
      if (!Teuchos::is_null(interpolator)) {
        TEUCHOS_ASSERT(interpolator->supportsCloning());
        interpolator_ = interpolator->cloneInterpolator();
      }
    }
    RCP<InterpolatorBase<Scalar> > get_interpolator() const
    { return interpolator_; }

    void set_stepControl(const RCP<StepControlStrategyBase<Scalar> >& stepControl)
    {
      stepControl_ = Teuchos::null;
      if (!Teuchos::is_null(stepControl)) {
        TEUCHOS_ASSERT(stepControl->supportsCloning());
        stepControl_ = stepControl->cloneStepControlStrategyAlgorithm();
      }
    }
    RCP<StepControlStrategyBase<Scalar> > get_stepControl() const
    { return stepControl_; }

    void setParameterList(const RCP<ParameterList>& paramList)
    { this->setMyParamList(paramList); }
    RCP<const ParameterList> getValidParameters() const
    { return Teuchos::null; }

  private:
    RCP<Thyra::VectorBase<Scalar> > scaled_x_old_;
    RCP<Thyra::VectorBase<Scalar> > x_old_;
    RCP<Thyra::VectorBase<Scalar> > x_dot_old_;
    RCP<Thyra::VectorBase<Scalar> > x_;
    RCP<Thyra::VectorBase<Scalar> > x_dot_;
    RCP<Thyra::VectorBase<Scalar> > dx_;
    Scalar t_;
    Scalar t_old_;
    Scalar dt_;
    int numSteps_;
    int newtonConvergenceStatus_;
    bool isInitialized_;
    bool haveInitialCondition_;
    RCP<Teuchos::ParameterList> parameterList_;
    Thyra::ModelEvaluatorBase::InArgs<Scalar> basePoint_;
    RCP<Rythmos::SingleResidualModelEvaluator<Scalar> >  neModel_;
    RCP<InterpolatorBase<Scalar> > interpolator_;
    RCP<StepControlStrategyBase<Scalar> > stepControl_;

};


/** \brief Simple concrete stepper subclass implementing an implicit backward
 * Euler method.
 *
 * This class exists primarily as a simple example of an implicit time stepper
 * and as a vehicle for experimentation.  The <tt>ImplicitBDFStepper</tt> also
 * implements backward Euler and is a more powerful stepper class.  This class
 * does not implement a local truncation error test and therefore also does
 * not handle the automatic step size selection.  Therefore, if you need these
 * features, you should really use the <tt>ImplicitBDFStepper</tt> class.
 */
template<class Scalar>
class BackwardEulerStepper :
  virtual public SolverAcceptingStepperBase<Scalar>,
  virtual public StepControlStrategyAcceptingStepperBase<Scalar>,
  virtual public InterpolatorAcceptingObjectBase<Scalar>
{
public:

  /** \brief . */
  typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType ScalarMag;

  /** \name Constructors, initializers, Misc. */
  //@{

  /** \brief . */
  BackwardEulerStepper();

  /** \brief . */
  BackwardEulerStepper(
    const RCP<Thyra::ModelEvaluator<Scalar> >& model,
    const RCP<Thyra::NonlinearSolverBase<Scalar> >& solver
    );

  //@}

  /** \name Overridden from InterpolatorAcceptingObjectBase */
  //@{

  /** \brief . */
  void setInterpolator(const RCP<InterpolatorBase<Scalar> >& interpolator);

  /** \brief . */
  RCP<InterpolatorBase<Scalar> > getNonconstInterpolator();

  /** \brief . */
  RCP<const InterpolatorBase<Scalar> > getInterpolator() const;

  /** \brief . */
  RCP<InterpolatorBase<Scalar> > unSetInterpolator();

  //@}

  /** \name Overridden from StepControlStrategyAcceptingStepperBase */
  //@{

  /** \brief . */
  void setStepControlStrategy(
      const RCP<StepControlStrategyBase<Scalar> >& stepControlStrategy
      );

  /** \brief . */
  RCP<StepControlStrategyBase<Scalar> >
    getNonconstStepControlStrategy();

  /** \brief . */
  RCP<const StepControlStrategyBase<Scalar> >
    getStepControlStrategy() const;

  //@}

  /** \name Overridden from SolverAcceptingStepperBase */
  //@{

  /** \brief . */
  void setSolver(
    const RCP<Thyra::NonlinearSolverBase<Scalar> > &solver
    );

  /** \brief . */
  RCP<Thyra::NonlinearSolverBase<Scalar> >
  getNonconstSolver();

  /** \brief . */
  RCP<const Thyra::NonlinearSolverBase<Scalar> >
  getSolver() const;

  //@}

  /** \name Overridden from StepperBase */
  //@{

  /** \brief Returns true. */
  bool supportsCloning() const;

  /** \brief Creates copies of all internal data (including the parameter
   * list) except the model which is assumed to stateless.
   *
   * If a shallow copy of the model is not appropirate for some reasone, then
   * the client can simply reset the model using
   * <tt>returnVal->setModel()</tt>.
   */
  RCP<StepperBase<Scalar> > cloneStepperAlgorithm() const;

  /** \brief . */
  bool isImplicit() const;

  /** \brief . */
  void setModel(const RCP<const Thyra::ModelEvaluator<Scalar> >& model);

  /** \brief . */
  void setNonconstModel(const RCP<Thyra::ModelEvaluator<Scalar> >& model);

  /** \brief . */
  RCP<const Thyra::ModelEvaluator<Scalar> > getModel() const;

  /** \brief . */
  RCP<Thyra::ModelEvaluator<Scalar> > getNonconstModel();

  /** \brief . */
  void setInitialCondition(
    const Thyra::ModelEvaluatorBase::InArgs<Scalar> &initialCondition
    );

  /** \brief . */
  Thyra::ModelEvaluatorBase::InArgs<Scalar> getInitialCondition() const;

  /** \brief . */
  Scalar takeStep(Scalar dt, StepSizeType flag);

  /** \brief . */
  const StepStatus<Scalar> getStepStatus() const;

  //@}

  /** \name Overridden from InterpolationBufferBase */
  //@{

  /** \brief . */
  RCP<const Thyra::VectorSpaceBase<Scalar> >
  get_x_space() const;

  /** \brief . */
  void addPoints(
    const Array<Scalar>& time_vec,
    const Array<RCP<const Thyra::VectorBase<Scalar> > >& x_vec,
    const Array<RCP<const Thyra::VectorBase<Scalar> > >& xdot_vec
    );

  /** \brief . */
  TimeRange<Scalar> getTimeRange() const;

  /** \brief . */
  void getPoints(
    const Array<Scalar>& time_vec,
    Array<RCP<const Thyra::VectorBase<Scalar> > >* x_vec,
    Array<RCP<const Thyra::VectorBase<Scalar> > >* xdot_vec,
    Array<ScalarMag>* accuracy_vec
    ) const;

  /** \brief . */
  void getNodes(Array<Scalar>* time_vec) const;

  /** \brief . */
  void removeNodes(Array<Scalar>& time_vec);

  /** \brief . */
  int getOrder() const;

  //@}

  /** \name Overridden from Teuchos::ParameterListAcceptor */
  //@{

  /** \brief . */
  void setParameterList(RCP<Teuchos::ParameterList> const& paramList);

  /** \brief . */
  RCP<Teuchos::ParameterList> getNonconstParameterList();

  /** \brief . */
  RCP<Teuchos::ParameterList> unsetParameterList();

  /** \brief. */
  RCP<const Teuchos::ParameterList> getValidParameters() const;

  //@}

  /** \name Overridden from Teuchos::Describable */
  //@{

  /** \brief . */
  void describe(
    Teuchos::FancyOStream  &out,
    const Teuchos::EVerbosityLevel verbLevel
    ) const;

  //@}

  /** \name Momento functions. */
  //@{

  /** \brief Get momento object for use in restarts
  *
  */
  RCP<const MomentoBase<Scalar> > getMomento() const;

  /** \brief Set momento object for use in restarts
  */
  void setMomento(
      const Ptr<const MomentoBase<Scalar> >& momentoPtr,
      const RCP<Thyra::ModelEvaluator<Scalar> >& model,
      const RCP<Thyra::NonlinearSolverBase<Scalar> >& solver
      );

  //@}


private:

  // ///////////////////////
  // Private date members

  bool isInitialized_;
  bool haveInitialCondition_;
  RCP<const Thyra::ModelEvaluator<Scalar> > model_;
  RCP<Thyra::NonlinearSolverBase<Scalar> > solver_;
  RCP<Thyra::VectorBase<Scalar> > x_old_;
  RCP<Thyra::VectorBase<Scalar> > scaled_x_old_;
  RCP<Thyra::VectorBase<Scalar> > x_dot_old_;

  Thyra::ModelEvaluatorBase::InArgs<Scalar> basePoint_;
  RCP<Thyra::VectorBase<Scalar> > x_;
  RCP<Thyra::VectorBase<Scalar> > x_dot_;
  RCP<Thyra::VectorBase<Scalar> > dx_;
  Scalar t_;
  Scalar t_old_;

  Scalar dt_;
  int numSteps_;

  RCP<Rythmos::SingleResidualModelEvaluator<Scalar> >  neModel_;

  RCP<Teuchos::ParameterList> parameterList_;

  RCP<InterpolatorBase<Scalar> > interpolator_;
  RCP<StepControlStrategyBase<Scalar> > stepControl_;

  int newtonConvergenceStatus_;


  // //////////////////////////
  // Private member functions

  void defaultInitializeAll_();
  void initialize_();
  void checkConsistentState_();
  void obtainPredictor_();

};


/** \brief Nonmember constructor.
 *
 * \relates BackwardEulerStepper
 */
template<class Scalar>
RCP<BackwardEulerStepper<Scalar> >
backwardEulerStepper();


/** \brief Nonmember constructor.
 *
 * \relates BackwardEulerStepper
 */
template<class Scalar>
RCP<BackwardEulerStepper<Scalar> >
backwardEulerStepper(
  const RCP<Thyra::ModelEvaluator<Scalar> >& model,
  const RCP<Thyra::NonlinearSolverBase<Scalar> >& solver
  );


} // namespace Rythmos


#endif //Rythmos_BACKWARD_EULER_STEPPER_DECL_H