RungeKuttaFehlbergIvpOdeSolver.hpp

/*

Copyright (C) University of Oxford, 2005-2009

University of Oxford means the Chancellor, Masters and Scholars of the
University of Oxford, having an administrative office at Wellington
Square, Oxford OX1 2JD, UK.

This file is part of Chaste.

Chaste 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.

Chaste 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. The offer of Chaste under the terms of the
License is subject to the License being interpreted in accordance with
English Law and subject to any action against the University of Oxford
being under the jurisdiction of the English Courts.

You should have received a copy of the GNU Lesser General Public License
along with Chaste. If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef _RUNGEKUTTAFEHLBERGIVPODESOLVER_HPP_
#define _RUNGEKUTTAFEHLBERGIVPODESOLVER_HPP_

#include <boost/serialization/access.hpp>
#include <boost/serialization/base_object.hpp>

#include "AbstractOneStepIvpOdeSolver.hpp"

// Needs to be included last
#include <boost/serialization/export.hpp>

class RungeKuttaFehlbergIvpOdeSolver : public AbstractIvpOdeSolver
{
friend class TestRungeKuttaFehlbergIvpOdeSolver;

private:
    friend class boost::serialization::access;
    template<class Archive>
    void serialize(Archive & archive, const unsigned int version)
    {
        // This calls serialize on the base class - all member variables instantiated on construction or temporary.
        archive & boost::serialization::base_object<AbstractIvpOdeSolver>(*this);
    }

    /*
     * All these are here for more efficient memory allocation, rather than
     * because they need to be member variables.
     */

    double m1932o2197;  
    double m7200o2197;  
    double m7296o2197;  
    double m12o13;      
    double m439o216;    
    double m3680o513;   
    double m845o4104;   
    double m8o27;       
    double m3544o2565;  
    double m1859o4104;  
    double m1o360;      
    double m128o4275;   
    double m2197o75240; 
    double m2o55;       
    double m25o216;     
    double m1408o2565;  
    double m2197o4104;  
    std::vector<double> mError; 
    std::vector<double> mk1;  
    std::vector<double> mk2;  
    std::vector<double> mk3;  
    std::vector<double> mk4;  
    std::vector<double> mk5;  
    std::vector<double> mk6;  
    std::vector<double> myk2; 
    std::vector<double> myk3; 
    std::vector<double> myk4; 
    std::vector<double> myk5; 
    std::vector<double> myk6; 
protected:

    void InternalSolve(OdeSolution& rSolution,
                       AbstractOdeSystem* pAbstractOdeSystem,
                       std::vector<double>& rCurrentYValues,
                       std::vector<double>& rWorkingMemory,
                       double startTime,
                       double endTime,
                       double maxTimeStep,
                       double minTimeStep,
                       double tolerance,
                       bool outputSolution);

    void CalculateNextYValue(AbstractOdeSystem* pAbstractOdeSystem,
                             double timeStep,
                             double time,
                             std::vector<double>& rCurrentYValues,
                             std::vector<double>& rNextYValues);

    void AdjustStepSize(double& rCurrentStepSize,
                        const double& rError,
                        const double& rTolerance,
                        const double& rMaxTimeStep,
                        const double& rMinTimeStep);

public:

    RungeKuttaFehlbergIvpOdeSolver();

    OdeSolution Solve(AbstractOdeSystem* pAbstractOdeSystem,
                      std::vector<double>& rYValues,
                      double startTime,
                      double endTime,
                      double timeStep,
                      double ignoredSamplingTime);

    void Solve(AbstractOdeSystem* pAbstractOdeSystem,
               std::vector<double>& rYValues,
               double startTime,
               double endTime,
               double timeStep);

};

BOOST_CLASS_EXPORT(RungeKuttaFehlbergIvpOdeSolver);

#endif //_RUNGEKUTTAFEHLBERGIVPODESOLVER_HPP_

---