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

capacitor Class Reference

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

#include <elements.h>

Inheritance diagram for capacitor::

spimp nport device List of all members.

Public Methods

 capacitor (double c=0.0)
 Constructor sets the capacitance to 0 by default. More...

 capacitor (const abstract_real_parameter *c)
 Construct a shadowed parameter capacitance. More...

capacitor& set (double c)
 Set the capacitance. More...

capacitor& set (abstract_real_parameter *c)
 Set the capacitance to shadow a parameter. More...


Public Attributes

parameter C
 Capacitance in standard units. More...


Private Methods

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


Detailed Description

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

It has one real member parameter:

Its capacitance may be set during construction as well. Example:
    capacitor c(200*Pico*Farad); // a capacitor named "c"
 

Definition at line 262 of file elements.h.


Constructor & Destructor Documentation

capacitor::capacitor ( double c = 0.0 ) [inline, explicit]
 

Constructor sets the capacitance to 0 by default.

Definition at line 273 of file elements.h.

capacitor::capacitor ( const abstract_real_parameter * c ) [inline, explicit]
 

Construct a shadowed parameter capacitance.

Parameters:
c   pointer to the parameter to be shadowed

Definition at line 281 of file elements.h.


Member Function Documentation

void capacitor::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 302 of file elements.h.

capacitor & capacitor::set ( abstract_real_parameter * c ) [inline]
 

Set the capacitance to shadow a parameter.

Parameters:
c   parameter of capacitance in standard units.

Definition at line 297 of file elements.h.

capacitor & capacitor::set ( double c ) [inline]
 

Set the capacitance.

Parameters:
c   capacitance in standard units.

Definition at line 289 of file elements.h.


Member Data Documentation

parameter capacitor::C
 

Capacitance in standard units.

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