LifeV
ZeroDimensionalElementVoltageSource Class Reference

ZeroDimensionalElementVoltageSource - Voltage Source. More...

#include <ZeroDimensionalCircuitData.hpp>

+ Inheritance diagram for ZeroDimensionalElementVoltageSource:
+ Collaboration diagram for ZeroDimensionalElementVoltageSource:

Protected Attributes

Real M_voltage
 
Real M_deltaVoltage
 
- 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
 

Constructors and Destructor

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

Get Methods

void connectElement (zeroDimensionalNodeSPtr_Type &Nodes)
 Connect elements to the nodes. More...
 
void calculateCurrent (const ZeroDimensionalNodeS &Nodes, const ZeroDimensionalElementS &Elements)
 calculate current passing outward in voltage source. More...
 
const Realvoltage () const
 
Real deltaVoltage () const
 
Real voltageByTime (const Real &time) const
 
Real deltaVoltageByTime (const Real &time) const
 

Set Methods

void setVoltageByTime (const Real &time)
 Update voltage source by time. More...
 
void setDeltaVoltageByTime (const Real &time)
 Update { voltage}{ t} by time. More...
 

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 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 Intid () const
 
const ZeroDimensionalElementTypetype () const
 
const Realcurrent () const
 
const RealdeltaCurrent () const
 Get derivative of current respect to time. More...
 

Detailed Description

ZeroDimensionalElementVoltageSource - Voltage Source.

Authors
Mahmoud Jafargholi

Definition at line 575 of file ZeroDimensionalCircuitData.hpp.

Constructor & Destructor Documentation

◆ ZeroDimensionalElementVoltageSource()

Constructor.

Definition at line 399 of file ZeroDimensionalCircuitData.cpp.

◆ ~ZeroDimensionalElementVoltageSource()

virtual ~ZeroDimensionalElementVoltageSource ( )
inlinevirtual

Destructor.

Definition at line 587 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 406 of file ZeroDimensionalCircuitData.cpp.

◆ calculateCurrent()

void calculateCurrent ( const ZeroDimensionalNodeS Nodes,
const ZeroDimensionalElementS Elements 
)

calculate current passing outward in voltage source.

This method can be called after all elements invoked extractSolution method.

Definition at line 413 of file ZeroDimensionalCircuitData.cpp.

◆ setVoltageByTime()

void setVoltageByTime ( const Real time)
inline

Update voltage source by time.

Definition at line 610 of file ZeroDimensionalCircuitData.hpp.

◆ setDeltaVoltageByTime()

void setDeltaVoltageByTime ( const Real time)
inline

Update { voltage}{ t} by time.

Definition at line 616 of file ZeroDimensionalCircuitData.hpp.

◆ voltage()

const Real& voltage ( ) const
inline

Definition at line 627 of file ZeroDimensionalCircuitData.hpp.

◆ deltaVoltage()

Real deltaVoltage ( ) const
inline

Definition at line 632 of file ZeroDimensionalCircuitData.hpp.

◆ voltageByTime()

Real voltageByTime ( const Real time) const
inline

Definition at line 637 of file ZeroDimensionalCircuitData.hpp.

◆ deltaVoltageByTime()

Real deltaVoltageByTime ( const Real time) const
inline

Definition at line 642 of file ZeroDimensionalCircuitData.hpp.

Field Documentation

◆ M_voltage

Real M_voltage
protected

Definition at line 651 of file ZeroDimensionalCircuitData.hpp.

◆ M_deltaVoltage

Real M_deltaVoltage
protected

Definition at line 652 of file ZeroDimensionalCircuitData.hpp.


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