NhsContractionModel.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 NHSCONTRACTIONMODEL_HPP_
#define NHSCONTRACTIONMODEL_HPP_

#include "AbstractOdeBasedContractionModel.hpp"
#include "Exception.hpp"


class NhsContractionModel  : public AbstractOdeBasedContractionModel
{
friend class TestContractionModels;

protected :
    double mLambda;
    double mDLambdaDt;
    double mCalciumI;


    double mCalciumTrop50;

    double mK1;
    double mK2;

    // Parameters

    static const double mKon;

    static const double mKrefoff;

    static const double mGamma;

    static const double mCalciumTroponinMax;

    static const double mAlphaR1;

    static const double mAlphaR2;

    static const double mKZ;

    static const unsigned mNr;

    static const double mBeta1;

    static const double mAlpha0;

    static const unsigned mN;

    static const double mZp;

    static const double mCalcium50ref;

    static const double mTref;

    static const double mBeta0;

    static const double mA;

    static const double mA1;

    static const double mA2;

    static const double mA3;

    static const double mAlpha1;

    static const double mAlpha2;

    static const double mAlpha3;

    void CalculateCalciumTrop50();

    double CalculateT0(double z);

public :
    NhsContractionModel();

    void SetStretchAndStretchRate(double lambda, double dlambdaDt);

    void SetInputParameters(ContractionModelInputParameters& rInputParameters);

    void SetIntracellularCalciumConcentration(double calciumConcentration);

    double GetCalciumTroponinValue();

    void EvaluateYDerivatives(double time, const std::vector<double> &rY, std::vector<double> &rDY);

    double GetActiveTension();

    double GetNextActiveTension()
    {
        EXCEPTION("If using this in an 'explicit manner' call UpdateStateVariables() and then GetActiveTension(), otherwise use NhsModelWithBackwardSolver");
    }

    bool IsStretchDependent()
    {
        return true;
    }

    bool IsStretchRateDependent()
    {
        return true;
    }
};
#endif /*NHSCONTRACTIONMODEL_HPP_*/