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

zterm Class Reference

A one-port terminator whose impedance is controlled by a complex parameter (default 0). More...

#include <elements.h>

Inheritance diagram for zterm::

nport device List of all members.

Public Methods

 zterm (complex z=0.0)
 The default constructor sets the impedance to 0 by default. More...

 zterm (abstract_complex_parameter *z)
 Construct a shadowed parameter impedance. More...

zterm& set (complex z)
 Set the impedance. More...

zterm& set (abstract_complex_parameter *z)
 Set the impedance to shadow a parameter. More...

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

zterm& 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

complex_parameter Z
 Impedance in standard units (default is 0). More...

parameter Temp
 Temperature in standard units (shadows device::T by default). 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...

Detailed Description

A one-port terminator whose impedance is controlled by a complex parameter (default 0).

The type name "short_term" is a synonym for "zterm" (using a typedef), since the default value for a zterm's impedance is 0.

zterm has one complex parameter:

and one real parameter: Its impedance may be set during construction (the default value is 0). Example: 
     zterm t( (100 + I*10)*Ohm) ;  // a terminator named "t" with a complex
                                  // impedance of (100 + I*10)*Ohm

Its impedance may be set to shadow another complex parameter type as well at construction: 

    complex_parameter Imped;
    zterm t(&Imped);              // now t's impedance will shadow Imped

Definition at line 800 of file elements.h.

Constructor & Destructor Documentation

zterm::zterm ( complex z = 0.0 ) [inline, explicit]
 

The default constructor sets the impedance to 0 by default.

Parameters:
z   the impedance of the terminator

Definition at line 814 of file elements.h.

zterm::zterm ( abstract_complex_parameter * z ) [inline, explicit]
 

Construct a shadowed parameter impedance.

Parameters:
z   pointer to the parameter to be shadowed.

Definition at line 822 of file elements.h.

Member Function Documentation

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

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

Reimplemented from nport.

Definition at line 860 of file elements.h.

void zterm::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 167 of file elements.cc.

void zterm::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 173 of file elements.cc.

Referenced by recalc().

zterm & zterm::set ( abstract_complex_parameter * z ) [inline]
 

Set the impedance to shadow a parameter.

Parameters:
z   parameter of impedance in standard units.

Definition at line 838 of file elements.h.

zterm & zterm::set ( complex z ) [inline]
 

Set the impedance.

Parameters:
z   impedance in standard units.

Definition at line 830 of file elements.h.

zterm & zterm::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 854 of file elements.h.

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

Set the temperature.

Parameters:
t   temperature in standard units.

Definition at line 846 of file elements.h.

Member Data Documentation

parameter zterm::Temp
 

Temperature in standard units (shadows device::T by default).

Definition at line 807 of file elements.h.

complex_parameter zterm::Z
 

Impedance in standard units (default is 0).

Definition at line 804 of file elements.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