ORdmD16.hpp

Go to the documentation of this file.

/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   This file is part of CEPS.
 
   CEPS is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
 
   CEPS 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 General Public License for more details.
 
   You should have received a copy of the GNU General Public License
   along with CEPS (see file LICENSE at root of project).
   If not, see <https://www.gnu.org/licenses/>.
 
 
   Copyright 2019-2024 Inria, Universite de Bordeaux
 
   Authors, in alphabetical order:
 
     Pierre-Elliott BECUE, Florian CARO, Yves COUDIERE(*), Andjela DAVIDOVIC, 
     Charlie DOUANLA-LONTSI, Marc FUENTES, Mehdi JUHOOR, Michael LEGUEBE(*), 
     Pauline MIGERDITICHAN, Valentin PANNETIER(*), Nejib ZEMZEMI.
     * : currently active authors
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
#pragma once
 
#include "ode/ionicModels/AbstractIonicModel.hpp"
#include "pde/problem/AbstractPdeProblem.hpp"
 
class ORdmD16 : public AbstractIonicModel
{ 
 
  public:
 
    enum class Type
    {
      Endo,   
      MidMyo, 
      Epi     
    };
 
    ORdmD16(
      const Type&                   type,
      Unknown*                      u, 
      const CepsSet<CepsAttribute>& attrs={},
      InputParameters*              params=nullptr
    );
 
    ~ORdmD16() = default;
 
    void 
    getInitialCondition(CepsReal* v, CepsReal* y) const final;
 
    void 
    computeRates(
      CepsReal         t,
      CepsReal*        y, 
      CepsReal*        v, 
      CepsReal*        dtyL, 
      CepsReal*        dtyNL,
      CepsReal*        dtv, 
      DegreeOfFreedom* dof
    ) const override;
 
 
  protected: 
 
    void
    setupWithParameters(InputParameters* p);
 
    void
    computeINa(
      CepsReal* INa, CepsReal* iNaL, CepsReal v, CepsReal* y, 
      CepsReal* dtyLin, CepsReal* dtyNLin, CepsReal fraction
    ) const;
 
    void
    computeIto(
      CepsReal* Ito, CepsReal v, CepsReal* y, 
      CepsReal* dtyLin, CepsReal* dtyNLin, CepsReal fraction
    ) const;
 
    void
    computeICa(
      CepsReal* ICaL, CepsReal* ICaNa, CepsReal* ICaK, CepsReal v, CepsReal* y, 
      CepsReal* dtyLin, CepsReal* dtyNLin, CepsReal fraction
    ) const;
 
    void
    computeIKr(CepsReal* IKr, CepsReal v, CepsReal* y, CepsReal* dtyLin, CepsReal* dtyNLin) const;
 
    void
    computeIKs(CepsReal* IKs, CepsReal v, CepsReal* y, CepsReal* dtyLin, CepsReal* dtyNLin) const;
 
    void
    computeIK1(CepsReal* IK1, CepsReal v, CepsReal* y, CepsReal* dtyLin, CepsReal* dtyNLin) const;
 
    void
    computeINaCa(CepsReal* INaCa_i, CepsReal* INaCa_ss, CepsReal v, CepsReal* y) const;
 
    CepsReal
    computeINaCaInternal(CepsReal v, CepsReal na, CepsReal ca) const;
 
    void
    computeINaK(CepsReal* INaK, CepsReal v, CepsReal* y) const;
 
    void
    computeBgCurrents(CepsReal* IKb, CepsReal* INab, CepsReal* ICab, CepsReal v, CepsReal* y) const;
 
    void
    computeIPCa(CepsReal* IPCa, CepsReal* y) const;
 
    void
    computeJrel(
      CepsReal* Jrel, CepsReal ICaL, CepsReal* y,
      CepsReal* dtyLin, CepsReal* dtyNLin, CepsReal fraction
    ) const;
 
    void
    computeJup(CepsReal* Jup, CepsReal* y, CepsReal fraction) const;
 
 
  protected:
 
    Type m_type; 
 
    // aliases for state vars
    static constexpr const CepsInt _nai    = 0 ; 
    static constexpr const CepsInt _nass   = 1 ; 
    static constexpr const CepsInt _ki     = 2 ; 
    static constexpr const CepsInt _kss    = 3 ; 
    static constexpr const CepsInt _cai    = 4 ; 
    static constexpr const CepsInt _cass   = 5 ; 
    static constexpr const CepsInt _cansr  = 6 ; 
    static constexpr const CepsInt _cajsr  = 7 ; 
    static constexpr const CepsInt _m      = 8 ; 
    static constexpr const CepsInt _hf     = 9 ; 
    static constexpr const CepsInt _hs     = 10; 
    static constexpr const CepsInt _j      = 11; 
    static constexpr const CepsInt _hsp    = 12; 
    static constexpr const CepsInt _jp     = 13; 
    static constexpr const CepsInt _mL     = 14; 
    static constexpr const CepsInt _hL     = 15; 
    static constexpr const CepsInt _hLp    = 16; 
    static constexpr const CepsInt _a      = 17; 
    static constexpr const CepsInt _iF     = 18; 
    static constexpr const CepsInt _iS     = 19; 
    static constexpr const CepsInt _ap     = 20; 
    static constexpr const CepsInt _iFp    = 21; 
    static constexpr const CepsInt _iSp    = 22; 
    static constexpr const CepsInt _d      = 23; 
    static constexpr const CepsInt _ff     = 24; 
    static constexpr const CepsInt _fs     = 25; 
    static constexpr const CepsInt _fcaf   = 26; 
    static constexpr const CepsInt _fcas   = 27; 
    static constexpr const CepsInt _jca    = 28; 
    static constexpr const CepsInt _nca    = 29; 
    static constexpr const CepsInt _ffp    = 30; 
    static constexpr const CepsInt _fcafp  = 31; 
    static constexpr const CepsInt _xrf    = 32; 
    static constexpr const CepsInt _xrs    = 33; 
    static constexpr const CepsInt _xs1    = 34; 
    static constexpr const CepsInt _xs2    = 35; 
    static constexpr const CepsInt _xk1    = 36; 
    static constexpr const CepsInt _Jrelnp = 37; 
    static constexpr const CepsInt _Jrelp  = 38; 
    static constexpr const CepsInt _CaMKt  = 39; 
 
    // Indices for constants
    static constexpr const CepsInt _IKr_factor    = 0  ; 
    static constexpr const CepsInt _IKs_factor    = 1  ; 
    static constexpr const CepsInt _IK1_factor    = 2  ; 
    static constexpr const CepsInt _ICaL_factor   = 3  ; 
    static constexpr const CepsInt _INaL_factor   = 4  ; 
    static constexpr const CepsInt _nao           = 5  ; 
    static constexpr const CepsInt _cao           = 6  ; 
    static constexpr const CepsInt _ko            = 7  ; 
    static constexpr const CepsInt _R             = 8  ; 
    static constexpr const CepsInt _T             = 9  ; 
    static constexpr const CepsInt _F             = 10 ; 
    static constexpr const CepsInt _L             = 11 ; 
    static constexpr const CepsInt _rad           = 12 ; 
    static constexpr const CepsInt _vmyo_fraction = 13 ; 
    static constexpr const CepsInt _vnsr_fraction = 14 ; 
    static constexpr const CepsInt _vjsr_fraction = 15 ; 
    static constexpr const CepsInt _vss_fraction  = 16 ; 
    static constexpr const CepsInt _drug          = 17 ; 
    static constexpr const CepsInt _ICNa          = 18 ; 
    static constexpr const CepsInt _hNa           = 19 ; 
    static constexpr const CepsInt _ICNaL         = 20 ; 
    static constexpr const CepsInt _hNaL          = 21 ; 
    static constexpr const CepsInt _ICto          = 22 ; 
    static constexpr const CepsInt _hto           = 23 ; 
    static constexpr const CepsInt _ICCal         = 24 ; 
    static constexpr const CepsInt _hCal          = 25 ; 
    static constexpr const CepsInt _ICKr          = 26 ; 
    static constexpr const CepsInt _hKr           = 27 ; 
    static constexpr const CepsInt _ICKs          = 28 ; 
    static constexpr const CepsInt _hKs           = 29 ; 
    static constexpr const CepsInt _ICK1          = 30 ; 
    static constexpr const CepsInt _hK1           = 31 ; 
    static constexpr const CepsInt _PKNa          = 32 ; 
   
    // Indices for deduced constants
    static constexpr const CepsInt _vcell    = 0  ; 
    static constexpr const CepsInt _ageo     = 1  ; 
    static constexpr const CepsInt _acap     = 2  ; 
    static constexpr const CepsInt _vmyo     = 3  ; 
    static constexpr const CepsInt _vnsr     = 4  ; 
    static constexpr const CepsInt _vjsr     = 5  ; 
    static constexpr const CepsInt _vss      = 6  ; 
    static constexpr const CepsInt _FRT      = 7  ; 
    static constexpr const CepsInt _gNaFrac  = 8  ; 
    static constexpr const CepsInt _gNaLFrac = 9  ; 
    static constexpr const CepsInt _gtoFrac  = 10 ; 
    static constexpr const CepsInt _gCalFrac = 11 ; 
    static constexpr const CepsInt _gKrFrac  = 12 ; 
    static constexpr const CepsInt _gKsFrac  = 13 ; 
    static constexpr const CepsInt _gK1Frac  = 14 ; 
 
 
};