ZeroDimensionalElementPassive Class Reference

ZeroDimensionalElementPassive - A class for passive elements. More...

#include <ZeroDimensionalCircuitData.hpp>

Inheritance diagram for ZeroDimensionalElementPassive:

Collaboration diagram for ZeroDimensionalElementPassive:

Protected Attributes
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
	ZeroDimensionalElementPassive ()
	Constructor. More...
virtual	~ZeroDimensionalElementPassive ()
	Destructor. More...

Methods
void	showMe (const Int &flag=0)
	Show some information. More...
void	connectElement (zeroDimensionalNodeSPtr_Type &nodes)
	Impleaments the abstarct class for passive elements. More...

Set Methods
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...

Get Methods
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...

Additional Inherited Members
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 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

ZeroDimensionalElementPassive - A class for passive elements.

Authors

Mahmoud Jafargholi

Definition at line 201 of file ZeroDimensionalCircuitData.hpp.

Constructor & Destructor Documentation

ZeroDimensionalElementPassive()

ZeroDimensionalElementPassive ( )

explicit

Constructor.

Definition at line 96 of file ZeroDimensionalCircuitData.cpp.

~ZeroDimensionalElementPassive()

virtual ~ZeroDimensionalElementPassive ( )

inlinevirtual

Destructor.

Definition at line 212 of file ZeroDimensionalCircuitData.hpp.

Member Function Documentation

showMe()

void showMe ( const Int &  flag = 0 )

virtual

Show some information.

Reimplemented from ZeroDimensionalElement.

Reimplemented in ZeroDimensionalElementPassiveInductor, ZeroDimensionalElementPassiveCapacitor, ZeroDimensionalElementPassiveDiode, and ZeroDimensionalElementPassiveResistor.

Definition at line 102 of file ZeroDimensionalCircuitData.cpp.

Here is the caller graph for this function:

connectElement()

void connectElement ( zeroDimensionalNodeSPtr_Type &  nodes )

virtual

Impleaments the abstarct class for passive elements.

Implements ZeroDimensionalElement.

Definition at line 108 of file ZeroDimensionalCircuitData.cpp.

setParameter()

void setParameter ( const Real &  parameter )

inline

set parameter (1/R, 1/L, C, 1/R_{eff})

Definition at line 233 of file ZeroDimensionalCircuitData.hpp.

setNodeIndex()

void setNodeIndex ( const Int &  index )

inline

add the node to the list.

Parameters

node

index.

Definition at line 242 of file ZeroDimensionalCircuitData.hpp.

parameter()

const Real& parameter ( ) const

inline

get the parameter (1/R, 1/L, C, 1/R_{eff})

Definition at line 254 of file ZeroDimensionalCircuitData.hpp.

nodeIndex()

const Int& nodeIndex ( const Int &  position ) const

inline

get the node index connected to the node.

Parameters

Definition at line 264 of file ZeroDimensionalCircuitData.hpp.

direction()

Real direction ( const Int &  nodeId ) const

virtual

This method specifies the convention of current direction in an element.

Parameters

A	node index connected to the element.

Returns

+1 if the current convention is toward the iniput node and -1 otherwise.

Implements ZeroDimensionalElement.

Definition at line 125 of file ZeroDimensionalCircuitData.cpp.

Field Documentation

M_parameter

Real M_parameter

protected

Definition at line 278 of file ZeroDimensionalCircuitData.hpp.

M_nodeIndex

vecInt_Type M_nodeIndex

protected

Definition at line 279 of file ZeroDimensionalCircuitData.hpp.

---

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

• ZeroDimensionalCircuitData.hpp
• ZeroDimensionalCircuitData.cpp