Add a useful package (from Source forge) for octave

[CreaPhase.git] / octave_packages / ocs-0.1.3 / prs / doc-cache

diff --git a/octave_packages/ocs-0.1.3/prs/doc-cache b/octave_packages/ocs-0.1.3/prs/doc-cache
new file mode 100644 (file)
index 0000000..f028b3e
--- /dev/null
+++ b/octave_packages/ocs-0.1.3/prs/doc-cache
@@ -0,0 +1,193 @@
+# Created by Octave 3.6.1, Sun Mar 25 17:34:24 2012 UTC <root@t61>
+# name: cache
+# type: cell
+# rows: 3
+# columns: 2
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 7
+prs_iff
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 1823
+ -- Function File: OUTSTRUCT = prs_iff(NAME)
+     Parse a netlist in IFF format and produce the system description
+     structure OUTSTRUCT.
+
+     NAME is the basename of the CIR and NMS files to be parsed.
+
+     See the `IFF file format specifications' (distributed together
+     with the OCS package) for more details on the file format.
+
+     OUTSTRUCT has the following fields:
+
+          outstruct =
+          {
+           LCR:  struct      % the fields of LCR are shown below
+           NLC:  struct      % NLC has the same fields as LCR
+           namesn: matrix    % numbers of vars named in .nms file
+           namess: cell      % the names corresponding to the vars above
+           totextvar: scalar % the total number of external variables
+           totintvar: scalar % the total number of internal variables
+          }
+
+          outstruct.LCR =
+          outstruct.NLC =
+          {
+           struct array containing the fields: % array has one element per block
+
+             func     % name of the sbn file corresponding to each block
+             section  % string parameter to be passed to the sbn files
+             nextvar  % number of external variables for each element of the block
+             vnmatrix % numbers of the external variables of each element
+             nintvar  % number of internal variables for each element of the block
+             osintvar % number of the first internal variable
+             npar     % number of parameters
+             nparnames% number of parameter names
+             nrows    % number of rows in the block
+             parnames % list of parameter names
+             pvmatrix % list of parameter values for each element
+
+          }
+
+     See the `IFF file format specifications' for details about the
+     output structures.
+
+     See also: prs_spice
+
+
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 80
+Parse a netlist in IFF format and produce the system description
+structure OUTST
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 9
+prs_spice
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 2554
+ -- Function File: [STUCT] = prs_spice (FILENAME)
+     Circuit file parser that can interpret a subset of the spice file
+     format.
+
+     `prs_spice' currently supports the following set of "Element Cards"
+        - Capacitors:
+               Cname n+ n- cvalue
+
+        - Diodes:
+               Cname anode knode modelname <parameters>
+
+        - MOS:
+               Mname gnode dnode snode bnode modelname <parameters>
+
+          N.B.: one instance of a MOS element MUST be preceeded
+          (everywhere in the file) by the declaration of the related
+          model.  For instance:
+               .MODEL mynmos NMOS( k=1e-4 Vth=0.1 rd=1e6)
+               M2 Vgate 0 Vdrain 0 mynmos
+
+        - Resistors:
+               Rname n+ n- rvalue
+
+        - Voltage sources:
+               Vname n+ n- <dcvalue> <transvalue>
+
+          Transvalue specifies a transient voltage source
+               SIN(VO  VA  FREQ TD  THETA)
+          where:
+             * VO    (offset)
+
+             * VA    (amplitude)
+
+             * FREQ  (frequency)
+
+             * TD    (delay)
+
+             * THETA (damping factor)
+
+             * 0 to TD: V0
+
+             * TD to TSTOP: VO  +
+               VA*exp(-(time-TD)*THETA)*sine(twopi*FREQ*(time+TD))
+
+          Currently the damping factor has no effect.
+
+          Pulse
+               PULSE(V1 V2 TD TR  TF  PW  PER)
+
+          parameters meaning
+             * V1         (initial value)
+
+             * V2         (pulsed value)
+
+             * TD         (delay time)
+
+             * TR         (rise  time)
+
+             * TF         (fall time)
+
+             * PW         (pulse width)
+
+             * PER        (period)
+
+          Currently rise and fall time are not implemented yet.
+
+        - .MODEL cards Defines a model for semiconductor devices
+
+               .MODEL MNAME TYPE(PNAME1=PVAL1 PNAME2=PVAL2 ... )
+
+          TYPE can be:
+             * NMOS N-channel MOSFET model
+
+             * PMOS P-channel MOSFET model
+
+             * D    diode model
+
+          The parameter "LEVEL" is currently assigned to the field
+          "section" in the call of the element functions by the solver.
+          Currently supported values for the parameter LEVEL for NMOS
+          and PMOS are:
+             * simple
+
+             * lincap
+          (see documentation of function Mdiode).
+
+          Currently supported values for the parameter LEVEL for D are:
+             * simple
+          (see documentation of functions Mnmosfet and Mpmosfet).
+
+
+     See also: prs_iff, Mdiode, Mnmosfet, Mpmosfet
+
+
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 73
+Circuit file parser that can interpret a subset of the spice file
+format.
+
+
+
+
+