TimeStepper.hpp

/*

Copyright (C) University of Oxford, 2005-2011

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 TIMESTEPPER_HPP_
#define TIMESTEPPER_HPP_

#include <vector>
#include <climits>
#include <boost/serialization/vector.hpp>

#include "ChasteSerialization.hpp"
#include "Exception.hpp"

class TimeStepper
{
    friend class TestTimeStepper;
private:
    /*
     * Private default constructor for archiving
     */
     TimeStepper(){};

public:

    TimeStepper(double startTime, double endTime, double dt, bool enforceConstantTimeStep=false, std::vector<double> additionalTimes=std::vector<double> ());

    void AdvanceOneTimeStep();

    double GetTime() const;

    double GetNextTime() const;

    double GetNextTimeStep();

    double GetIdealTimeStep();

    bool IsTimeAtEnd() const;

    unsigned EstimateTimeSteps() const;

    unsigned GetTotalTimeStepsTaken() const;

    void ResetTimeStep(double dt);

private:

    double mStart;

    double mEnd;

    double mDt;

    unsigned mTotalTimeStepsTaken;

    unsigned mAdditionalTimesReached;

    double mTime;

    double mNextTime;

    double mEpsilon;

    double CalculateNextTime();

    std::vector<double> mAdditionalTimes;

    friend class boost::serialization::access;

    template<class Archive>
    void serialize(Archive & archive, const unsigned int version)
    {
        archive & mStart;
        archive & mEnd;
        archive & mDt;
        archive & mTotalTimeStepsTaken;
        archive & mTime;
        archive & mNextTime;
        archive & mEpsilon;
        archive & mAdditionalTimesReached;
        archive & mAdditionalTimes;
    }

};

#include "SerializationExportWrapper.hpp"
// Declare identifier for the serializer
CHASTE_CLASS_EXPORT(TimeStepper)

#endif /*TIMESTEPPER_HPP_*/