LifeV
ZeroDimensionalElementCurrentSource Class Reference

ZeroDimensionalElementCurrentSource - Current Source. More...

#include <ZeroDimensionalCircuitData.hpp>

+ Inheritance diagram for ZeroDimensionalElementCurrentSource:
+ Collaboration diagram for ZeroDimensionalElementCurrentSource:

Constructors and Destructor

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

Methods

void connectElement (zeroDimensionalNodeSPtr_Type &Nodes)
 Connect elements to the nodes. More...
 
void buildABC (matrix_Type &A, matrix_Type &B, vector_Type &C, const zeroDimensionalNodeSPtr_Type &Nodes)
 Contribution of the element of matrix {A} and {B} and vector {C}. More...
 

set Methods

void setCurrentByTime (const Real &time)
 

Get Methods

Real currentByTime (const Real &time) const
 
Real current () const
 

Additional Inherited Members

- Public Member Functions inherited from ZeroDimensionalElementSource
 ZeroDimensionalElementSource ()
 Constructor. More...
 
virtual ~ZeroDimensionalElementSource ()
 Destructor. More...
 
void showMe (const Int &flag=0)
 Display some information. More...
 
void setNodeIndex (const Real &index)
 
void setBC (const bcPtr_Type &bc)
 Set BC handler. More...
 
Int nodeIndex () const
 
Real direction (const Int &) const
 This method specifies the convention of current direction in an element. More...
 
- Public Member Functions inherited from ZeroDimensionalElement
 ZeroDimensionalElement ()
 Constructor. More...
 
virtual ~ZeroDimensionalElement ()
 Destructor. More...
 
const std::string enum2string (const ZeroDimensionalElementType &type)
 
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 Intid () const
 
const ZeroDimensionalElementTypetype () const
 
const Realcurrent () const
 
const RealdeltaCurrent () const
 Get derivative of current respect to time. More...
 
- Protected Attributes inherited from ZeroDimensionalElementSource
Int M_nodeIndex
 
bcPtr_Type M_bc
 
- Protected Attributes inherited from ZeroDimensionalElement
Int M_id
 
ZeroDimensionalElementType M_type
 
Real M_current
 
Real M_deltaCurrent
 

Detailed Description

ZeroDimensionalElementCurrentSource - Current Source.

Authors
Mahmoud Jafargholi

Definition at line 661 of file ZeroDimensionalCircuitData.hpp.

Constructor & Destructor Documentation

◆ ZeroDimensionalElementCurrentSource()

Constructor.

Definition at line 434 of file ZeroDimensionalCircuitData.cpp.

◆ ~ZeroDimensionalElementCurrentSource()

virtual ~ZeroDimensionalElementCurrentSource ( )
inlinevirtual

Destructor.

Definition at line 673 of file ZeroDimensionalCircuitData.hpp.

Member Function Documentation

◆ connectElement()

void connectElement ( zeroDimensionalNodeSPtr_Type nodes)
virtual

Connect elements to the nodes.

After all emenets and nodes are created, each element will call this method to connect itself to the nodes.

Implements ZeroDimensionalElement.

Definition at line 439 of file ZeroDimensionalCircuitData.cpp.

◆ buildABC()

void buildABC ( matrix_Type ,
matrix_Type ,
vector_Type ,
const zeroDimensionalNodeSPtr_Type  
)
virtual

Contribution of the element of matrix {A} and {B} and vector {C}.

After updating the BCs ( or Terminal nodes ) this each element will invoke this method to compute it's contribution on matrices.

Reimplemented from ZeroDimensionalElement.

Definition at line 448 of file ZeroDimensionalCircuitData.cpp.

◆ setCurrentByTime()

void setCurrentByTime ( const Real time)
inline

Definition at line 691 of file ZeroDimensionalCircuitData.hpp.

◆ currentByTime()

Real currentByTime ( const Real time) const
inline

Definition at line 702 of file ZeroDimensionalCircuitData.hpp.

◆ current()

Real current ( ) const
inline

Definition at line 707 of file ZeroDimensionalCircuitData.hpp.


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