LifeV
ZeroDimensionalElementPassiveDiode Class Reference

ZerodimentionalElementPassiveDiode - Diode. More...

#include <ZeroDimensionalCircuitData.hpp>

+ Inheritance diagram for ZeroDimensionalElementPassiveDiode:
+ Collaboration diagram for ZeroDimensionalElementPassiveDiode:

Protected Member Functions

void calculateEffectiveResistance (const Real &voltage)
 calculate the effective resistance. More...
 

Protected Attributes

Real M_alpha
 
Real M_beta
 
Real M_forwardBias
 
- Protected Attributes inherited from ZeroDimensionalElementPassive
Real M_parameter
 
vecInt_Type M_nodeIndex
 
- Protected Attributes inherited from ZeroDimensionalElement
Int M_id
 
ZeroDimensionalElementType M_type
 
Real M_current
 
Real M_deltaCurrent
 

Constructors and Destructor

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

Methods

void showMe (const Int &flag=0)
 Show some information. More...
 
void extractSolution (const ZeroDimensionalNodeS &nodes)
 Compute outputs (currents and voltages) from the solution vector after each succesful iteration. 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 setalpha (const Real &alpha)
 current = beta * exp(alpha * (voltage - forwardBias )) - (beta * exp(alpha * ( - forwardBias ))) More...
 
void setbeta (const Real &beta)
 
void setforwardBias (const Real &forwardBias)
 

Get Methods

const Real & alpha () const
 
const Real & beta () const
 
const Real & forwardBias () const
 

Additional Inherited Members

- Public Member Functions inherited from ZeroDimensionalElementPassiveResistor
 ZeroDimensionalElementPassiveResistor ()
 Contructor. More...
 
virtual ~ZeroDimensionalElementPassiveResistor ()
 Destructor. More...
 
- Public Member Functions inherited from ZeroDimensionalElementPassive
 ZeroDimensionalElementPassive ()
 Constructor. More...
 
virtual ~ZeroDimensionalElementPassive ()
 Destructor. More...
 
void connectElement (zeroDimensionalNodeSPtr_Type &nodes)
 Impleaments the abstarct class for passive elements. More...
 
void setParameter (const Real &parameter)
 set parameter (1/R, 1/L, C, 1/R_{eff}) More...
 
void setNodeIndex (const Int &index)
 add the node to the list. More...
 
const Real & parameter () const
 get the parameter (1/R, 1/L, C, 1/R_{eff}) More...
 
const Int & nodeIndex (const Int &position) const
 get the node index connected to the node. More...
 
Real direction (const Int &nodeId) 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)
 
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

ZerodimentionalElementPassiveDiode - Diode.

Authors
Mahmoud Jafargholi

Definition at line 323 of file ZeroDimensionalCircuitData.hpp.

Constructor & Destructor Documentation

◆ ZeroDimensionalElementPassiveDiode()

Constructor.

Definition at line 194 of file ZeroDimensionalCircuitData.cpp.

◆ ~ZeroDimensionalElementPassiveDiode()

virtual ~ZeroDimensionalElementPassiveDiode ( )
inlinevirtual

Destructor.

Definition at line 334 of file ZeroDimensionalCircuitData.hpp.

Member Function Documentation

◆ showMe()

void showMe ( const Int &  flag = 0)
virtual

Show some information.

Reimplemented from ZeroDimensionalElementPassiveResistor.

Definition at line 200 of file ZeroDimensionalCircuitData.cpp.

◆ extractSolution()

void extractSolution ( const ZeroDimensionalNodeS &  )
virtual

Compute outputs (currents and voltages) from the solution vector after each succesful iteration.

After each time step, when Rythmos solver is succesfully finishes, this method will compute finial outputs ( for exmple currents) from the finial solution vector.

Reimplemented from ZeroDimensionalElementPassiveResistor.

Definition at line 220 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 ZeroDimensionalElementPassiveResistor.

Definition at line 229 of file ZeroDimensionalCircuitData.cpp.

◆ setalpha()

void setalpha ( const Real &  alpha)
inline

current = beta * exp(alpha * (voltage - forwardBias )) - (beta * exp(alpha * ( - forwardBias )))

Definition at line 355 of file ZeroDimensionalCircuitData.hpp.

◆ setbeta()

void setbeta ( const Real &  beta)
inline

Definition at line 360 of file ZeroDimensionalCircuitData.hpp.

◆ setforwardBias()

void setforwardBias ( const Real &  forwardBias)
inline

Definition at line 365 of file ZeroDimensionalCircuitData.hpp.

◆ alpha()

const Real& alpha ( ) const
inline

Definition at line 376 of file ZeroDimensionalCircuitData.hpp.

◆ beta()

const Real& beta ( ) const
inline

Definition at line 381 of file ZeroDimensionalCircuitData.hpp.

◆ forwardBias()

const Real& forwardBias ( ) const
inline

Definition at line 386 of file ZeroDimensionalCircuitData.hpp.

◆ calculateEffectiveResistance()

void calculateEffectiveResistance ( const Real &  voltage)
protected

calculate the effective resistance.

Parameters
voltagedifference
Returns
effective ressitance

Definition at line 205 of file ZeroDimensionalCircuitData.cpp.

+ Here is the caller graph for this function:

Field Documentation

◆ M_alpha

Real M_alpha
protected

Definition at line 402 of file ZeroDimensionalCircuitData.hpp.

◆ M_beta

Real M_beta
protected

Definition at line 403 of file ZeroDimensionalCircuitData.hpp.

◆ M_forwardBias

Real M_forwardBias
protected

Definition at line 404 of file ZeroDimensionalCircuitData.hpp.


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