Rythmos - Transient Integration for Differential Equations  Version of the Day
 All Classes Functions Variables Typedefs Pages
Rythmos_StepControlStrategyAcceptingStepperBase.hpp
1 //@HEADER
2 // ***********************************************************************
3 //
4 // Rythmos Package
5 // Copyright (2006) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // This library is free software; you can redistribute it and/or modify
11 // it under the terms of the GNU Lesser General Public License as
12 // published by the Free Software Foundation; either version 2.1 of the
13 // License, or (at your option) any later version.
14 //
15 // This library is distributed in the hope that it will be useful, but
16 // WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 // Lesser General Public License for more details.
19 //
20 // You should have received a copy of the GNU Lesser General Public
21 // License along with this library; if not, write to the Free Software
22 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
23 // USA
24 // Questions? Contact Todd S. Coffey (tscoffe@sandia.gov)
25 //
26 // ***********************************************************************
27 //@HEADER
28 
29 
30 #ifndef RYTHMOS_STEP_CONTROL_STRATEGY_ACCEPTING_STEPPER_BASE_HPP
31 #define RYTHMOS_STEP_CONTROL_STRATEGY_ACCEPTING_STEPPER_BASE_HPP
32 
33 
34 #include "Rythmos_StepperBase.hpp"
35 #include "Rythmos_StepControlStrategyBase.hpp"
36 
37 namespace Rythmos {
38 
39 
47 template<class Scalar>
49 {
50 public:
51 
53  virtual void setStepControlStrategy(
54  const Teuchos::RCP<StepControlStrategyBase<Scalar> >& stepControlStrategy
55  ) = 0;
56 
58  virtual Teuchos::RCP<StepControlStrategyBase<Scalar> >
60 
62  virtual Teuchos::RCP<const StepControlStrategyBase<Scalar> >
63  getStepControlStrategy() const = 0;
64 
65 };
66 
67 
68 } // namespace Rythmos
69 
70 
71 #endif // RYTHMOS_STEP_CONTROL_STRATEGY_ACCEPTING_STEPPER_BASE_HPP
Mix-in interface for stepper objects that accept a step control strategy object to be used for evalua...
Base class for defining stepper functionality.
virtual Teuchos::RCP< const StepControlStrategyBase< Scalar > > getStepControlStrategy() const =0
The member functions in the StepControlStrategyBase move you between these states in the following fa...
virtual Teuchos::RCP< StepControlStrategyBase< Scalar > > getNonconstStepControlStrategy()=0
virtual void setStepControlStrategy(const Teuchos::RCP< StepControlStrategyBase< Scalar > > &stepControlStrategy)=0