NhsContractionModel.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.

*/
#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_*/