LifeV
ZeroDimensionalElementSource Class Reference

ZeroDimensionalElementSource - Base class for source elements. More...

#include <ZeroDimensionalCircuitData.hpp>

+ Inheritance diagram for ZeroDimensionalElementSource:
+ Collaboration diagram for ZeroDimensionalElementSource:

Protected Attributes

Int M_nodeIndex
 
bcPtr_Type M_bc
 
- Protected Attributes inherited from ZeroDimensionalElement
Int M_id
 
ZeroDimensionalElementType M_type
 
Real M_current
 
Real M_deltaCurrent
 

Constructors and Destructor

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

Methods

void showMe (const Int &flag=0)
 Display some information. More...
 

Set Methods

void setNodeIndex (const Real &index)
 
void setBC (const bcPtr_Type &bc)
 Set BC handler. More...
 

Get Methods

Int nodeIndex () const
 
Real direction (const Int &) const
 This method specifies the convention of current direction in an element. More...
 

Additional Inherited Members

- Public Member Functions inherited from ZeroDimensionalElement
 ZeroDimensionalElement ()
 Constructor. More...
 
virtual ~ZeroDimensionalElement ()
 Destructor. More...
 
const std::string enum2string (const ZeroDimensionalElementType &type)
 
virtual void connectElement (zeroDimensionalNodeSPtr_Type &nodes)=0
 Connect elements to the nodes. More...
 
virtual void buildABC (matrix_Type &, matrix_Type &, vector_Type &, const zeroDimensionalNodeSPtr_Type &)
 Contribution of the element of matrix {A} and {B} and vector {C}. More...
 
virtual void extractSolution (const ZeroDimensionalNodeS &)
 Compute outputs (currents and voltages) from the solution vector after each succesful iteration. More...
 
void setId (const Int &id)
 
void setCurrent (const Real &current)
 
void setDeltaCurrent (const Real &deltaCurrent)
 Set derivative of current respect to time. More...
 
const Int & id () const
 
const ZeroDimensionalElementType & type () const
 
const Real & current () const
 
const Real & deltaCurrent () const
 Get derivative of current respect to time. More...
 

Detailed Description

ZeroDimensionalElementSource - Base class for source elements.

Authors
Mahmoud Jafargholi

Definition at line 506 of file ZeroDimensionalCircuitData.hpp.

Constructor & Destructor Documentation

◆ ZeroDimensionalElementSource()

Constructor.

Definition at line 384 of file ZeroDimensionalCircuitData.cpp.

◆ ~ZeroDimensionalElementSource()

virtual ~ZeroDimensionalElementSource ( )
inlinevirtual

Destructor.

Definition at line 518 of file ZeroDimensionalCircuitData.hpp.

Member Function Documentation

◆ showMe()

void showMe ( const Int &  flag = 0)
virtual

Display some information.

Reimplemented from ZeroDimensionalElement.

Definition at line 390 of file ZeroDimensionalCircuitData.cpp.

◆ setNodeIndex()

void setNodeIndex ( const Real &  index)
inline

Definition at line 534 of file ZeroDimensionalCircuitData.hpp.

◆ setBC()

void setBC ( const bcPtr_Type &  bc)
inline

Set BC handler.

Definition at line 540 of file ZeroDimensionalCircuitData.hpp.

◆ nodeIndex()

Int nodeIndex ( ) const
inline

Definition at line 551 of file ZeroDimensionalCircuitData.hpp.

◆ direction()

Real direction ( const Int &  nodeId) const
inlinevirtual

This method specifies the convention of current direction in an element.

Parameters
Anode index connected to the element.
Returns
+1 if the current convention is toward the iniput node and -1 otherwise.

Implements ZeroDimensionalElement.

Definition at line 556 of file ZeroDimensionalCircuitData.hpp.

Field Documentation

◆ M_nodeIndex

Int M_nodeIndex
protected

Definition at line 565 of file ZeroDimensionalCircuitData.hpp.

◆ M_bc

bcPtr_Type M_bc
protected

Definition at line 566 of file ZeroDimensionalCircuitData.hpp.


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