CEPS  24.01
Cardiac ElectroPhysiology Simulator
HeatProblem.cpp
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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
32 
34 : AbstractTimedPdeProblem (g,p), m_k(k)
35 {
36  setProblemName("Heat");
37 
38  if (ceps::isValidPtr(p))
40 }
41 
43 {
44 }
45 
46 void
48 {
49  CepsVector<CepsString> words = ceps::split(m_parameters->getString("stiffness tensor",""));
50  if (not words.empty())
51  m_k = ceps::toMathTensor(words);
52  return;
53 }
54 
55 void
57 {
58 }
59 
60 void
62 {
63  // A single spatial unknown defined everywhere
64  addUnknown("u");
65 }
66 
69 {
70  return m_k;
71 }
72 
73 void
75 {
76 
77  if (ceps::isProfiling())
78  getProfiler()->start("whole","solving the PDE (HeatProblem class)");
79 
81 
82  HeatSolver solver(this);
83 
84  solver.solve();
85 
86  if (hasAnalyticSolution())
87  m_errors = solver.getErrors();
88 
89  if (ceps::isProfiling())
90  getProfiler()->stop("whole");
91 
92 }
Eigen::Matrix< CepsScalar, 3, 3 > CepsMathTensor
Tensor, eigen format.
Definition: CepsTypes.hpp:137
std::vector< _Type, _Alloc > CepsVector
C++ vector.
Definition: CepsTypes.hpp:155
CepsBool hasAnalyticSolution() const
Tells if there is an analytic or reference solution.
void setProblemName(const CepsString &name)
Set the name of the problem.
void addUnknown(const CepsString &label, CepsSet< CepsAttribute > attrs={}, CepsLocationFlag flag=CepsLocationFlag::Point, const CepsString &unit="")
Register a new unknown.
InputParameters * m_parameters
Input file data.
Astract Problem which does depend on time.
void initializeEquation() override
Initializes equations (unknowns, bc, source term) and creates the spatial discretization This method ...
CepsArray2< CepsArray3< CepsArray3< CepsReal > > > m_errors
Will store Linf, L1 and L2 relative errors.
void solve() override
Solves the all PDE (all iterations)
CepsArray2< CepsArray3< CepsArray3< CepsReal > > > getErrors() const
Gets the currently computed errors. First index selects absolute(0) or relative(1) second index selec...
Profiler * getProfiler() const
Access to profiler.
Definition: CepsObject.cpp:46
Encapsulates all the geometrical data.
Definition: Geometry.hpp:50
CepsMathTensor m_k
Diffusion tensor.
Definition: HeatProblem.hpp:73
HeatProblem(Geometry *g, InputParameters *p=nullptr, const CepsMathTensor &k=CepsMathTensor::Identity())
Constructor from geometry and optional input file.
Definition: HeatProblem.cpp:33
virtual CepsMathTensor getDiffusionTensor(Unknown *u=nullptr) const
Diffusion tensor.
Definition: HeatProblem.cpp:68
void defineUnknowns() override
Lists the unknowns of the problem (one here)
Definition: HeatProblem.cpp:61
void defineSourceTerms() override
Lists the unknowns of the problem (one here)
Definition: HeatProblem.cpp:56
void run() override
Computes the solution.
Definition: HeatProblem.cpp:74
~HeatProblem() override
Destructor.
Definition: HeatProblem.cpp:42
void setupWithParameters(InputParameters *params) override
Set attributes from input file. Parameters are passed as arguments in case one wants to use other par...
Definition: HeatProblem.cpp:47
Solve heat equation.
Definition: HeatSolver.hpp:39
Reads and stores simulation configuration.
CepsString getString(const keyType &key) const
Reads a CepsString from configuration.
void stop(CepsString lbl)
Stops the measure of a labeled chronometer.
void start(CepsString lbl, CepsString dspl="")
Creates or continue a labeled chronometer.
A class used to defined an unknown of a PDE problem The unknown can be defined on a specific region,...
Definition: Unknown.hpp:45
CepsMathTensor toMathTensor(const CepsVector< CepsString > &vec)
Cast a CepsVector of CepsString to CepsMathTensor.
Definition: CepsString.cpp:237
CepsBool isValidPtr(_Type *ptr)
Tells if pointer is not null.
Definition: CepsMemory.hpp:61
CepsVector< CepsString > split(const CepsString &s, const CepsString &delimiters=CepsString(" \t"))
Splits a string using mulitple delimiters in a single string.
Definition: CepsString.cpp:38
CepsBool isProfiling()
Check if we are currently profiling on the master proc (always false on slave procs).
Definition: CepsFlags.cpp:257