octave_packages/ocs-0.1.3/prs/doc-cache

   1 # Created by Octave 3.6.1, Sun Mar 25 17:34:24 2012 UTC <root@t61>
   2 # name: cache
   3 # type: cell
   4 # rows: 3
   5 # columns: 2
   6 # name: <cell-element>
   7 # type: sq_string
   8 # elements: 1
   9 # length: 7
  10 prs_iff
  11
  12
  13 # name: <cell-element>
  14 # type: sq_string
  15 # elements: 1
  16 # length: 1823
  17  -- Function File: OUTSTRUCT = prs_iff(NAME)
  18      Parse a netlist in IFF format and produce the system description
  19      structure OUTSTRUCT.
  20
  21      NAME is the basename of the CIR and NMS files to be parsed.
  22
  23      See the `IFF file format specifications' (distributed together
  24      with the OCS package) for more details on the file format.
  25
  26      OUTSTRUCT has the following fields:
  27
  28           outstruct =
  29           {
  30            LCR:  struct      % the fields of LCR are shown below
  31            NLC:  struct      % NLC has the same fields as LCR
  32            namesn: matrix    % numbers of vars named in .nms file
  33            namess: cell      % the names corresponding to the vars above
  34            totextvar: scalar % the total number of external variables
  35            totintvar: scalar % the total number of internal variables
  36           }
  37
  38           outstruct.LCR =
  39           outstruct.NLC =
  40           {
  41            struct array containing the fields: % array has one element per block
  42
  43              func     % name of the sbn file corresponding to each block
  44              section  % string parameter to be passed to the sbn files
  45              nextvar  % number of external variables for each element of the block
  46              vnmatrix % numbers of the external variables of each element
  47              nintvar  % number of internal variables for each element of the block
  48              osintvar % number of the first internal variable
  49              npar     % number of parameters
  50              nparnames% number of parameter names
  51              nrows    % number of rows in the block
  52              parnames % list of parameter names
  53              pvmatrix % list of parameter values for each element
  54
  55           }
  56
  57      See the `IFF file format specifications' for details about the
  58      output structures.
  59
  60      See also: prs_spice
  61
  62
  63
  64
  65
  66 # name: <cell-element>
  67 # type: sq_string
  68 # elements: 1
  69 # length: 80
  70 Parse a netlist in IFF format and produce the system description
  71 structure OUTST
  72
  73
  74
  75 # name: <cell-element>
  76 # type: sq_string
  77 # elements: 1
  78 # length: 9
  79 prs_spice
  80
  81
  82 # name: <cell-element>
  83 # type: sq_string
  84 # elements: 1
  85 # length: 2554
  86  -- Function File: [STUCT] = prs_spice (FILENAME)
  87      Circuit file parser that can interpret a subset of the spice file
  88      format.
  89
  90      `prs_spice' currently supports the following set of "Element Cards"
  91         - Capacitors:
  92                Cname n+ n- cvalue
  93
  94         - Diodes:
  95                Cname anode knode modelname <parameters>
  96
  97         - MOS:
  98                Mname gnode dnode snode bnode modelname <parameters>
  99
 100           N.B.: one instance of a MOS element MUST be preceeded
 101           (everywhere in the file) by the declaration of the related
 102           model.  For instance:
 103                .MODEL mynmos NMOS( k=1e-4 Vth=0.1 rd=1e6)
 104                M2 Vgate 0 Vdrain 0 mynmos
 105
 106         - Resistors:
 107                Rname n+ n- rvalue
 108
 109         - Voltage sources:
 110                Vname n+ n- <dcvalue> <transvalue>
 111
 112           Transvalue specifies a transient voltage source
 113                SIN(VO  VA  FREQ TD  THETA)
 114           where:
 115              * VO    (offset)
 116
 117              * VA    (amplitude)
 118
 119              * FREQ  (frequency)
 120
 121              * TD    (delay)
 122
 123              * THETA (damping factor)
 124
 125              * 0 to TD: V0
 126
 127              * TD to TSTOP: VO  +
 128                VA*exp(-(time-TD)*THETA)*sine(twopi*FREQ*(time+TD))
 129
 130           Currently the damping factor has no effect.
 131
 132           Pulse
 133                PULSE(V1 V2 TD TR  TF  PW  PER)
 134
 135           parameters meaning
 136              * V1         (initial value)
 137
 138              * V2         (pulsed value)
 139
 140              * TD         (delay time)
 141
 142              * TR         (rise  time)
 143
 144              * TF         (fall time)
 145
 146              * PW         (pulse width)
 147
 148              * PER        (period)
 149
 150           Currently rise and fall time are not implemented yet.
 151
 152         - .MODEL cards Defines a model for semiconductor devices
 153
 154                .MODEL MNAME TYPE(PNAME1=PVAL1 PNAME2=PVAL2 ... )
 155
 156           TYPE can be:
 157              * NMOS N-channel MOSFET model
 158
 159              * PMOS P-channel MOSFET model
 160
 161              * D    diode model
 162
 163           The parameter "LEVEL" is currently assigned to the field
 164           "section" in the call of the element functions by the solver.
 165           Currently supported values for the parameter LEVEL for NMOS
 166           and PMOS are:
 167              * simple
 168
 169              * lincap
 170           (see documentation of function Mdiode).
 171
 172           Currently supported values for the parameter LEVEL for D are:
 173              * simple
 174           (see documentation of functions Mnmosfet and Mpmosfet).
 175
 176
 177      See also: prs_iff, Mdiode, Mnmosfet, Mpmosfet
 178
 179
 180
 181
 182
 183 # name: <cell-element>
 184 # type: sq_string
 185 # elements: 1
 186 # length: 73
 187 Circuit file parser that can interpret a subset of the spice file
 188 format.
 189
 190
 191
 192
 193