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

cascade Class Reference

class cascade is a special type of composite circuit which can only be a 2-port or a 1-port, and can be built only from 2-ports and/or a single 1-port. More...

#include <circuit.h>

Inheritance diagram for cascade::

data_ptr_nport nport device List of all members.

Public Methods

 cascade ()
 The default constructor initializes with a 2-port branch equivalent. More...

int size ()
 The number of ports this device has. More...

const nport::data_infoget_data_info ()
 Noise and source status. More...

cascade& add (nport &n)
 This is the main function that the user calls to build up the cascade of devices. More...

cascade& a (nport &n)
 A shorthand alias for add(). More...


Public Attributes

parameter Temp
 The temperature of this circuit. More...


Private Methods

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

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


Private Attributes

nportlast
 The last component added. More...

circuit c
 The actual circuit. More...


Detailed Description

class cascade is a special type of composite circuit which can only be a 2-port or a 1-port, and can be built only from 2-ports and/or a single 1-port.

It implements a simple cascade connection of its component devices. Port 1 of the cascade is assigned to port 1 of the first device added; port 2 of the cascade to port 2 of the last device added, unless the last device added is a 1-port, in which case the cascade is also a 1-port. As long as no 1-port is added to the cascade, 2-ports may continue to be added; adding a 1-port at any time makes the cascade a 1-port and no further devices may be added. At creation, cascade behaves as a 2-port branch.

Definition at line 224 of file circuit.h.


Constructor & Destructor Documentation

cascade::cascade ( )
 

The default constructor initializes with a 2-port branch equivalent.

Definition at line 348 of file circuit.cc.


Member Function Documentation

cascade & cascade::a ( nport & n ) [inline]
 

A shorthand alias for add().

Parameters:
n   the next device to add to the cascade

Definition at line 265 of file circuit.h.

cascade & cascade::add ( nport & n )
 

This is the main function that the user calls to build up the cascade of devices.

Parameters:
n   the next device to add to the cascade

Definition at line 388 of file circuit.cc.

Referenced by a().

const nport::data_info & cascade::get_data_info ( ) [virtual]
 

Noise and source status.

Returns:
info about the sdata of the device

Reimplemented from nport.

Definition at line 377 of file circuit.cc.

void cascade::recalc ( ) [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 357 of file circuit.cc.

void cascade::recalc_S ( ) [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 367 of file circuit.cc.

int cascade::size ( ) [inline, virtual]
 

The number of ports this device has.

Returns:
the number of ports

Reimplemented from data_ptr_nport.

Definition at line 243 of file circuit.h.


Member Data Documentation

parameter cascade::Temp
 

The temperature of this circuit.

The default shadows device::T. The temperature is passed to subelements using device::T, so any subelement may override with its own explicit Temp value

Definition at line 233 of file circuit.h.

circuit cascade::c [private]
 

The actual circuit.

Definition at line 273 of file circuit.h.

nport * cascade::last [private]
 

The last component added.

Definition at line 270 of file circuit.h.


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

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