PacemakerBidomainProblem.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/ExtendedBidomainProblem.hpp"
#include "cardiac/pacemaker/problem/AbstractPacemakerProblem.hpp"
 
class PacemakerBidomainProblem : public ExtendedBidomainProblem, public AbstractPacemakerProblem
{
 
  public:
 
    struct UnknownsName
    {
      static constexpr const char* vm       = ExtendedBidomainProblem::UnknownsName::vm;
      static constexpr const char* ue       = ExtendedBidomainProblem::UnknownsName::ue;
      static constexpr const char* UCathode = "Cathode potential (mV)";
      static constexpr const char* UAnode   = "Anode potential (mV)";
      static constexpr const char* VCets    = "CETS voltage (mV)";
      static constexpr const char* VCts     = "CTS voltage (mV)";
    };
 
 
  public:
 
    class PowerSupply : public AbstractPacemakerProblem::PowerSupply
    {
 
      public:
 
        PowerSupply(PacemakerBidomainProblem* problem);
    
        ~PowerSupply() override = default;
    
        CepsReal
        eval(CepsStandardArgs args) final;
    
 
      protected:
 
        PacemakerBidomainProblem* m_problem; 
    };
  
    explicit PacemakerBidomainProblem(Geometry* g, InputParameters* = nullptr);
  
    virtual ~PacemakerBidomainProblem() = default;
  
    void
    getInitialCondition(DHVecPtr v0) const override;
  
    void
    defineUnknowns() override;
  
    void
    defineBoundaryConditions() override;
  
    void
    defineSourceTerms() override;
  
    void
    run() override;
  
    CepsSet<CepsAttribute>
    getAnodeAttributes() const override;
  
    CepsSet<CepsAttribute>
    getCathodeAttributes() const override;
  
    // ------------------------------------------------------- //
    // Unknowns
  
    Unknown*
    getUAnodeUnknown() const override;
  
    // /// @brief Link to the Um unknown of the problem
    Unknown*
    getUCathodeUnknown() const override;
  
    Unknown*
    getVCetsUnknown() const override;
  
    Unknown*
    getVCtsUnknown() const override;
 
 
  protected:
 
    void
    setupWithParameters(InputParameters* params) override;
 
};