CEPS  24.01
Cardiac ElectroPhysiology Simulator
MonodomainProblem.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 
39 {
40 
41  public:
42 
44  struct UnknownsName
45  {
47  static constexpr const char* vm = CardiacProblem::UnknownsName::vm;
48  };
49 
50  public:
51 
53  explicit MonodomainProblem(Geometry* g, InputParameters* = nullptr);
54 
56  ~MonodomainProblem() = default;
57 
59  void
60  defineUnknowns() override;
61 
64  getTMVUnknowns() const override;
65 
68  getCardiacUnknowns() const override;
69 
71  Unknown*
72  getTMVUnknown() const;
73 
75  void
76  run() override;
77 
78 
79  protected:
80 
81 
82 };
83 
84 
std::vector< _Type, _Alloc > CepsVector
C++ vector.
Definition: CepsTypes.hpp:155
A abstract class that regroups common parameters of cardiac problems.
Encapsulates all the geometrical data.
Definition: Geometry.hpp:50
Reads and stores simulation configuration.
Defines and solve the monodomain problem, see models page of user doc.
~MonodomainProblem()=default
Destructor.
CepsVector< Unknown * > getTMVUnknowns() const override
Returns a vector containing all unknowns that are a TMV (especially useful for bilayer)
Unknown * getTMVUnknown() const
Link to the single unknown of the problem.
void defineUnknowns() override
A single unknown for transmembrane voltage.
CepsVector< Unknown * > getCardiacUnknowns() const override
Returns a vector containing all unknowns that are cardiac unknowns (eg. vm, ui or ue)
void run() override
Run the simulation.
MonodomainProblem(Geometry *g, InputParameters *=nullptr)
Constructor with input strings and geometry.
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 * vm
Transmembrane voltage.
name of unknowns in a struct
static constexpr const char * vm
Transmembrane voltage.