Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

inductor Class Reference

A series or parallel 2-port inductor, derived from class spimp. More...

#include <elements.h>

Inheritance diagram for inductor::

spimp nport device List of all members.

Public Methods

 inductor (double i=0.0)
 Constructor sets the inductance to 0 by default. More...

 inductor (const abstract_real_parameter *i)
 Construct a shadowed parameter inductance. More...

inductor& set (double i)
 Set the inductance. More...

inductor& set (abstract_real_parameter *i)
 Set the inductance to shadow a parameter. More...


Public Attributes

parameter L
 Inductance in standard units. More...


Private Methods

void recalc ()
 The function for calculating sdata. More...


Detailed Description

A series or parallel 2-port inductor, derived from class spimp.

It has one real member parameter:

Its inductance may be set during construction as well. Example:
    inductor m(2*Nano*Henry); // an inductor named "m"
 

Definition at line 320 of file elements.h.


Constructor & Destructor Documentation

inductor::inductor ( double i = 0.0 ) [inline, explicit]
 

Constructor sets the inductance to 0 by default.

Definition at line 331 of file elements.h.

inductor::inductor ( const abstract_real_parameter * i ) [inline, explicit]
 

Construct a shadowed parameter inductance.

Parameters:
i   pointer to the parameter to be shadowed.

Definition at line 339 of file elements.h.


Member Function Documentation

void inductor::recalc ( ) [inline, private, virtual]
 

The function for calculating sdata.

recalc() should do the following:

  • (1) Read device::f, device::Z0, and, by default, device::T to get the operating conditions for the response calculation.
  • (2) Calculate the S, C, and B matrix values and store them to nport::data, with all values normalized using device::Z0.
  • (3) Store the normalizing impedance to nport::data by calling data.set_znorm().

Reimplemented from nport.

Definition at line 360 of file elements.h.

inductor & inductor::set ( abstract_real_parameter * i ) [inline]
 

Set the inductance to shadow a parameter.

Parameters:
i   parameter of inductance in standard units.

Definition at line 355 of file elements.h.

inductor & inductor::set ( double i ) [inline]
 

Set the inductance.

Parameters:
i   inductance in standard units.

Definition at line 347 of file elements.h.


Member Data Documentation

parameter inductor::L
 

Inductance in standard units.

Definition at line 326 of file elements.h.


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

Please direct comments and corrections to supermix@submm.caltech.edu
Go to the supermix home page
Generated by doxygen1.2.7