BackwardEulerLuoRudyIModel1991.hpp

/*

Copyright (C) University of Oxford, 2005-2010

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

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

#include "AbstractStimulusFunction.hpp"
#include "AbstractBackwardEulerCardiacCell.hpp"

#include <vector>

class BackwardEulerLuoRudyIModel1991 : public AbstractBackwardEulerCardiacCell<1>
{
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<AbstractBackwardEulerCardiacCell<1> >(*this);
    }
    /*
     * Constants for the LuoRudyIModel1991OdeSystem model
     */
    static const double membrane_C; 
    static const double membrane_F; 
    static const double membrane_R; 
    static const double membrane_T; 
    static const double background_current_E_b; 
    static const double background_current_g_b; 
    static const double fast_sodium_current_g_Na; 
    static const double ionic_concentrations_Ki; 
    static const double ionic_concentrations_Ko; 
    static const double ionic_concentrations_Nai; 
    static const double ionic_concentrations_Nao; 
    static const double plateau_potassium_current_g_Kp; 
    static const double time_dependent_potassium_current_PR_NaK; 
    double fast_sodium_current_E_Na;


public:
    BackwardEulerLuoRudyIModel1991(boost::shared_ptr<AbstractStimulusFunction> pIntracellularStimulus);

    BackwardEulerLuoRudyIModel1991(boost::shared_ptr<AbstractIvpOdeSolver> /* unused */,
                                   boost::shared_ptr<AbstractStimulusFunction> pIntracellularStimulus);

    ~BackwardEulerLuoRudyIModel1991();

    void Init();

protected:
    void ComputeOneStepExceptVoltage(double tStart);

    void UpdateTransmembranePotential(double time);

public:
    void ComputeResidual(double var_environment__time, const double rCurrentGuess[1], double rResidual[1]);

    void ComputeJacobian(double var_environment__time, const double rCurrentGuess[1], double rJacobian[1][1]);

    double GetIIonic();

    void VerifyStateVariables();

    double GetIntracellularCalciumConcentration();
};

#include "SerializationExportWrapper.hpp"
CHASTE_CLASS_EXPORT(BackwardEulerLuoRudyIModel1991)

namespace boost
{
namespace serialization
{
template<class Archive>
inline void save_construct_data(
    Archive & ar, const BackwardEulerLuoRudyIModel1991 * t, const unsigned int file_version)
{
    const boost::shared_ptr<AbstractIvpOdeSolver> p_solver = t->GetSolver();
    const boost::shared_ptr<AbstractStimulusFunction> p_stimulus = t->GetStimulusFunction();
    ar << p_solver;
    ar << p_stimulus;
}

template<class Archive>
inline void load_construct_data(
    Archive & ar, BackwardEulerLuoRudyIModel1991 * t, const unsigned int file_version)
{
    boost::shared_ptr<AbstractIvpOdeSolver> p_solver;
    boost::shared_ptr<AbstractStimulusFunction> p_stimulus;
    ar >> p_solver;
    ar >> p_stimulus;
    ::new(t)BackwardEulerLuoRudyIModel1991(p_solver, p_stimulus);
}
}
} // namespace ...

#endif // _BACKWARDEULERLUORUDYIMODEL1991_HPP_