---

yterm Class Reference

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

#include <elements.h>

Inheritance diagram for yterm::

List of all members.

Public Methods
	yterm (complex y=0.0)
	The default constructor sets the admittance to 0 by default. More...
	yterm (abstract_complex_parameter *y)
	Construct a shadowed parameter admittance. More...
yterm&	set (complex y)
	Set the admittance. More...
yterm&	set (abstract_complex_parameter *y)
	Set the admittance to shadow a parameter. More...
yterm&	set_T (double t)
	Set the temperature. More...
yterm&	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	Y
	Admittance 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 admittance is controlled by a complex parameter (default 0).

The type name "open_term" is a synonym for "yterm" (using a typedef), since the default value for a yterm's admittance is 0.

yterm has one complex parameter:

• Y: admittance

and one real parameter:

• Temp: temperature, if different from the default temperature

Its admittance may be set during construction (the default value is 0). Example:

    yterm t( (100 + I*10)*Mho) ;  // a terminator named "t" with a complex
                                  // admittance of (100 + I*10)*Mho
 

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

    complex_parameter Admitt;
    yterm t(&Admitt);              // now t's admittance will shadow Admitt
 

Definition at line 905 of file elements.h.

---

Constructor & Destructor Documentation

yterm::yterm ( complex y = 0.0 ) [inline, explicit]

The default constructor sets the admittance to 0 by default. Parameters: y   the admittance of the terminator Definition at line 919 of file elements.h.

yterm::yterm ( abstract_complex_parameter * y ) [inline, explicit]

Construct a shadowed parameter admittance. Parameters: z   pointer to the parameter to be shadowed. Definition at line 927 of file elements.h.

---

Member Function Documentation

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

Is an "active" noise source if its temperature is not the global T. Reimplemented from nport. Definition at line 965 of file elements.h.

void yterm::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 181 of file elements.cc.

void yterm::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 187 of file elements.cc. Referenced by recalc().

yterm & yterm::set ( abstract_complex_parameter * y ) [inline]

Set the admittance to shadow a parameter. Parameters: y   parameter of admittance in standard units. Definition at line 943 of file elements.h.

yterm & yterm::set ( complex y ) [inline]

Set the admittance. Parameters: y   admittance in standard units. Definition at line 935 of file elements.h.

yterm & yterm::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 959 of file elements.h.

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

Set the temperature. Parameters: t   temperature in standard units. Definition at line 951 of file elements.h.

---

Member Data Documentation

parameter yterm::Temp

Temperature in standard units (shadows device::T by default). Definition at line 912 of file elements.h.

complex_parameter yterm::Y

Admittance in standard units (default is 0). Definition at line 909 of file elements.h.

---

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

• elements.h
• elements.cc

---

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