CEPS  24.01
Cardiac ElectroPhysiology Simulator
BilayerMonodomainProblem.hpp
Go to the documentation of this file.
1 /*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2  This file is part of CEPS.
3 
4  CEPS is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 3 of the License, or
7  (at your option) any later version.
8 
9  CEPS is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with CEPS (see file LICENSE at root of project).
16  If not, see <https://www.gnu.org/licenses/>.
17 
18 
19  Copyright 2019-2024 Inria, Universite de Bordeaux
20 
21  Authors, in alphabetical order:
22 
23  Pierre-Elliott BECUE, Florian CARO, Yves COUDIERE(*), Andjela DAVIDOVIC,
24  Charlie DOUANLA-LONTSI, Marc FUENTES, Mehdi JUHOOR, Michael LEGUEBE(*),
25  Pauline MIGERDITICHAN, Valentin PANNETIER(*), Nejib ZEMZEMI.
26  * : currently active authors
27 
28 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
30 #pragma once
31 
32 
34 
37 {
38  public:
39 
41  struct UnknownsName
42  {
44  static constexpr const char* vm1 = "Transmembrane voltage layer 1 (mV)";
46  static constexpr const char* vm2 = "Transmembrane voltage layer 2 (mV)";
47  };
48 
49  public :
50 
52  explicit BilayerMonodomainProblem(Geometry* g, InputParameters* = nullptr);
53 
56 
58  void
59  defineUnknowns() override;
60 
63  getTMVUnknowns() const override;
64 
67  getCardiacUnknowns() const override;
68 
70  Unknown*
71  getTMVUnknown1() const;
72 
74  Unknown*
75  getTMVUnknown2() const;
76 
79  getSigmaI2() const;
80 
83  getSigmaE2() const;
84 
86  void
87  run() override;
88 
90  CepsReal
91  getCouplingStrength() const;
92 
95  getCouplingAttributes() const;
96 
98  CepsBool
99  getCouplingAttrNeg() const;
100 
102  void initializeConductivities() override;
103 
104  protected:
105 
107  void
109 
113 
116 
118 
121 
122 };
123 
124 
std::basic_string< CepsChar > CepsString
C++ format string.
Definition: CepsTypes.hpp:128
std::set< _Type, _Compare, _Alloc > CepsSet
C++ set.
Definition: CepsTypes.hpp:209
std::vector< _Type, _Alloc > CepsVector
C++ vector.
Definition: CepsTypes.hpp:155
bool CepsBool
Booleans.
Definition: CepsTypes.hpp:124
float CepsReal
Need single precision floating point.
Definition: CepsTypes.hpp:100
TensorField< GeomCell > * m_sigmaI2
Intracellular conductivity, defined on cells.
TensorField< GeomCell > * getSigmaE2() const
Link to extracellular conductivity.
BilayerMonodomainProblem(Geometry *g, InputParameters *=nullptr)
Constructor with input strings and geometry.
CepsBool m_couplingAttrNeg
true if given attribute is for UNcoupled elements
CepsVector< Unknown * > getTMVUnknowns() const override
Returns a vector containing all unknowns that are a TMV (especially useful for bilayer)
CepsString m_sigmaEOptions2
Extracellular conductivity parameters string for layer 2.
Unknown * getTMVUnknown1() const
Link to the single unknown of the problem.
CepsReal getCouplingStrength() const
coefficient that forces u1=u2 on coupled elements
void setupWithParameters(InputParameters *p) override
Initializes the problem from text input file.
CepsReal m_couplingStr
adds s*(u1-u2) on coupled elements
CepsString m_fibersOptions2
Text input description.
TensorField< GeomCell > * m_sigmaE2
Extracellulat conductivity, defined on cells.
TensorField< GeomCell > * getSigmaI2() const
Link to intracellular conductivity.
Unknown * getTMVUnknown2() const
Link to the single unknown of the problem.
CepsVector< Unknown * > getCardiacUnknowns() const override
Returns a vector containing all unknowns that are cardiac unknowns (eg. vm, ui or ue)
CepsSet< CepsAttribute > getCouplingAttributes() const
where to apply coupling
void defineUnknowns() override
A single unknown for transmembrane voltage.
CepsSet< CepsAttribute > m_couplingAttrs
where to apply coupling
CepsString m_sigmaIOptions2
Intracellular conductivity parameters string for layer 2.
void run() override
Run the simulation.
~BilayerMonodomainProblem()=default
Destructor.
void initializeConductivities() override
Sets the myocardium with physical properties for both layers.
CepsBool getCouplingAttrNeg() const
true if given attribute if for UNcoupled elements
A abstract class that regroups common parameters of cardiac problems.
A Field is an object wrapped around a SAFunc functor, defined on at least one domain.
Definition: Field.hpp:80
Encapsulates all the geometrical data.
Definition: Geometry.hpp:50
Reads and stores simulation configuration.
A class used to defined an unknown of a PDE problem The unknown can be defined on a specific region,...
Definition: Unknown.hpp:45
static constexpr const char * vm1
Transmembrane voltage layer 1.
static constexpr const char * vm2
Transmembrane voltage layer 2.