CEPS  24.01
Cardiac ElectroPhysiology Simulator
FluxAnodeCathodeProblem.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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
31 #pragma once
32 
34 
39 {
40 
41  public:
42 
44  explicit FluxAnodeCathodeProblem(
45  Geometry* g,
46  InputParameters* p = nullptr
47  );
48 
50  ~FluxAnodeCathodeProblem() override;
51 
53  void
55 
57  void
58  defineUnknowns() override;
59 
61  void
62  defineSourceTerms() override;
63 
65  void
66  defineBoundaryConditions() override;
67 
69  void
70  defineAnalyticSolution() override;
71 
73  void
74  run() override;
75 
77  CepsBool
78  requireNullMean() const;
79 
80  protected:
83 };
std::basic_string< CepsChar > CepsString
C++ format string.
Definition: CepsTypes.hpp:128
bool CepsBool
Booleans.
Definition: CepsTypes.hpp:124
float CepsReal
Need single precision floating point.
Definition: CepsTypes.hpp:100
Poisson equation with Dirichlet 1 on anode, 0 on cathode. Neumann elsewhere. Functional tensorial con...
Poisson equation with Neumann 1 on anode, -1 on cathode. Neumann 0 elsewhere. Functional tensorial co...
CepsBool requireNullMean() const
Tells if this problem requires a null mean constraint.
void defineAnalyticSolution() override
No analytic solution.
void run() override
Run does nothing. The tests call directly a LaplacianSolver solve method.
CepsReal m_totalIntensityApplied
Intensity of delivered current.
~FluxAnodeCathodeProblem() override
Destructor.
void defineSourceTerms() override
No source term.
void setupWithParameters(InputParameters *p) override
Sets the parameters.
FluxAnodeCathodeProblem(Geometry *g, InputParameters *p=nullptr)
Constructor from geometry and optional input file.
void defineUnknowns() override
Lists the unknowns of the problem (one here)
CepsString m_robinCoeffs
Robin coefficients.
void defineBoundaryConditions() override
Neumann -1/1 and 0 elsewhere.
Encapsulates all the geometrical data.
Definition: Geometry.hpp:50
Reads and stores simulation configuration.