LifeV
ZeroDimensionalElementPassiveInductor Class Reference

ZeroDimensionalElementPassiveInductor - Inductor. More...

#include <ZeroDimensionalCircuitData.hpp>

+ Inheritance diagram for ZeroDimensionalElementPassiveInductor:
+ Collaboration diagram for ZeroDimensionalElementPassiveInductor:

Protected Attributes

Int M_equationRow
 
Int M_variableIndex
 
- 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

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

Methods

virtual void assignVariableIndex (const Int &index)
 Set the variable index and equation row index for Inductor. More...
 
void showMe (const Int &flag=0)
 Show some information. 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...
 

Get Methods

const Int & equationRow () const
 get equation row for in matrix A,B and C. More...
 
const Int & variableIndex () const
 get variable index in solution vector

\[x\]

and

\[\dot{x}\]

More...
 

Additional Inherited Members

- 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)
 
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

ZeroDimensionalElementPassiveInductor - Inductor.

Authors
Mahmoud Jafargholi

Definition at line 446 of file ZeroDimensionalCircuitData.hpp.

Constructor & Destructor Documentation

◆ ZeroDimensionalElementPassiveInductor()

Constructor.

Definition at line 299 of file ZeroDimensionalCircuitData.cpp.

◆ ~ZeroDimensionalElementPassiveInductor()

virtual ~ZeroDimensionalElementPassiveInductor ( )
inlinevirtual

Destructor.

Definition at line 457 of file ZeroDimensionalCircuitData.hpp.

Member Function Documentation

◆ assignVariableIndex()

void assignVariableIndex ( const Int &  index)
virtual

Set the variable index and equation row index for Inductor.

Current in Inductor is an unknown.

Definition at line 318 of file ZeroDimensionalCircuitData.cpp.

◆ showMe()

void showMe ( const Int &  flag = 0)
virtual

Show some information.

Reimplemented from ZeroDimensionalElementPassive.

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

◆ equationRow()

const Int& equationRow ( ) const
inline

get equation row for in matrix A,B and C.

Definition at line 482 of file ZeroDimensionalCircuitData.hpp.

◆ variableIndex()

const Int& variableIndex ( ) const
inline

get variable index in solution vector

\[x\]

and

\[\dot{x}\]

Definition at line 488 of file ZeroDimensionalCircuitData.hpp.

Field Documentation

◆ M_equationRow

Int M_equationRow
protected

Definition at line 496 of file ZeroDimensionalCircuitData.hpp.

◆ M_variableIndex

Int M_variableIndex
protected

Definition at line 497 of file ZeroDimensionalCircuitData.hpp.


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