MS03.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 MS03 : public AbstractIonicModel
{
 
  public : 
  
    MS03(
      Unknown*                      u, 
      const CepsSet<CepsAttribute>& attrs={},
      InputParameters*              params=nullptr
    );
  
    virtual ~MS03() = 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;
 
    CepsReal
    convertVoltageToCepsUnit(const CepsReal& u) const override;
 
    CepsReal
    convertVoltageFromCepsUnit(const CepsReal& u) const override;
 
    CepsReal
    convertDtvToCepsUnit(const CepsReal& i) const override;
 
    CepsReal
    convertCurrentFromCepsUnit(const CepsReal& i) const override;
 
    CepsReal
    convertCmFromCepsUnit(const CepsReal& cm) const override;
 
    CepsReal
    convertCmToCepsUnit(const CepsReal& cm) const override;
 
 
  protected:
 
 
    void
    setupWithParameters(InputParameters* p, FunctionDictionary* dico);
 
  protected:
 
    CepsReal m_vMin;        
    CepsReal m_vMax;        
    CepsReal m_cellSurface; 
 
    CepsReal m_vInit; 
    CepsReal m_hInit; 
 
    // alias for gates variables
    static constexpr const CepsInt _h    = 0;  
 
    // aliases for parameters
    static constexpr const CepsInt _tauIn    = 0; 
    static constexpr const CepsInt _tauOut   = 1; 
    static constexpr const CepsInt _tauOpen  = 2; 
    static constexpr const CepsInt _tauClose = 3; 
    static constexpr const CepsInt _vGate    = 4; 
 
};
 
class MS03Modified : public MS03
{
 
  public : 
  
    MS03Modified(
      Unknown*                      u, 
      const CepsSet<CepsAttribute>& attrs={},
      InputParameters*              params=nullptr
    );
  
    virtual ~MS03Modified() = default;
  
    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:
 
    CepsReal m_etaGate; 
    static constexpr const CepsInt _etaGate = 5; 
    static constexpr const CepsInt _vA      = 6; 
    static constexpr const CepsInt _vB      = 7; 
 
};