ExtendedBidomainProblem.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 "cardiac/problem/BidomainProblem.hpp"
 
class ExtendedBidomainProblem : public BidomainProblem
{
 
  public:
 
    struct UnknownsName
    {
      static constexpr const char* vm  = BidomainProblem::UnknownsName::vm;
      static constexpr const char* ue  = BidomainProblem::UnknownsName::ue;
      static constexpr const char* lag = "Lagrangian for extracellular potential";
    };
  
  public:
 
    explicit ExtendedBidomainProblem(Geometry* g, InputParameters* = nullptr);
  
    ~ExtendedBidomainProblem() = default;
  
    void
    defineUnknowns() override;
  
    void
    run() override;
  
    const CepsSet<CepsAttribute>&
    getExtracardiacAttributes() const;
  
    CepsSet<CepsAttribute>
    getWholeDomainAttributes() const;
  
    virtual CepsSet<CepsAttribute>
    getAnodeAttributes() const;
  
    virtual CepsSet<CepsAttribute>
    getCathodeAttributes() const;
  
    CepsBool
    hasAnodalCathodalStimulation() const;
  
    void
    defineBoundaryConditions() override;
  
    CepsBool
    requireNullMean() const; 
  
  protected:
    void
    setupWithParameters(InputParameters* params) override;
  
    // ------------------------
    // extracardiac properties
  
    CepsString             m_extMediaAttrsOpts;  
    CepsSet<CepsAttribute> m_extMediaAttrs;      
  
    CepsString m_biElecStimOpts;  
  
    CepsString m_robinCoeffs;                   
    CepsString             m_anodeAttrsOpts;    
    CepsSet<CepsAttribute> m_anodeAttrs;        
    CepsString             m_cathodeAttrsOpts;  
    CepsSet<CepsAttribute> m_cathodeAttrs;      
};