AllIonicModels.cpp

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/AllIonicModels.hpp"
 
AbstractIonicModel*
getIonicModelFromString(
  CepsString                                        ionOpts, 
  InputParameters*                                  params,
  AbstractPdeProblem*                               pb, 
  CepsMap<CepsUnknownIndex,CepsSet<CepsAttribute>>& prevAttrs,
  const CepsSet<CepsAttribute>&                     tissueAttrs
)
{
 
  AbstractIonicModel* res = nullptr;
 
  std::stringstream ss(ionOpts);
 
  CepsString errorMessage = 
    CepsString("   Each ionic model input must have the following structure:\n") +
    "    - an integer for the unknown concerned by the model\n" +
    "    - a model name,\n" +
    "    - optionally, one or several integers for the attribute(s) of the region(s)\n" +
    "      in which to use this model,\n" +
    "   Given ionic model is: " + ionOpts;
 
  // Unknown
  CepsUnknownIndex uId = ceps::readInt(ss,"Unable to read unknown identifier.\n" + errorMessage);
  Unknown*         u   = pb->getUnknown(uId);
 
  CepsSet<CepsAttribute> attrs;
  CepsString type;
  ss >> type ;
  type = ceps::toUpper(type);
 
  while (not ss.eof())
  {
    CepsAttribute attr;
    ss >> attr;
    CEPS_ABORT_IF(prevAttrs[uId].contains(attr),
      "Cannot assign ionic model " << type << " to region with attribute " << attr << 
      "   for unknown " << uId << " as another ionic model was assigned there"
    );
    prevAttrs[uId].insert(attr);
    attrs.insert(attr);
  }
 
  if (attrs.empty())
    attrs = tissueAttrs;
 
  if (type == "TENTUSSCHER2006_ENDO" or type == "TTP06_ENDO")
    res = ceps::getNew<TTP06>(TTP06::Type::Endo,u,attrs,params);
 
  else if (type == "TENTUSSCHER2006_MIDMYO" or type == "TTP06_MIDMYO")
    res = ceps::getNew<TTP06>(TTP06::Type::MidMyo,u,attrs,params);
 
  else if (type == "TENTUSSCHER2006_EPI" or type == "TTP06_EPI")
    res = ceps::getNew<TTP06>(TTP06::Type::Epi,u,attrs,params);
 
  else if (type == "MS" or type == "MS03")
    res = ceps::getNew<MS03>(u,attrs,params);
 
  else if (type == "MS_MODIFIED" or type == "MS03_MODIFIED")
    res = ceps::getNew<MS03Modified>(u,attrs,params);
 
  else if (type == "AP" or type == "AP95")
    res = ceps::getNew<AP95>(u,attrs,params);
 
  else if (type == "CRN" or type == "CRN98")
    res = ceps::getNew<CRN98>(u,attrs,params);
 
  else if (type == "BEELERREUTER" or type == "BR77")
    res = ceps::getNew<BR77>(u,pb,attrs,params);
 
  else if (type == "BR_MODIFIED" or type == "BR77_MODIFIED")
    res = ceps::getNew<BR77Modified>(u,pb,attrs,params);
 
  else if (type == "ORDMD16_ENDO")
    res = ceps::getNew<ORdmD16>(ORdmD16::Type::Endo,u,attrs,params);
 
  else if (type == "ORDMD16_EPI")
    res = ceps::getNew<ORdmD16>(ORdmD16::Type::Epi,u,attrs,params);
 
  else if (type == "ORDMD16_MIDMYO")
    res = ceps::getNew<ORdmD16>(ORdmD16::Type::MidMyo,u,attrs,params);
 
  else
    CEPS_ABORT ("Unknown ionic model type \"" << type << "\"\n" <<
      "   Valid types are\n" << 
      "   - TenTusscher2006_Endo (or TTP06_Endo)\n" <<
      "   - TenTusscher2006_MidMyo (or TTP06_MidMyo)\n" <<
      "   - TenTusscher2006_Epi (or TTP06_Epi)\n" <<
      "   - ORdmD16_Endo\n" <<
      "   - ORdmD16_MidMyo\n" <<
      "   - ORdmD16_Epi\n" <<
      "   - MS (or MS03)\n" <<
      "   - MS_Modified (or MS03_Modified)\n" <<
      "   - AP (or AP95)\n" <<
      "   - CRN (or CRN98)\n" <<
      "   - BeelerReuter (or BR77)\n" << 
      "   - BR_Modified (or BR77_Modified)"
    );
 
  if (not tissueAttrs.empty())
    CEPS_SAYS("Added ionic model " << type << " to region with attributes " << attrs);
 
  return res;
}