AnimaL

Tutorial

Documentation

---

Documentation

• Overview
• Modules
• Namespace List
• Class Hierarchy
• Alphabetical List
• Compound List
• File List
• Namespace Members
• Compound Members
• File Members
• Examples

---

stepper.h

Go to the documentation of this file.

#ifndef ANIMAL_INTEGRATION_STEPPER_H
#define ANIMAL_INTEGRATION_STEPPER_H

#include <animal/integration/solver.h>



namespace animal { namespace integration {

// ----------------------------------
//  
//  Stepper class.
//  
// ----------------------------------

template <
  class SolverF,
  class HSmallerF,
  class HLargerF,
  class IsDifferentF >

struct Stepper_Function
{
  typedef typename SolverF::Real       Real;        
  typedef typename SolverF::Model      Model;       
  typedef typename SolverF::State      State;       
  typedef typename SolverF::Derivative Derivative;  
  
  SolverF      solve;         
  HSmallerF    hsmaller;      
  HLargerF     hlarger;       
  IsDifferentF isDifferent;   
  
  Stepper_Function()
    {}
  
  Stepper_Function(const SolverF& slf,
           const HSmallerF& hsf, const HLargerF& hlf,
           const IsDifferentF& isdf)
  : solve(slf),
    hsmaller(hsf), hlarger(hlf),
    isDifferent(isdf)
    {}
  
  void operator()(const Model& M,
          State& S,
          const Real t,
          const Real htry, Real& hdid, Real& hnext);
  void operator()(const Model& M,
          const State& initial_S,
          State& final_S,
          const Real t,
          const Real htry, Real& hdid, Real& hnext);
};



template <class TraitsT>

struct HSmaller_Function
{
  typedef typename TraitsT::Real     Real;      
  typedef typename TraitsT::Model    Model;     
  typedef typename TraitsT::State    State;     
  typedef typename TraitsT::Numerics Numerics;  
  
  Real hmin(const Model& M,
          const State& S,
          const Real t) const;
  
  Real operator()(const Model& M,
            const State& S,
            const Real t, const Real h) const;
};



template <class TraitsT>

struct HLarger_Function
{
  typedef typename TraitsT::Real     Real;       
  typedef typename TraitsT::Model    Model;      
  typedef typename TraitsT::State    State;      
  typedef typename TraitsT::Numerics Numerics;   
  
  Real hmax(const Model& M,
          const State& S,
          const Real t) const;
  
  Real operator()(const Model& M,
            const State& S,
            const Real t, const Real h) const;
};



template <class TraitsT>

struct IsDifferent_Function
{
  typedef typename TraitsT::Real       Real;        
  typedef typename TraitsT::Model      Model;       
  typedef typename TraitsT::State      State;       
  typedef typename TraitsT::Derivative Derivative;  
  typedef typename TraitsT::Numerics   Numerics;    
  
  Real errormax(const Model& M,
          const State& S,
          const Real t) const;
  

  bool operator()(const Model& M,
          const State& S1, const State& S2,
          const Real t) const;
  
  bool operator()(const Model& M,
          const State& S,
          const Real t) const;
};

} } // namespace animal { namespace integration {



#endif // ANIMAL_INTEGRATION_STEPPER_H

---