CEPS  24.01
Cardiac ElectroPhysiology Simulator
FENode Class Reference

Detailed Description

A nodal point on a finite element. It is different from a geom node as it may have different properties. Also, there is not necessarily a match between geom nodes from the mesh and FE nodal points.

These FE Nodes are the ones that define the basis functions

Definition at line 41 of file FENode.hpp.

#include <FENode.hpp>

Inheritance diagram for FENode:
[legend]

Public Member Functions

 FENode ()
 Default constructor. More...
 
 FENode (GeomNode *node, CepsBool ownedPtr=false)
 Constructor from a geometric node. More...
 
 FENode (const FENode &that)=default
 Copy constructor. More...
 
FENodeoperator= (const FENode &that)
 Copy assignement. More...
 
 ~FENode () override
 Destructor. More...
 
void setGeomObject (GeomNode *node, CepsBool owned=false) override
 Associate the geom node
More...
 
- Public Member Functions inherited from ceps::HoldsGeomObject< GeomNode >
 HoldsGeomObject (GeomNode *object=nullptr, CepsBool owned=false)
 Constructor with ID. More...
 
 HoldsGeomObject (const HoldsGeomObject &)=default
 Copy constructor. More...
 
 HoldsGeomObject (HoldsGeomObject &&) noexcept=default
 Copy constructor. More...
 
virtual ~HoldsGeomObject ()
 Destructor. More...
 
HoldsGeomObjectoperator= (const HoldsGeomObject &)=default
 Assignment operator. More...
 
HoldsGeomObjectoperator= (HoldsGeomObject &&) noexcept=default
 Assignment operator. More...
 
GeomNodegetGeomObject () const
 Get the geom object. More...
 
GeomNodegetProperties () const
 Get the properties (in fact it's just the geom object) More...
 
void reset ()
 Set the geom object pointer to nullptr. More...
 
- Public Member Functions inherited from ceps::HoldsNodes< FENode >
 HoldsNodes (const CepsVector< FENode * > &nodes)
 Constructor with nodes. More...
 
 HoldsNodes (FENode **nodes, const CepsUInt &n)
 Constructor with nodes. More...
 
 HoldsNodes ()=default
 Default constructor. More...
 
 HoldsNodes (const HoldsNodes &)=default
 Copy constructor. More...
 
 HoldsNodes (HoldsNodes &&) noexcept=default
 Copy constructor. More...
 
virtual ~HoldsNodes ()=default
 Destructor. More...
 
HoldsNodesoperator= (const HoldsNodes &)=default
 Assignment operator. More...
 
HoldsNodesoperator= (HoldsNodes &&) noexcept=default
 Assignment operator. More...
 
CepsUInt getNumberOfNodes () const
 Returns the total number of nodes. More...
 
CepsUInt countValidNodes ()
 Returns the number of nodes that are not nullptr. More...
 
CepsVector< FENode * > & getNodes ()
 Reference to the node pointers array. More...
 
const CepsVector< FENode * > & getNodes () const
 Reference to the node pointers array, const version. More...
 
FENodegetNodeAt (const CepsUInt &i)
 Pointer to the i-th node. More...
 
const FENodegetNodeAt (const CepsUInt &i) const
 Pointer to the i-th node, const version. More...
 
void setNodes (const CepsVector< FENode * > &nodes)
 Assign all nodes. More...
 
void setNodes (FENode **nodes, const CepsUInt &n)
 Assign all nodes. More...
 
void setNodes (_It first, _It last)
 Assign all nodes. More...
 
void setNodeAt (const CepsUInt &i, FENode *neigh)
 Set the i-th node. If i>nNodes, nullptrs fill the vector. More...
 
void addNode (FENode *name)
 Add a single node to the vector. More...
 
void addNodes (const CepsVector< FENode * > &nodes)
 Add several nodes to the vector. More...
 
void addNodes (FENode **nodes, const CepsUInt &n)
 Add several nodes to the vector. More...
 
void addNodes (_It first, _It last)
 Add several nodes to the vector. More...
 
void removeNode (FENode *&name)
 Removes the given node from the list. More...
 
void removeNodes (const CepsVector< FENode * > &nodes)
 Removes several nodes from the list. More...
 
void removeNodes (FENode **nodes, const CepsUInt &n)
 Removes several nodes from the list. More...
 
void removeNodes (_It first, _It last)
 Removes several nodes from the list. More...
 
void clearNodes ()
 Wipes the vector of nodes. More...
 
CepsBool hasNode (FENode *&neigh)
 Tells if object has the given node. More...
 
CepsBool hasAllNodes (const CepsVector< FENode * > &nodes)
 Tells if object has all the given nodes. More...
 
CepsBool hasAllNodes (FENode **nodes, const CepsUInt &n)
 Tells if object has all the given nodes. More...
 
CepsBool hasAllNodes (_It first, _It last)
 Tells if object has all the given nodes. More...
 
CepsBool hasOneOfNodes (const CepsVector< FENode * > &nodes)
 Tells if object has one of the given nodes. More...
 
CepsBool hasOneOfNodes (FENode **nodes, const CepsUInt &n)
 Tells if object has one of the given nodes. More...
 
CepsBool hasOneOfNodes (_It first, _It last)
 Tells if object has one of the given nodes. More...
 
CepsVector< FENode * > getValidNodes () const
 Get pointers on all valid nodes. More...
 
CepsGlobalIndex getNodeIndex (CepsUInt i) const
 Get the index of i-th node. More...
 
CepsVector< CepsGlobalIndexgetNodeIndices () const
 Get indices of all nodes. More...
 
void getNodeIndices (CepsGlobalIndex *nodesIndices, const CepsSize &nAllocated) const
 Get indices of all nodes. More...
 
void reset ()
 Equivalent to HoldsNodes::clearNodes. More...
 
- Public Member Functions inherited from ceps::HoldsCells< FEBase >
 HoldsCells (const CepsVector< FEBase * > &cells)
 Constructor with a vector of cells. More...
 
 HoldsCells (FEBase **cells, const CepsUInt &n)
 Constructor with a vector of cells. More...
 
 HoldsCells ()=default
 Default constructor. More...
 
 HoldsCells (const HoldsCells &)=default
 Copy constructor. More...
 
 HoldsCells (HoldsCells &&) noexcept=default
 Copy constructor. More...
 
virtual ~HoldsCells ()=default
 Destructor. More...
 
HoldsCellsoperator= (const HoldsCells &)=default
 Assignment operator. More...
 
HoldsCellsoperator= (HoldsCells &&) noexcept=default
 Assignment operator. More...
 
CepsUInt getNumberOfCells () const
 Returns the number of cells in the object. More...
 
CepsUInt countValidCells ()
 Get the number of cells that are not nullptr. More...
 
CepsVector< FEBase * > getValidCells ()
 Reference to the valid cells. More...
 
CepsVector< FEBase * > & getCells ()
 Reference to the cells. More...
 
const CepsVector< FEBase * > & getCells () const
 Reference to the cells, const version. More...
 
FEBase *& getCellAt (const CepsUInt &i)
 Pointer to the i-th cell. More...
 
const FEBase *& getCellAt (const CepsUInt &i) const
 Pointer to the i-th cell , const version. More...
 
void setCells (const CepsVector< FEBase * > &cells)
 Replaces currently held cell pointers. More...
 
void setCells (FEBase **cells, const CepsUInt &n)
 Replaces currently held cell pointers. More...
 
void setCells (_It first, _It last)
 Replaces currently held cell pointers. More...
 
void setCellAt (const CepsUInt &i, FEBase *neigh)
 Set a cell pointer in the vector of currently held cells, at given index. More...
 
void addCell (FEBase *&name)
 Adds a cell to the list. More...
 
void addCells (const CepsVector< FEBase * > &cells)
 Adds several cells to the list. More...
 
void addCells (FEBase **cells, const CepsUInt &n)
 Adds several cells to the list. More...
 
void addCells (_It first, _It last)
 Adds several cells to the list. More...
 
void removeCell (FEBase *&name)
 Removes a given cell pointer from the list. More...
 
void removeCells (const CepsVector< FEBase * > &cells)
 Removes several cell pointers from the list. More...
 
void removeCells (FEBase **cells, const CepsUInt &n)
 Removes several cell pointers from the list. More...
 
void removeCells (_It first, _It last)
 Removes several cell pointers from the list. More...
 
void clearCells ()
 Wipes the current list of cell pointers. More...
 
CepsBool hasCell (FEBase *&neigh)
 Tells if object has the cell given in argument. More...
 
CepsBool hasAllCells (const CepsVector< FEBase * > &cells)
 Tells if object has all cells given in argument. More...
 
CepsBool hasAllCells (FEBase **cells, const CepsUInt &n)
 Tells if object has all cells given in argument. More...
 
CepsBool hasAllCells (_It first, _It last)
 Tells if object has all cells given in argument. More...
 
CepsBool hasOneOfCells (const CepsVector< FEBase * > &cells)
 Tells if object has one of the cells given in argument. More...
 
CepsBool hasOneOfCells (FEBase **cells, const CepsUInt &n)
 Tells if object has one of the cells given in argument. More...
 
CepsBool hasOneOfCells (_It first, _It last)
 Tells if object has one of the cells given in argument. More...
 
CepsIndex getCellIndex (CepsUInt i) const
 Get the index of i-th cell. More...
 
CepsVector< CepsIndexgetCellsIndices () const
 Get indices of all cells. More...
 
void reset ()
 Equivalent to HoldsCells::clearCells. More...
 
- Public Member Functions inherited from ceps::HoldsGlobalIndex
 HoldsGlobalIndex (const CepsGlobalIndex &gid)
 Constructor with ID. More...
 
 HoldsGlobalIndex ()=default
 Default constructor. More...
 
 HoldsGlobalIndex (const HoldsGlobalIndex &)=default
 Copy constructor. More...
 
 HoldsGlobalIndex (HoldsGlobalIndex &&) noexcept=default
 Copy constructor. More...
 
virtual ~HoldsGlobalIndex ()=default
 Destructor. More...
 
HoldsGlobalIndexoperator= (const HoldsGlobalIndex &)=default
 Assignment operator. More...
 
HoldsGlobalIndexoperator= (HoldsGlobalIndex &&) noexcept=default
 Assignment operator. More...
 
const CepsGlobalIndexgetGlobalIndex () const
 Get the index
More...
 
void setGlobalIndex (const CepsGlobalIndex &gid)
 Set the index. More...
 
void reset ()
 Set the index to 0u. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ceps::HoldsNodes< FENode >
void errorOnNodeIndex (CepsUInt i, std::source_location loc=std::source_location::current()) const
 Aborts if requesting node with wrong index. More...
 
- Protected Member Functions inherited from ceps::HoldsCells< FEBase >
void errorOnCellIndex (CepsUInt i, const CepsString &funcName) const
 Aborts if object holds less than i cells. More...
 
- Protected Attributes inherited from ceps::HoldsGeomObject< GeomNode >
CepsBool m_owned
 Is the geom object owned by current CPU. More...
 
GeomNodem_gObject
 Ptr to the object. More...
 
- Protected Attributes inherited from ceps::HoldsNodes< FENode >
CepsVector< FENode * > m_nodes
 The node pointers. More...
 
FENodem_dummyNode
 An empty node to be returned after abort when testing. More...
 
- Protected Attributes inherited from ceps::HoldsCells< FEBase >
CepsVector< FEBase * > m_cells
 The cell pointers. More...
 
- Protected Attributes inherited from ceps::HoldsGlobalIndex
CepsGlobalIndex m_globalIndex
 the index More...
 

Constructor & Destructor Documentation

◆ FENode() [1/3]

FENode::FENode ( )

Default constructor.

Definition at line 34 of file FENode.cpp.

◆ FENode() [2/3]

FENode::FENode ( GeomNode node,
CepsBool  ownedPtr = false 
)
explicit

Constructor from a geometric node.

Definition at line 42 of file FENode.cpp.

◆ FENode() [3/3]

FENode::FENode ( const FENode that)
default

Copy constructor.

◆ ~FENode()

FENode::~FENode ( )
override

Destructor.

Definition at line 57 of file FENode.cpp.

Member Function Documentation

◆ operator=()

FENode & FENode::operator= ( const FENode that)

Copy assignement.

Definition at line 50 of file FENode.cpp.

◆ setGeomObject()

void FENode::setGeomObject ( GeomNode node,
CepsBool  owned = false 
)
overridevirtual

Associate the geom node

Reimplemented from ceps::HoldsGeomObject< GeomNode >.

Definition at line 62 of file FENode.cpp.


The documentation for this class was generated from the following files: