AbstractGeneralizedRushLarsenCardiacCell.hpp

/*

Copyright (c) 2005-2017, 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.

*/

#ifndef ABSTRACTGENERALIZEDRUSHLARSENCARDIACCELL_HPP_
#define ABSTRACTGENERALIZEDRUSHLARSENCARDIACCELL_HPP_

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

/*
Megan E. Marsh, Raymond J. Spiteri
Numerical Simulation Laboratory
University of Saskatchewan
December 2011
Partial support provided by research grants from the National
Science and Engineering Research Council (NSERC) of Canada
and the MITACS/Mprime Canadian Network of Centres of Excellence.
*/

class AbstractGeneralizedRushLarsenCardiacCell : public AbstractCardiacCell
{
private:
    friend class boost::serialization::access;
    template<class Archive>
    void serialize(Archive & archive, const unsigned int version)
    {
        // This calls serialize on the base class.
        archive & boost::serialization::base_object<AbstractCardiacCell>(*this);
    }

public:
    AbstractGeneralizedRushLarsenCardiacCell(
            unsigned numberOfStateVariables,
            unsigned voltageIndex,
            boost::shared_ptr<AbstractStimulusFunction> pIntracellularStimulus);

    virtual ~AbstractGeneralizedRushLarsenCardiacCell();

    OdeSolution Compute(double tStart, double tEnd, double tSamp=0.0);

    void ComputeExceptVoltage(double tStart, double tEnd);

    void SolveAndUpdateState(double tStart, double tEnd);


    bool HasAnalyticJacobian() const;

    void ForceUseOfNumericalJacobian(bool useNumericalJacobian = true);


private:
// LCOV_EXCL_START
    void EvaluateYDerivatives(double time, const std::vector<double>& rY, std::vector<double>& rDY)
    {
        NEVER_REACHED;
    }
// LCOV_EXCL_STOP

protected:
    virtual void ComputeOneStepExceptVoltage(double time)=0;

    virtual void UpdateTransmembranePotential(double time)=0;

    std::vector<double> mPartialF;

    std::vector<double> mEvalF;

    std::vector<double> mYInit;

    bool mHasAnalyticJacobian;
};

CLASS_IS_ABSTRACT(AbstractGeneralizedRushLarsenCardiacCell)

#endif // ABSTRACTGENERALIZEDRUSHLARSENCARDIACCELL_HPP_