TTP06.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
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
#include "ode/ionicModels/AbstractIonicModel.hpp"
#include "pde/problem/AbstractPdeProblem.hpp"
 
class TTP06 : public AbstractIonicModel
{
 
  public:
 
    enum class Type
    {
      Endo,   
      MidMyo, 
      Epi     
    };
 
    TTP06(
      const Type&                   type,
      Unknown*                      u, 
      const CepsSet<CepsAttribute>& attrs={},
      InputParameters*              params=nullptr
    );
 
    virtual ~TTP06() = 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 final;
 
 
  protected:
 
 
    void
    setupWithParameters(InputParameters* p, FunctionDictionary* dico);
 
 
  protected:
 
    Type m_type;  
  
    CepsReal m_cellSurface; 
 
    // aliases for state variables
    static constexpr const CepsInt _ki     = 0;  
    static constexpr const CepsInt _nai    = 1;  
    static constexpr const CepsInt _cai    = 2;  
    static constexpr const CepsInt _xr1    = 3;  
    static constexpr const CepsInt _xr2    = 4;  
    static constexpr const CepsInt _xs     = 5;  
    static constexpr const CepsInt _m      = 6;  
    static constexpr const CepsInt _h      = 7;  
    static constexpr const CepsInt _j      = 8;  
    static constexpr const CepsInt _cass   = 9;  
    static constexpr const CepsInt _d      = 10; 
    static constexpr const CepsInt _f      = 11; 
    static constexpr const CepsInt _f2     = 12; 
    static constexpr const CepsInt _fcass  = 13; 
    static constexpr const CepsInt _s      = 14; 
    static constexpr const CepsInt _r      = 15; 
    static constexpr const CepsInt _casr   = 16; 
    static constexpr const CepsInt _rprime = 17; 
 
    // aliases for constants
    static constexpr const CepsInt _R       =  0;  
    static constexpr const CepsInt _T       =  1;  
    static constexpr const CepsInt _F       =  2;  
    static constexpr const CepsInt _vc      =  3;  
    static constexpr const CepsInt _pkna    =  4;  
    static constexpr const CepsInt _ko      =  5;  
    static constexpr const CepsInt _nao     =  6;  
    static constexpr const CepsInt _cao     =  7;  
    static constexpr const CepsInt _gk1     =  8;  
    static constexpr const CepsInt _gkr     =  9;  
    static constexpr const CepsInt _gks     = 10;  
    static constexpr const CepsInt _gna     = 11;  
    static constexpr const CepsInt _gbna    = 12;  
    static constexpr const CepsInt _gcal    = 13;  
    static constexpr const CepsInt _gbca    = 14;  
    static constexpr const CepsInt _gto     = 15;  
    static constexpr const CepsInt _pnak    = 16;  
    static constexpr const CepsInt _kmk     = 17;  
    static constexpr const CepsInt _kmna    = 18;  
    static constexpr const CepsInt _knaca   = 19;  
    static constexpr const CepsInt _ksat    = 20;  
    static constexpr const CepsInt _alpha   = 21;  
    static constexpr const CepsInt _gamma   = 22;  
    static constexpr const CepsInt _kmca    = 23;  
    static constexpr const CepsInt _kmnai   = 24;  
    static constexpr const CepsInt _gpca    = 25;  
    static constexpr const CepsInt _kpca    = 26;  
    static constexpr const CepsInt _gpk     = 27;  
    static constexpr const CepsInt _k1prime = 28;  
    static constexpr const CepsInt _k2prime = 29;  
    static constexpr const CepsInt _k3      = 30;  
    static constexpr const CepsInt _k4      = 31;  
    static constexpr const CepsInt _ec      = 32;  
    static constexpr const CepsInt _maxsr   = 33;  
    static constexpr const CepsInt _minsr   = 35;  
    static constexpr const CepsInt _vrel    = 36;  
    static constexpr const CepsInt _vxfer   = 37;  
    static constexpr const CepsInt _kup     = 38;  
    static constexpr const CepsInt _vleak   = 39;  
    static constexpr const CepsInt _vmaxup  = 40;  
    static constexpr const CepsInt _bufc    = 41;  
    static constexpr const CepsInt _kbufc   = 42;  
    static constexpr const CepsInt _bufsr   = 43;  
    static constexpr const CepsInt _kbuf    = 44;  
    static constexpr const CepsInt _bufss   = 45;  
    static constexpr const CepsInt _kbufss  = 46;  
    static constexpr const CepsInt _vsr     = 47;  
    static constexpr const CepsInt _vss     = 48;  
 
 
};