CEPS  24.01
Cardiac ElectroPhysiology Simulator
GeomNode.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  CepsReal x,
35  CepsReal y,
36  CepsReal z,
38  CepsAttribute *attrs,
39  CepsUInt nAttrs
40 ) :
41  ceps::HoldsGlobalIndex(gID),
42  ceps::HoldsAttributes (attrs,nAttrs),
43  CepsVertex (x,y,z)
44 {
45 
46 }
47 
48 void
50 {
58  return;
59 }
60 
63 {
65  "Passed node is nullptr"
66  );
67  CepsStandardArgs args;
68  args.x = node->getCoordinates();
69  args.nodeId = node->getGlobalIndex();
70  args.attr = node->getAttributes ();
71  return args;
72 }
#define CEPS_ABORT_IF(condition, message)
Stops the execution with a message if condition is true. If testing is enabled, only throws a runtime...
CepsInt CepsAttribute
Used to define regions.
Definition: CepsTypes.hpp:215
std::make_unsigned_t< CepsInt > CepsUInt
Unsigned version on CepsInt.
Definition: CepsTypes.hpp:109
float CepsReal
Need single precision floating point.
Definition: CepsTypes.hpp:100
CepsGlobalIndex CepsNodeGlobalIndex
Indices of nodes.
Definition: CepsTypes.hpp:224
CepsStandardArgs getStandardArgsFrom(GeomNode *node)
Returns a standard args structure with data from a node.
Definition: GeomNode.cpp:62
CepsReal3D & getCoordinates()
Get three coordinates, read & write.
Definition: CepsVertex.cpp:174
Base class for nodes used in meshes.
Definition: GeomNode.hpp:53
GeomNode(CepsReal x, CepsReal y, CepsReal z, CepsGlobalIndex gID, CepsAttribute *attrs=nullptr, CepsUInt nAttrs=0)
Constructor.
Definition: GeomNode.cpp:33
void reset()
Wipes content.
Definition: GeomNode.cpp:49
void reset()
Equivalent to HoldsAttributes::clear()
CepsSet< CepsAttribute > & getAttributes()
Returns the attributes of the entity.
void reset()
Sets the entity as NOT being on boundary.
void reset()
Equivalent to HoldsCells::clearCells.
void reset()
Set the dimension of the object to 0.
const CepsGlobalIndex & getGlobalIndex() const
Get the index
void reset()
Set the index to 0u.
void reset()
Equivalent to HoldsNodes::clearNodes.
void reset()
Gives ownership to rank(), removes halos.
A namespace for all utility methods.
CepsBool isNullPtr(_Type *ptr)
Tells if passed pointer is null.
Definition: CepsMemory.hpp:45
Structure used to pass arguments to SAFunc (see pde directory) The flags of the SAFunc allows extract...
Definition: CepsTypes.hpp:239
CepsSet< CepsAttribute > attr
attributes
Definition: CepsTypes.hpp:243
CepsNodeGlobalIndex nodeId
node index
Definition: CepsTypes.hpp:246
CepsReal3D x
space
Definition: CepsTypes.hpp:241