LifeV
ZeroDimensionalCircuitData Class Reference

ZeroDimensionalCircuitData - Container of circuit data. More...

#include <ZeroDimensionalCircuitData.hpp>

+ Collaboration diagram for ZeroDimensionalCircuitData:

Public Member Functions

void showMe (const Int &flag=0)
 
void buildCircuit (const char *fileName, bcPtr_Type bc)
 create the circuit. More...
 
const zeroDimensionalElementSPtr_Type Elements () const
 get element container object. More...
 
const zeroDimensionalNodeSPtr_Type Nodes () const
 get node container object. More...
 
void updateCircuitDataFromY (const Real &t, const Epetra_Vector *y, const Epetra_Vector *yp)
 (shallow) update the circuit data from the solution. More...
 
void updateABC (matrix_Type &A, matrix_Type &B, vector_Type &C)
 create matrix A,B and C. More...
 
void extractSolutionFromY (const Real &t, const Epetra_Vector &y, const Epetra_Vector &yp)
 (deep) update the circuit data from solution. More...
 

Protected Member Functions

void fixBC (bcPtr_Type bc)
 
void createElementResistor (Int ID, Int node1, Int node2, Real parameter)
 
void createElementCapacitor (Int ID, Int node1, Int node2, Real parameter)
 
void createElementInductor (Int ID, Int node1, Int node2, Real parameter)
 
void createElementDiode (Int ID, Int node1, Int node2, Real forwardBias, Real alpha, Real beta)
 
Int createElementVoltageSource (Int node1)
 
void createElementCurrentSource (Int node1)
 
void createUnknownNode (const Int &id)
 
void createKnownNode (const Int &id)
 
void createKnownNode (const Int &id, const zeroDimensionalElementVoltageSourcePtr_Type &theElement)
 

Protected Attributes

zeroDimensionalElementSPtr_Type M_Elements
 
zeroDimensionalNodeSPtr_Type M_Nodes
 
bcPtr_Type M_bc
 

Constructors and Destructor

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

Detailed Description

ZeroDimensionalCircuitData - Container of circuit data.

Authors
Mahmoud Jafargholi

Definition at line 1333 of file ZeroDimensionalCircuitData.hpp.

Constructor & Destructor Documentation

◆ ZeroDimensionalCircuitData()

Constructor.

Definition at line 603 of file ZeroDimensionalCircuitData.cpp.

+ Here is the caller graph for this function:

◆ ~ZeroDimensionalCircuitData()

virtual ~ZeroDimensionalCircuitData ( )
inlinevirtual

Destructor.

Definition at line 1344 of file ZeroDimensionalCircuitData.hpp.

Member Function Documentation

◆ showMe()

void showMe ( const Int flag = 0)

Definition at line 609 of file ZeroDimensionalCircuitData.cpp.

◆ buildCircuit()

void buildCircuit ( const char *  fileName,
bcPtr_Type  bc 
)

create the circuit.

Parameters
circuitfile
BChandler

Definition at line 618 of file ZeroDimensionalCircuitData.cpp.

◆ Elements()

const zeroDimensionalElementSPtr_Type Elements ( ) const
inline

get element container object.

Definition at line 1358 of file ZeroDimensionalCircuitData.hpp.

◆ Nodes()

const zeroDimensionalNodeSPtr_Type Nodes ( ) const
inline

get node container object.

Definition at line 1364 of file ZeroDimensionalCircuitData.hpp.

◆ updateCircuitDataFromY()

void updateCircuitDataFromY ( const Real t,
const Epetra_Vector *  y,
const Epetra_Vector *  yp 
)

(shallow) update the circuit data from the solution.

This method is invoked every iteration before calling the updateABC method. This method updates the circuit data which is dependent on time or solution vector. For example source elements are function of time and diode R_{eff} are function of voltage difference.

Definition at line 927 of file ZeroDimensionalCircuitData.cpp.

◆ updateABC()

void updateABC ( matrix_Type A,
matrix_Type B,
vector_Type C 
)

create matrix A,B and C.

before calling this method, updateCircuitDataFromY method should be invoked.

Definition at line 993 of file ZeroDimensionalCircuitData.cpp.

◆ extractSolutionFromY()

void extractSolutionFromY ( const Real t,
const Epetra_Vector &  y,
const Epetra_Vector &  yp 
)

(deep) update the circuit data from solution.

This methed is invoked after Rythoms step is finished. This method computes currents.

Definition at line 963 of file ZeroDimensionalCircuitData.cpp.

◆ fixBC()

void fixBC ( bcPtr_Type  bc)
protected

Definition at line 909 of file ZeroDimensionalCircuitData.cpp.

+ Here is the caller graph for this function:

◆ createElementResistor()

void createElementResistor ( Int  ID,
Int  node1,
Int  node2,
Real  parameter 
)
protected

Definition at line 779 of file ZeroDimensionalCircuitData.cpp.

+ Here is the caller graph for this function:

◆ createElementCapacitor()

void createElementCapacitor ( Int  ID,
Int  node1,
Int  node2,
Real  parameter 
)
protected

Definition at line 802 of file ZeroDimensionalCircuitData.cpp.

+ Here is the caller graph for this function:

◆ createElementInductor()

void createElementInductor ( Int  ID,
Int  node1,
Int  node2,
Real  parameter 
)
protected

Definition at line 820 of file ZeroDimensionalCircuitData.cpp.

+ Here is the caller graph for this function:

◆ createElementDiode()

void createElementDiode ( Int  ID,
Int  node1,
Int  node2,
Real  forwardBias,
Real  alpha,
Real  beta 
)
protected

Definition at line 839 of file ZeroDimensionalCircuitData.cpp.

+ Here is the caller graph for this function:

◆ createElementVoltageSource()

Int createElementVoltageSource ( Int  node1)
protected

Definition at line 863 of file ZeroDimensionalCircuitData.cpp.

◆ createElementCurrentSource()

void createElementCurrentSource ( Int  node1)
protected

Definition at line 873 of file ZeroDimensionalCircuitData.cpp.

◆ createUnknownNode()

void createUnknownNode ( const Int id)
protected

Definition at line 882 of file ZeroDimensionalCircuitData.cpp.

+ Here is the caller graph for this function:

◆ createKnownNode() [1/2]

void createKnownNode ( const Int id)
protected

Definition at line 901 of file ZeroDimensionalCircuitData.cpp.

◆ createKnownNode() [2/2]

void createKnownNode ( const Int id,
const zeroDimensionalElementVoltageSourcePtr_Type theElement 
)
protected

Definition at line 891 of file ZeroDimensionalCircuitData.cpp.

Field Documentation

◆ M_Elements

zeroDimensionalElementSPtr_Type M_Elements
protected

Definition at line 1405 of file ZeroDimensionalCircuitData.hpp.

◆ M_Nodes

zeroDimensionalNodeSPtr_Type M_Nodes
protected

Definition at line 1406 of file ZeroDimensionalCircuitData.hpp.

◆ M_bc

bcPtr_Type M_bc
protected

Definition at line 1407 of file ZeroDimensionalCircuitData.hpp.


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