LifeV
ZeroDimensionalNode Class Reference

ZeroDimensionalNode - The base node class. More...

#include <ZeroDimensionalCircuitData.hpp>

+ Inheritance diagram for ZeroDimensionalNode:
+ Collaboration diagram for ZeroDimensionalNode:

Protected Attributes

Int M_id
 
ZeroDimensionalNodeType M_type
 
Real M_currentBalance
 
vecInt_Type M_elementListIndex
 
vecInt_Type M_nodeListIndex
 
Real M_voltage
 
Real M_deltaVoltage
 

Constructors and Destructor

 ZeroDimensionalNode ()
 Constructor. More...
 
virtual ~ZeroDimensionalNode ()
 Destructor. More...
 

Methods

void calculateCurrentBalance (const ZeroDimensionalElementS &Elements)
 Calculate current balance at node. More...
 
virtual void showMe (const Int &flag=0)
 

Set Methods

const std::string enum2string (const ZeroDimensionalNodeType &type) const
 
void setId (const Int &id)
 
void setElementListIndex (const Int &index)
 add an element index to the elelemt list. More...
 
void setNodeListIndex (const Int &index)
 add an node index which is connected by an element in element list. More...
 
virtual void setVoltage (const Real &voltage)
 
virtual void setDeltaVoltage (const Real &deltaVoltage)
 

Get Methods

const Int & id () const
 
const ZeroDimensionalNodeType & type () const
 
const Int & elementListIndexAt (const Int &position) const
 
const vecInt_Type & elementListIndex () const
 
const Int & nodeListIndexAt (const Int &position) const
 
virtual const Real & voltage () const
 
virtual Real deltaVoltage () const
 
const Real & currentBalance () const
 

Detailed Description

ZeroDimensionalNode - The base node class.

Authors
Mahmoud Jafargholi

Definition at line 764 of file ZeroDimensionalCircuitData.hpp.

Constructor & Destructor Documentation

◆ ZeroDimensionalNode()

ZeroDimensionalNode ( )
explicit

Constructor.

Definition at line 470 of file ZeroDimensionalCircuitData.cpp.

◆ ~ZeroDimensionalNode()

virtual ~ZeroDimensionalNode ( )
inlinevirtual

Destructor.

Definition at line 775 of file ZeroDimensionalCircuitData.hpp.

Member Function Documentation

◆ calculateCurrentBalance()

void calculateCurrentBalance ( const ZeroDimensionalElementS &  Elements)

Calculate current balance at node.

After updating current in all elements, we can verify the balance of current flow at each node.

Definition at line 510 of file ZeroDimensionalCircuitData.cpp.

◆ showMe()

void showMe ( const Int &  flag = 0)
virtual

Reimplemented in ZeroDimensionalNodeUnknown.

Definition at line 475 of file ZeroDimensionalCircuitData.cpp.

+ Here is the caller graph for this function:

◆ enum2string()

const std::string enum2string ( const ZeroDimensionalNodeType &  type) const

Definition at line 490 of file ZeroDimensionalCircuitData.cpp.

◆ setId()

void setId ( const Int &  id)
inline

Definition at line 799 of file ZeroDimensionalCircuitData.hpp.

◆ setElementListIndex()

void setElementListIndex ( const Int &  index)
inline

add an element index to the elelemt list.

Definition at line 805 of file ZeroDimensionalCircuitData.hpp.

◆ setNodeListIndex()

void setNodeListIndex ( const Int &  index)
inline

add an node index which is connected by an element in element list.

Each elelemnt in element list, coonects this node to another node ( except source elementt). nodeList is a container for conecting nodes. If the element connected to this node has only one terminal ( like voltage source and current source), the connecting index would be -1.

Definition at line 815 of file ZeroDimensionalCircuitData.hpp.

◆ setVoltage()

virtual void setVoltage ( const Real &  voltage)
inlinevirtual

Definition at line 820 of file ZeroDimensionalCircuitData.hpp.

◆ setDeltaVoltage()

virtual void setDeltaVoltage ( const Real &  deltaVoltage)
inlinevirtual

Definition at line 825 of file ZeroDimensionalCircuitData.hpp.

◆ id()

const Int& id ( ) const
inline

Definition at line 836 of file ZeroDimensionalCircuitData.hpp.

+ Here is the caller graph for this function:

◆ type()

const ZeroDimensionalNodeType& type ( ) const
inline

Definition at line 841 of file ZeroDimensionalCircuitData.hpp.

+ Here is the caller graph for this function:

◆ elementListIndexAt()

const Int& elementListIndexAt ( const Int &  position) const
inline

Definition at line 846 of file ZeroDimensionalCircuitData.hpp.

◆ elementListIndex()

const vecInt_Type& elementListIndex ( ) const
inline

Definition at line 851 of file ZeroDimensionalCircuitData.hpp.

+ Here is the caller graph for this function:

◆ nodeListIndexAt()

const Int& nodeListIndexAt ( const Int &  position) const
inline

Definition at line 856 of file ZeroDimensionalCircuitData.hpp.

◆ voltage()

virtual const Real& voltage ( ) const
inlinevirtual

Reimplemented in ZeroDimensionalNodeKnown.

Definition at line 861 of file ZeroDimensionalCircuitData.hpp.

+ Here is the caller graph for this function:

◆ deltaVoltage()

virtual Real deltaVoltage ( ) const
inlinevirtual

Definition at line 866 of file ZeroDimensionalCircuitData.hpp.

+ Here is the caller graph for this function:

◆ currentBalance()

const Real& currentBalance ( ) const
inline

Definition at line 871 of file ZeroDimensionalCircuitData.hpp.

Field Documentation

◆ M_id

Int M_id
protected

Definition at line 880 of file ZeroDimensionalCircuitData.hpp.

◆ M_type

ZeroDimensionalNodeType M_type
protected

Definition at line 881 of file ZeroDimensionalCircuitData.hpp.

◆ M_currentBalance

Real M_currentBalance
protected

Definition at line 882 of file ZeroDimensionalCircuitData.hpp.

◆ M_elementListIndex

vecInt_Type M_elementListIndex
protected

Definition at line 883 of file ZeroDimensionalCircuitData.hpp.

◆ M_nodeListIndex

vecInt_Type M_nodeListIndex
protected

Definition at line 884 of file ZeroDimensionalCircuitData.hpp.

◆ M_voltage

Real M_voltage
protected

Definition at line 885 of file ZeroDimensionalCircuitData.hpp.

◆ M_deltaVoltage

Real M_deltaVoltage
protected

Definition at line 886 of file ZeroDimensionalCircuitData.hpp.


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