BR77.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 BR77 : public AbstractIonicModel
{ 
 
  public:
 
    BR77(
      Unknown*                      u, 
      AbstractPdeProblem*           pb, 
      const CepsSet<CepsAttribute>& attrs={},
      InputParameters*              params=nullptr
    );
 
    ~BR77() = 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
    convertCurrentFromCepsUnit(const CepsReal& v) const final;
 
    CepsReal
    convertCmFromCepsUnit(const CepsReal& cm) const final;
 
    CepsReal
    convertCmToCepsUnit(const CepsReal& cm) const final;
 
 
  protected: 
 
    void
    setupWithParameters(InputParameters* p, FunctionDictionary* dico, AbstractPdeProblem* pb);
 
    virtual CepsReal
    getINa(CepsReal* y, CepsReal gNaCa, CepsReal gNa, CepsReal v) const;
 
  protected:
 
    ScalarField<DegreeOfFreedom>* m_gNa;   
    ScalarField<DegreeOfFreedom>* m_gNaCa; 
 
    // aliases for model contants
    static constexpr const CepsInt _gS  = 0; 
    static constexpr const CepsInt _ENa = 1; 
   
    // aliases for state vars
    static constexpr const CepsInt _m   = 0; 
    static constexpr const CepsInt _h   = 1; 
    static constexpr const CepsInt _j   = 2; 
    static constexpr const CepsInt _CaI = 3; 
    static constexpr const CepsInt _d   = 4; 
    static constexpr const CepsInt _f   = 5; 
    static constexpr const CepsInt _x1  = 6; 
};
 
//         too large currents
class BR77Modified : public BR77
{
 
  public:
 
    BR77Modified(
      Unknown*                      u, 
      AbstractPdeProblem*           pb, 
      const CepsSet<CepsAttribute>& attrs={},
      InputParameters*              params=nullptr
    );
 
  protected:
 
    void
    setupWithParameters(InputParameters* p, FunctionDictionary* dico, AbstractPdeProblem* pb);
 
    virtual CepsReal
    getINa(CepsReal* y, CepsReal gNaCa, CepsReal gNa, CepsReal v) const override;
 
  protected:
 
    // aliases for model contants
    static constexpr const CepsInt _vA = 2; 
    static constexpr const CepsInt _vB = 3; 
 
 
 
};