CEPS  24.01
Cardiac ElectroPhysiology Simulator
TimeWriter.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 #include "common/CepsCommon.hpp"
35 
47 class TimeWriter : public FileWriter
48 {
49 
50  public:
51 
53  TimeWriter(
54  const CepsString& fileName,
55  const CepsVector<CepsReal3D>& points,
57  );
58 
60  CepsBool
61  hasSomethingToWrite() const;
62 
65  void addCustomData(const CepsString& name, CepsReal* data);
66 
68  void
69  write(CepsReal t, DHVecPtr data);
70 
71 
72  protected:
73 
75  void
76  writeHeader();
77 
78  protected:
79 
81 
84 
88 
89 
90 };
std::basic_string< CepsChar > CepsString
C++ format string.
Definition: CepsTypes.hpp:128
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
std::shared_ptr< DistributedHaloVector > DHVecPtr
Typedef for pointer on Distributed Halo CepsVector.
Abstract Class for all numerical method (FE, FD, FV etc)
Enables the writing of files.
Definition: FileWriter.hpp:40
CepsVector< CepsString > m_customNames
Custom data name, printed in header.
Definition: TimeWriter.hpp:85
CepsVector< CepsReal3D > m_points
Points location.
Definition: TimeWriter.hpp:82
CepsBool m_canAddData
Prevents addition of data after header is written.
Definition: TimeWriter.hpp:87
CepsBool hasSomethingToWrite() const
Tells if some data must be written. If not, why bother ?
Definition: TimeWriter.cpp:66
AbstractDiscretization * m_discr
Link to descretization (and problem within)
Definition: TimeWriter.hpp:80
void write(CepsReal t, DHVecPtr data)
Writes the content of data at indices set in constructor.
Definition: TimeWriter.cpp:82
TimeWriter(const CepsString &fileName, const CepsVector< CepsReal3D > &points, AbstractDiscretization *discr)
Constructor.
Definition: TimeWriter.cpp:34
CepsVector< CepsDofGlobalIndex > m_dofIndices
Points IDs.
Definition: TimeWriter.hpp:83
void writeHeader()
Writes comment lines to indicate what are the variables.
Definition: TimeWriter.cpp:113
void addCustomData(const CepsString &name, CepsReal *data)
Add a custom data to be written in the outputfile. Custom data cannot be added after header has been ...
Definition: TimeWriter.cpp:72
CepsVector< CepsReal * > m_customData
Custom data, careful with ptr handling.
Definition: TimeWriter.hpp:86