Rythmos_DefaultIntegrator_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_DEFAULT_INTEGRATOR_DECL_HPP
#define RYTHMOS_DEFAULT_INTEGRATOR_DECL_HPP
 
 
#include "Rythmos_IntegrationControlStrategyAcceptingIntegratorBase.hpp"
#include "Rythmos_InterpolationBufferAppenderAcceptingIntegratorBase.hpp"
#include "Rythmos_TrailingInterpolationBufferAcceptingIntegratorBase.hpp"
#include "Rythmos_IntegrationObserverBase.hpp"
#include "Rythmos_StepControlInfo.hpp"
#include "Teuchos_ParameterListAcceptorDefaultBase.hpp"
 
 
 
 
namespace Rythmos {
 
 
template<class Scalar>
class DefaultIntegrator
  : virtual public IntegrationControlStrategyAcceptingIntegratorBase<Scalar>,
    virtual public InterpolationBufferAppenderAcceptingIntegratorBase<Scalar>,
    virtual public TrailingInterpolationBufferAcceptingIntegratorBase<Scalar>,
    virtual public Teuchos::ParameterListAcceptorDefaultBase
{
public:
 
  typedef typename ScalarTraits<Scalar>::magnitudeType ScalarMag;
 
 
  DefaultIntegrator();
 
  void setIntegrationObserver(
    const RCP<IntegrationObserverBase<Scalar> > &integrationObserver
    );
 
 
  void setInterpolationBufferAppender(
    const RCP<InterpolationBufferAppenderBase<Scalar> > &interpBufferAppender
    );
 
  RCP<const InterpolationBufferAppenderBase<Scalar> >
    getInterpolationBufferAppender();
 
  RCP<InterpolationBufferAppenderBase<Scalar> >
    getNonconstInterpolationBufferAppender();
 
  RCP<InterpolationBufferAppenderBase<Scalar> >
    unSetInterpolationBufferAppender();
 
 
 
  void setIntegrationControlStrategy(
    const RCP<IntegrationControlStrategyBase<Scalar> > &integrationControlStrategy
    );
 
  RCP<IntegrationControlStrategyBase<Scalar> >
    getNonconstIntegrationControlStrategy();
 
  RCP<const IntegrationControlStrategyBase<Scalar> >
    getIntegrationControlStrategy() const;
 
 
 
  void setParameterList(RCP<ParameterList> const& paramList);
 
  RCP<const ParameterList> getValidParameters() const;
 
 
 
  RCP<IntegratorBase<Scalar> > cloneIntegrator() const;
 
  void setStepper(
    const RCP<StepperBase<Scalar> > &stepper,
    const Scalar &finalTime,
    const bool landOnFinalTime = true
    );
 
  RCP<StepperBase<Scalar> > unSetStepper();
 
  RCP<const StepperBase<Scalar> > getStepper() const;
 
  RCP<StepperBase<Scalar> > getNonconstStepper() const;
 
 
  void setTrailingInterpolationBuffer(
    const RCP<InterpolationBufferBase<Scalar> > &trailingInterpBuffer
    );
 
  RCP<InterpolationBufferBase<Scalar> >
    getNonconstTrailingInterpolationBuffer();
 
  RCP<const InterpolationBufferBase<Scalar> >
    getTrailingInterpolationBuffer() const;
 
  RCP<InterpolationBufferBase<Scalar> >
    unSetTrailingInterpolationBuffer();
 
 
  void getFwdPoints(
    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
    );
 
  TimeRange<Scalar> getFwdTimeRange() const;
 
 
 
  RCP<const Thyra::VectorSpaceBase<Scalar> > get_x_space() const;
 
  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
    );
 
  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;
 
  TimeRange<Scalar> getTimeRange() const;
 
  void getNodes(Array<Scalar>* time_vec) const;
 
  void removeNodes(Array<Scalar>& time_vec);
 
  int getOrder() const;
 
 
private:
 
  // ////////////////////////
  // Private data members
 
  RCP<IntegrationControlStrategyBase<Scalar> > integrationControlStrategy_;
  RCP<IntegrationObserverBase<Scalar> > integrationObserver_;
 
  RCP<InterpolationBufferBase<Scalar> > trailingInterpBuffer_;
  RCP<InterpolationBufferAppenderBase<Scalar> > interpBufferAppender_;
 
  RCP<StepperBase<Scalar> > stepper_;
  TimeRange<Scalar> integrationTimeDomain_;
  bool landOnFinalTime_;
 
  int maxNumTimeSteps_;
 
  int currTimeStepIndex_;
  StepControlInfo<Scalar> stepCtrlInfoLast_;
 
  static const std::string maxNumTimeSteps_name_;
  static const int maxNumTimeSteps_default_;
 
  // /////////////////////////
  // Private member functions
 
  void finalizeSetup();
 
  bool advanceStepperToTime( const Scalar& t );
 
};
 
 
template<class Scalar>
RCP<DefaultIntegrator<Scalar> >
defaultIntegrator();
 
 
template<class Scalar>
RCP<DefaultIntegrator<Scalar> >
defaultIntegrator(
  const RCP<IntegrationControlStrategyBase<Scalar> > &integrationControlStrategy,
  const RCP<IntegrationObserverBase<Scalar> > &integrationObserver
  );
 
 
template<class Scalar>
RCP<DefaultIntegrator<Scalar> >
controlledDefaultIntegrator(
  const RCP<IntegrationControlStrategyBase<Scalar> > &integrationControlStrategy
  );
 
 
template<class Scalar>
RCP<DefaultIntegrator<Scalar> >
observedDefaultIntegrator(
  const RCP<IntegrationObserverBase<Scalar> > &integrationObserver
  );
 
// 2007/08/30: rabartl: Above, note that I had to name the nonmember
// constructors taking an single RCP argument different names from each other
// in order to get around the classic ambiguity problem with implicit
// conversions of smart pointers.
 
 
} // namespace Rythmos
 
 
#endif //RYTHMOS_DEFAULT_INTEGRATOR_DECL_HPP