CvodeAdaptor.hpp

/*

Copyright (c) 2005-2018, University of Oxford.
All rights reserved.

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.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 * Neither the name of the University of Oxford nor the names of its
   contributors may be used to endorse or promote products derived from this
   software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/

#ifdef CHASTE_CVODE
#ifndef _CVODEADAPTOR_HPP_
#define _CVODEADAPTOR_HPP_

#include <vector>

#include <boost/serialization/base_object.hpp>
#include "ChasteSerialization.hpp"

#include "AbstractIvpOdeSolver.hpp"
#include "OdeSolution.hpp"

// CVODE headers
#include <cvode/cvode.h>
#include <nvector/nvector_serial.h>

#if CHASTE_SUNDIALS_VERSION >= 30000
#include <sunlinsol/sunlinsol_dense.h> /* access to dense SUNLinearSolver      */
#include <sunmatrix/sunmatrix_dense.h> /* access to dense SUNMatrix            */
#endif

void CvodeErrorHandler(int errorCode, const char* module, const char* function,
                       char* message, void* pData);
// Note: declared here since it's also used by AbstractCvodeCell.

typedef struct CvodeData_
{
    std::vector<realtype>* pY;
    AbstractOdeSystem* pSystem;
} CvodeData;

class CvodeAdaptor : public AbstractIvpOdeSolver
{
private:
    friend class boost::serialization::access;
    template <class Archive>
    void serialize(Archive& archive, const unsigned int version)
    {
        archive& boost::serialization::base_object<AbstractIvpOdeSolver>(*this);
        archive& mRelTol;
        archive& mAbsTol;
        archive& mLastInternalStepSize;
        archive& mMaxSteps;
        archive& mCheckForRoots;
        // All other member variables given values on each call.
    }

    void* mpCvodeMem;

    CvodeData mData;

    double mRelTol;

    double mAbsTol;

    double mLastInternalStepSize;

    long int mMaxSteps;

    bool mCheckForRoots;

    N_Vector mLastSolutionState;

    double mLastSolutionTime;

    bool mForceReset;

    bool mForceMinimalReset;

#if CHASTE_SUNDIALS_VERSION >= 30000

    SUNMatrix mpSundialsDenseMatrix;
    SUNLinearSolver mpSundialsLinearSolver;
#endif

    void RecordStoppingPoint(double stopTime, N_Vector yEnd);

protected:
    void SetupCvode(AbstractOdeSystem* pOdeSystem,
                    std::vector<double>& rInitialY,
                    double startTime, double maxStep);

    void FreeCvodeMemory();

    void CvodeError(int flag, const char* msg);

public:
    CvodeAdaptor(double relTol = 1e-4, double absTol = 1e-6);

    ~CvodeAdaptor();

    void SetTolerances(double relTol = 1e-4, double absTol = 1e-6);

    double GetRelativeTolerance();

    double GetAbsoluteTolerance();

    double GetLastStepSize();

    void SetForceReset(bool autoReset);

    void SetMinimalReset(bool minimalReset);

    void ResetSolver();

    OdeSolution Solve(AbstractOdeSystem* pOdeSystem,
                      std::vector<double>& rYValues,
                      double startTime,
                      double endTime,
                      double maxStep,
                      double timeSampling);

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

    void CheckForStoppingEvents();

    void SetMaxSteps(long int numSteps);

    long int GetMaxSteps();
};

#include "SerializationExportWrapper.hpp"
CHASTE_CLASS_EXPORT(CvodeAdaptor)

#endif // _CVODEADAPTOR_HPP_
#endif // CHASTE_CVODE