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

series_RLC Class Reference

A two port series RLC device, derived from class spimp. More...

#include <elements.h>

Inheritance diagram for series_RLC::

spimp nport device List of all members.

Public Methods

 series_RLC (double r=0.0, double l=0.0, double c=0.0)
 Default constructor sets temperature to shadow device::T. More...

series_RLC& set_R (double r)
 Set the resistance. More...

series_RLC& set_R (abstract_real_parameter *r)
 Set the resistance to shadow a parameter. More...

series_RLC& set_L (double l)
 Set the inductance. More...

series_RLC& set_L (abstract_real_parameter *l)
 Set the inductance to shadow a parameter. More...

series_RLC& set_C (double c)
 Set the capacitance. More...

series_RLC& set_C (abstract_real_parameter *c)
 Set the capacitance to shadow a parameter. More...

series_RLC& set_T (double t)
 Set the temperature. More...

series_RLC& set_T (abstract_real_parameter *t)
 Set the temperature to shadow a parameter. More...

const nport::data_info& get_data_info ()
 Is an "active" noise source if its temperature is not the global T. More...


Public Attributes

parameter R
 Resistance in standard units. More...

parameter L
 Inductance in standard units. More...

parameter C
 Capacitance in standard units. More...

parameter Temp
 Temperature in standard units. More...


Private Methods

void recalc_S ()
 If the following function is implemented, it should only calculate the S matrix and B vector parts of data, leaving the C matrix part stale. More...

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

Detailed Description

A two port series RLC device, derived from class spimp.

The impedance of a series_RLC is that of a series resistor, capacitor, and inductor. The order of the components is mathematically irrelevant, since the impedance is the sum of the individual impedances, and the scattering and noise correlation matrices are functions only of the impedance.

The resulting impedance of the series RLC combination is connected either in series with or in parallel with the two ports, as described for class spimp.

series_RLC has four real member parameters:

The RLC values may be set during construction as well. Example: 
    series_RLC a(.01*Ohm, .2*Nano*Henry, 1*Pico*Farad);

This device may be useful if you need a simple but more accurate model of some real lumped circuit element.

Definition at line 393 of file elements.h.

Constructor & Destructor Documentation

series_RLC::series_RLC ( double r = 0.0,
double l = 0.0,
double c = 0.0 ) [inline, explicit]
 

Default constructor sets temperature to shadow device::T.

Parameters:
r   the resistance in standard units. Defaults to 0.
l   the inductance in standard units. Defaults to 0.
c   the capacitance in standard units. Defaults to 0.

Definition at line 418 of file elements.h.

Member Function Documentation

const nport::data_info & series_RLC::get_data_info ( ) [inline, virtual]
 

Is an "active" noise source if its temperature is not the global T.

Reimplemented from nport.

Definition at line 490 of file elements.h.

void series_RLC::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 506 of file elements.h.

void series_RLC::recalc_S ( ) [inline, private, virtual]
 

If the following function is implemented, it should only calculate the S matrix and B vector parts of data, leaving the C matrix part stale.

Reimplemented from nport.

Definition at line 495 of file elements.h.

series_RLC & series_RLC::set_C ( abstract_real_parameter * c ) [inline]
 

Set the capacitance to shadow a parameter.

Parameters:
c   parameter of capacitance in standard units.

Definition at line 468 of file elements.h.

series_RLC & series_RLC::set_C ( double c ) [inline]
 

Set the capacitance.

Parameters:
c   the capacitance in standard units.

Definition at line 460 of file elements.h.

series_RLC & series_RLC::set_L ( abstract_real_parameter * l ) [inline]
 

Set the inductance to shadow a parameter.

Parameters:
l   parameter of inductance in standard units.

Definition at line 452 of file elements.h.

series_RLC & series_RLC::set_L ( double l ) [inline]
 

Set the inductance.

Parameters:
l   the inductance in standard units.

Definition at line 444 of file elements.h.

series_RLC & series_RLC::set_R ( abstract_real_parameter * r ) [inline]
 

Set the resistance to shadow a parameter.

Parameters:
r   parameter of resistance in standard units.

Definition at line 436 of file elements.h.

series_RLC & series_RLC::set_R ( double r ) [inline]
 

Set the resistance.

Parameters:
r   the resistance in standard units.

Definition at line 428 of file elements.h.

series_RLC & series_RLC::set_T ( abstract_real_parameter * t ) [inline]
 

Set the temperature to shadow a parameter.

Parameters:
t   parameter of temperature in standard units.

Definition at line 484 of file elements.h.

series_RLC & series_RLC::set_T ( double t ) [inline]
 

Set the temperature.

Parameters:
t   temperature in standard units.

Definition at line 476 of file elements.h.

Member Data Documentation

parameter series_RLC::C
 

Capacitance in standard units.

Definition at line 403 of file elements.h.

parameter series_RLC::L
 

Inductance in standard units.

Definition at line 400 of file elements.h.

parameter series_RLC::R
 

Resistance in standard units.

Definition at line 397 of file elements.h.

parameter series_RLC::Temp
 

Temperature in standard units.

Shadows global temperature T by default.

Definition at line 409 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