NetNews Usenet Archive 1993 #3/NN_1993_3.iso/spool/alt/sources/3090

Text File | 1993-01-25 | 61.1 KB | 1,766 lines

Path: sparky!uunet!cs.utexas.edu!sdd.hp.com!nigel.msen.com!hela.iti.org!cs.widener.edu!dsinc!ub!galileo.cc.rochester.edu!ee.rochester.edu!rbc!al
From: [e-mail] (Al Davis)
Newsgroups: alt.sources
Subject: ACS  circuit simulator  part 07/20
Message-ID: <[e-mail]>
Date: 25 Jan 93 05:22:45 GMT
Sender: [e-mail] (Al Davis)
Organization: Huh?
Lines: 1755

#! /bin/sh
# This is a shell archive, meaning:
# 1. Remove everything above the #! /bin/sh line.
# 2. Save the resulting text in a file.
# 3. Execute the file with /bin/sh (not csh) to create the files:
#    man/Commands/network.tex
#    man/Commands/nodeset.tex
#    man/Commands/noise.tex
#    man/Commands/op.tex
#    man/Commands/options.tex
#    man/Commands/pause.tex
#    man/Commands/plot.tex
#    man/Commands/print.tex
#    man/Commands/quit.tex
#    man/Commands/save.tex
#    man/Commands/sens.tex
#    man/Commands/set.tex
#    man/Commands/status.tex
#    man/Commands/sweep.tex
#    man/Commands/temp.tex
#    man/Commands/tf.tex
#    man/Commands/title.tex
#    man/Commands/transient.tex
#    man/Commands/unfault.tex
#    man/Commands/unmark.tex
#    man/Commands/width.tex
# This archive created: Mon Jan 25 00:17:43 1993
export PATH; PATH=/bin:$PATH
if test -f 'man/Commands/network.tex'
then
    echo shar: will not over-write existing file "'man/Commands/network.tex'"
else
cat << \SHAR_EOF > 'man/Commands/network.tex'
% network  02/26/90
% man commands network .
% Copyright 1983-1992   Albert Davis
%------------------------------------------------------------------------
\section{{\tt Network} command}
\index{Network command}
\index{view circuit}
\index{connection list}
\index{node list}
\index{list by node}
%------------------------------------------------------------------------
\subsection{Syntax}
\begin{verse}
{\tt Network} \{{\it nodes}\} \{{\tt Print}\}
\end{verse}
%------------------------------------------------------------------------
\subsection{Purpose}

Lists connections to each node.
%------------------------------------------------------------------------
\subsection{Comments}

{\tt Network} lists the line number and label of each part connected to each
node.  If both ends of a part are connected the same place, it is listed
twice.

For a partial list, just specify the numbers.  A number alone ({\tt 17}) says
this branch alone.  A trailing dash ({\tt 23-}) says from here to the end.  A
leading dash ({\tt -33}) says from the start to here.  Two numbers ({\tt 9
13}) specify a range.
%------------------------------------------------------------------------
\subsection{Examples}

\begin{description}

\item[{\tt Network}] Lists all the nodes in the circuit, with their
connections.

\item[{\tt Network 99}] List parts connecting to node 99.

\item[{\tt Network 0}] List the connections to node 0.  (There must be at
least one, unless you are editing a model.)

\item[{\tt Network 78-}] List connections to nodes 78 and up.

\item[{\tt Network 124 127}] List connections to nodes 124, 125, 126, 127.

\end{description}
%------------------------------------------------------------------------
%------------------------------------------------------------------------
SHAR_EOF
fi # end of overwriting check
if test -f 'man/Commands/nodeset.tex'
then
    echo shar: will not over-write existing file "'man/Commands/nodeset.tex'"
else
cat << \SHAR_EOF > 'man/Commands/nodeset.tex'
% nodeset  04/05/90
% man commands nodeset .
% Copyright 1983-1992   Albert Davis
%------------------------------------------------------------------------
\section{{\tt NODeset} command}
\index{nodeset command}
%------------------------------------------------------------------------
The Spice {\tt NODeset} command is not implemented.  Similar
functionality is not available.
%------------------------------------------------------------------------
%------------------------------------------------------------------------
%------------------------------------------------------------------------
%------------------------------------------------------------------------
%------------------------------------------------------------------------
SHAR_EOF
fi # end of overwriting check
if test -f 'man/Commands/noise.tex'
then
    echo shar: will not over-write existing file "'man/Commands/noise.tex'"
else
cat << \SHAR_EOF > 'man/Commands/noise.tex'
% noise  03/20/90
% man commands noise .
% Copyright 1983-1992   Albert Davis
%------------------------------------------------------------------------
\section{{\tt NOIse} command}
\index{noise command}
%------------------------------------------------------------------------
The Spice {\tt NOIse} command is not implemented.  Similar functionality is
not available.
%------------------------------------------------------------------------
%------------------------------------------------------------------------
%------------------------------------------------------------------------
%------------------------------------------------------------------------
%------------------------------------------------------------------------
SHAR_EOF
fi # end of overwriting check
if test -f 'man/Commands/op.tex'
then
    echo shar: will not over-write existing file "'man/Commands/op.tex'"
else
cat << \SHAR_EOF > 'man/Commands/op.tex'
% op  04/09/91
% man commands op .
% Copyright 1983-1992   Albert Davis
%------------------------------------------------------------------------
\section{{\tt OP} command}
\index{op command}
\index{operating point}
\index{bias analysis}
\index{nonlinear bias analysis}
\index{temperature sweep}
\index{quiescent conditions}
%------------------------------------------------------------------------
\subsection{Syntax}
\begin{verse}
{\tt OP} {\it start stop stepsize} \{{\it options} ...\}
\end{verse}
%------------------------------------------------------------------------
\subsection{Purpose}

Performs a nonlinear DC steady state analysis, with no input.  If a
temperature range is given, it sweeps the temperature.
%------------------------------------------------------------------------
\subsection{Comments}

There are substantial extensions beyond the capabilities of the SPICE {\tt
op} card.

If there are numeric arguments, they represent a temperature sweep.  They are
the start and stop temperatures in degrees Celsius, and the step size, in
order.  They are saved between commands, so no arguments will repeat the
previous sweep.

This command will use the {\tt op} probe set, instead of automatically
printing all nodes and source currents.

A single parameter represents a single temperature.  Two parameters instruct
the computer to analyze for those two points only.

This command also sets up the quiescent point for subsequent {\tt AC}
analysis.  It is necessary to do this for nonlinear circuits.  The last step
in the sweep determines the quiescent point for the AC analysis.
%------------------------------------------------------------------------
\subsection{Options}

\begin{description}

\item[{\tt *} {\it multiplier}] Log sweep.  Multiply the
{\em absolute} temperature by {\it multiplier} to get the
next step.  The fact that it is offset to absolute zero
may make the step sizes look strange.

\item[{\tt >} {\it file}] Send results of analysis to {\it
file}.  Default extension is {\tt .op}.

\item[{\tt >>} {\it file}] Append results to {\it file}.
Default extension is {\tt .op}.

%%%\item[{\tt ACMAx}] Use worst case max values, per last
%%%{\tt AC} analysis.

%%%\item[{\tt ACMIn}] Use worst case min values, per last
%%%{\tt AC} analysis.

\item[{\tt BY} {\it stepsize}] Linear sweep.  Add {\it
stepsize} to get the next step.

\item[{\tt Continue}] Use the last step of a {\tt OP},
{\tt DC} or {\tt Transient} analysis as the first guess.

%%%\item[{\tt DCMAx}] Use worst case max values, per last
%%%{\tt DC} or {\tt OP} analysis.

%%%\item[{\tt DCMIn}] Use worst case min values, per last
%%%{\tt DC} or {\tt OP} analysis.

\item[{\tt Input} {\it volts}] Apply {\it volts} input to
the circuit, instead of zero.

%%%\item[{\tt LAg}] Use worst case values, for lagging phase,
%%%per {\tt AC} analysis.

%%%\item[{\tt LEad}] Use worst case values, for leading
%%%phase, per {\tt AC} analysis.

\item[{\tt LOop}] Repeat the sweep, backwards.

%%%\item[{\tt MAx}] Use worst case max values, per same type
%%%({\tt OP} or {\tt DC}) analysis.  (Same as {\tt DCMAx},
%%%here.)

%%%\item[{\tt MIn}] Use worst case min values, per same type
%%%({\tt OP} or {\tt DC}) analysis.  (Same as {\tt DCMIn},
%%%here.)

%%%\item[{\tt MCarlo} {\it trials}] Monte-Carlo analysis.
%%%Simulate {\it trials} circuits; compile statistics.  Hide
%%%individual trials.

\item[{\tt PLot}] Graphic output, when plotting is
normally off.

\item[{\tt Print}] Send results to printer.

\item[{\tt Quiet}] Suppress console output.

%%%\item[{\tt RAndom} {\it trials}] Simulate {\it trials}
%%%circuits using random values.

\item[{\tt REverse}] Sweep in the opposite direction.

\item[{\tt TAble}] Tabular output. Override default plot.

\item[{\tt TEmperature} {\it degrees}] Temperature,
degrees C.  Override the sweep.

\item[{\tt TImes} {\it multiplier}] Log sweep.  Multiply
the {\bf absolute} temperature by {\it multiplier} to get
the next step.

\item[{\tt WAtch}] Watch the convergence process, every
iteration.

%%%\item[{\tt WOrstcase} {\it probe}] Worst case analysis, at
%%%{\it probe}.

\end{description}
%------------------------------------------------------------------------
\subsection{Examples}

\begin{description}

\item[{\tt OP 27}] Do a DC operating point simulation at temperature 27
degrees Celsius.

\item[{\tt OP -50 200 25}] Sweep the temperature from -50 to 200 in 25
degree steps.  Do a DC operating point simulation at each step.

\item[{\tt OP}] With no parameters, it uses the same ones as the last time.
In this case, from -50 to 200 in 25 degree steps.

\item[{\tt OP 200 -50 -25}] You can sweep downward, by asking for a negative
increment.

\item[{\tt OP Input 2.3}] Apply an input to the circuit of 2.3 volts.  This
overrides the default of no input.

\item[{\tt OP TEmperature 75}] Simulate at 75 degrees, this time.  This isn't
remembered for next time.

\item[{\tt OP}] Since the last time used the {\tt TEmperature} option, go
back one more to find what the sweep parameters were.  In this case, downward
from 200 to -50 in 25 degree steps.  (Because we did it 3 commands ago.)

\end{description}
%------------------------------------------------------------------------
%------------------------------------------------------------------------
SHAR_EOF
fi # end of overwriting check
if test -f 'man/Commands/options.tex'
then
    echo shar: will not over-write existing file "'man/Commands/options.tex'"
else
cat << \SHAR_EOF > 'man/Commands/options.tex'
% options  01/23/93
% man commands options .
% Copyright 1983-1992   Albert Davis
%------------------------------------------------------------------------
\section{{\tt OPTions} command}
\index{options command}
\index{set command}
\index{system options}
\index{options: global}
\index{global options}
%------------------------------------------------------------------------
\subsection{Syntax}
\begin{verse}
{\tt OPTions}\\
{\tt OPTions} {\it option-name value} ...
\end{verse}
%------------------------------------------------------------------------
\subsection{Purpose}

Sets options, iteration parameters, global data.
%------------------------------------------------------------------------
\subsection{Comments}

Typical usage is the name of the item to set followed by the
value.

The bare command `{\tt OPTions}' displays the values.

These options control the simulation, by specifying how to
handle marginal circumstances, how long to wait for
convergence, etc.

Most of the SPICE options are supported, more have been    added.
%------------------------------------------------------------------------
\subsection{Parameters}

\begin{description}

\index{accounting}
\item[{\tt ACCT}] Turns on accounting.  When enabled, the CPU
time used is printed after each command.  This does not affect
accounting done by the {\tt status} command.

\item[{\tt NOACCT}] Turns off accounting.  (Not in SPICE.)

\index{echo file input}
\item[{\tt LIST}] Turns on echo of files read by {\tt get} and
{\tt merge} commands, and in batch mode.  (SPICE option accepted
but not implemented.)

\item[{\tt NOLIST}] Turns off list option.  (Not in SPICE.)

\item[{\tt MOD}] Enable printout of model parameters.  (Accepted,
but not implemented, to complement {\tt NOMOD}.)

\item[{\tt NOMOD}] Suppress printout of model parameters.  (SPICE
option accepted but not implemented.)

\item[{\tt PAGE}] Enable page ejects at the beginning of
simulation runs.  (Accepted, but not implemented, to complement
{\tt NOPAGE}.)

\item[{\tt NOPAGE}] Turn off page ejects.  (SPICE option accepted
but not implemented.)

\item[{\tt NODE}] Enable printing of the node table.  (SPICE
option accepted but not implemented.)

\item[{\tt NONODE}] Disable printing of the node table.
(Accepted, but not implemented, to complement {\tt NODE}.)

\item[{\tt OPTS}] Enable printing of option values.  (SPICE
option accepted but not implemented.)

\item[{\tt NOOPTS}] Disable printing of option values.
(Accepted, but not implemented, to complement {\tt OPTS}.)

\index{gmin option}
\index{minimum conductance}
\index{open circuit error}
\item[{\tt GMIN} = {\it x}] Minimum conductance allowed by the program.
(Default = 1e-12 or 1 picomho.)  Every node must have a net
minimum conductance of {\tt GMIN} to ground.  If effective open
circuits are found during the solution process (leading to a
singular matrix) a conductance of {\tt GMIN} is forced to
ground, after printing an "open circuit" error message.

\index{reltol option}
\index{relative tolerance}
\index{convergence criteria}
\item[{\tt RELTOL} = {\it x}] Relative error tolerance allowed.
(Default =.001 or .1%.)
If the ratio of successive values in iteration are within {\tt
RELTOL} of one, this value is considered to have converged.

\index{abstol option}
\index{absolute tolerance}
\index{convergence criteria}
\item[{\tt ABSTOL} = {\it x}] Absolute error tolerance
allowed.  (Default = 1e-12)
If successive values in iteration are within {\tt ABSTOL} of
each other, this value is considered to have converged.

\index{vntol option}
\index{voltage tolerance}
\index{model evaluation bypass}
\item[{\tt VNTOL} = {\it x}] Absolute voltage error required to
force model re-evaluation.  (Default = 1e-12 or 1 microvolt.)
If the voltage at the terminals of a model is within {\tt
VNTOL} of the previous iteration, the model is not
re-evaluated.  The old values are used directly.

\index{trtol option}
\index{transient error tolerance}
\item[{\tt TRTOL} = {\it x}] Transient error ``tolerance''.
(Default = 7.)  This parameter is an estimate of the factor by
which the program overestimates the actual truncation error.

\index{chgtol option}
\index{charge error tolerance}
\item[{\tt CHGTOL} = {\it x}] Charge tolerance.  (Default =
1e-14) It is used in step size control in transient analysis.

\index{pivtol option}
\index{pivot tolerance}
\item[{\tt PIVTOL} = {\it x}] Pivot tolerance.  (Default =
1e-13) SPICE option accepted but not implemented.

\index{pivrel option}
\item[{\tt PIVREL} = {\it x}] Pivot ratio.  (Default = 1e-3)
SPICE option accepted but not implemented.

\index{numdgt option}
\item[{\tt NUMDGT} = {\it x}] Number of significant digits to
print.  (Default = 4.)  SPICE option accepted but not
implemented.

\index{tnom option}
\index{temperature}
\index{nominal temperature}
\index{reference temperature}
\item[{\tt TNOM} = {\it x}] Nominal temperature.  (Default =
27$^{\circ}$ C.)
All components have their nominal value at this temperature.

\index{iteration count}
\index{itl? options}
\item[{\tt ITL1} = {\it x}] DC iteration limit.  (Default = 100.)
Sets the maximum number of iterations in a DC, OP, or initial
transient analysis allowed before stopping and reporting that it
did not converge.

\item[{\tt ITL2} = {\it x}] DC transfer curve iteration limit.
(Default = 50.)  SPICE option accepted but not implemented.
Use ITL1 instead.

\item[{\tt ITL3} = {\it x}] Lower transient iteration limit.  (Default =
4.)  If the number of iterations is more than {\tt ITL3} the step size will
not increase beyond its present size.

\item[{\tt ITL4} = {\it x}] Upper transient iteration limit.  (Default =
10.)  Sets the maximum number of iterations on a step in transient
analysis.  If the circuit fails to converge in this many iterations the step
size is reduced, time is backed up, and the calculation is repeated.

\item[{\tt ITL5} = {\it x}] Transient analysis total iteration
limit.  (Default = 5000.)  SPICE option accepted but not
implemented.  Actual behavior is the same as {\tt ITL5} = 0, in
SPICE, which omits this test.

\item[{\tt ITL6} = {\it x}] Source stepping iteration limit.
(Default = 0.)  SPICE option accepted but not implemented.
Source stepping is not available.

\index{worst case iterations}
\index{iterations: worst case analysis}
\item[{\tt ITL7} = {\it x}] Worst case analysis iteration
limit.  (Default = 1.)
Sets the maximum number of iterations for the individual
element trials in a DC or bias worst case analysis.  If more
iterations than this are necessary, the program silently goes
on to the next step, as if nothing was wrong, which is usually
the case.

\index{convergence diagnostics}
\item[{\tt ITL8} = {\it x}] Convergence diagnostic iteration threshold.
(Default = 100.)  If the iteration count on a step exceeds {\tt ITL8}
diagnostic messages are printed in an attempt to aid the user in solving the
convergence problem.

\index{cptime option}
\index{cpu time limit}
\item[{\tt CPTIME} = {\it x}] Total CPU job time limit.
(Default = 30000.)  SPICE option accepted but not implemented.
There is no limit imposed.

\index{limtim option}
\item[{\tt LIMTIM} = {\it x}] CPU time reserved for plotting.
(Default = 2.)  SPICE option accepted but not implemented.

\index{limpts option}
\item[{\tt LIMPTS} = {\it x}] Max number of points printed.
(Default = 201.)  SPICE option accepted but not implemented.

\index{lvlcod option}
\item[{\tt LVLCOD} = {\it x}] Matrix solution and allocation
method.  (Default = 2, generate machine language.)  SPICE
option not implemented.

\index{lvltim option}
\index{time step control}
\item[{\tt LVLTIM} = {\it x}] Time step control method.
(Default = 2, truncation error.)  SPICE option not implemented.

\index{method option}
\index{integration method}
\item[{\tt METHOD} = {\it x}] Integration method.  (Default =
{\tt TRAPezoidal}.)  Possible values are {\tt GEAR} or {\tt
TRAPezoidal}.  SPICE option not implemented.

\index{maxord option}
\index{integration order}
\item[{\tt MAXORD} = {\it x}] Maximum order for integration
method.  (Default = 2.)  Must be between 1 and 6.  Applies only
if {\tt METHOD} = {\tt GEAR}.  SPICE option not implemented.

\index{seed option}
\index{random number seed}
\item[{\tt SEED} = {\it x}] Seed used by the random number
generator.  (Default = 1.)  (ECA-2 equivalent = {\tt Random}.)
(Not available in SPICE.)  The same random numbers will be used
every time, determined by this seed number.  Setting this to
zero is a special case, causing each run to start from a random
point.

\index{wczero option}
\index{zero: worst case}
\item[{\tt WCZERO} = {\it x}] Worst case zero window.  (Default
= 1e-9) (Not available in SPICE.)  Sets a window for the
difference in a DC or bias worst case analysis.  Differences
less than this are assumed to be zero, for purposes of setting
direction flags.  This prevents cluttering up the screen with
very small numbers that are essentially zero.

\index{damp option}
\index{damped Newton's method}
\item[{\tt DAMP} = {\it x}] Newton damping factor.  (Default =
1.)  Sets the damping factor for iteration by damped Newton's
method.  Must be between 0 and 1, as close to 1 as possible and
still achieve convergence.  Useful range is from .9 to 1.
Setting {\tt DAMP} too low may cause convergence to a nonsense
result.

\index{floor option}
\index{suppressing numerical noise}
\item[{\tt FLOOR} = {\it x}] Effective zero value.  (Default =
1e-20) Results values less than {\\ FLOOR} are shown as zero.

\index{tempamb option}
\index{ambient temperature}
\item[{\tt TEMPAMB} = {\it x}] Simulation temperature.
(Default = 27$^{\circ}$ C.)  Sets the ambient temperature, in
degrees Celsius.  This is the temperature at which the
simulation takes place, unless changed by some other command.

\index{short option}
\index{short circuit resistance}
\index{voltage source resistance}
\index{resistance of short}
\item[{\tt Short} = {\it x}] Resistance of voltage source or
short.  (Default = 1e-7 or 10 $\mu\Omega$.)  Sets the default
resistance of voltage sources.  In some cases, inductors are
replaced by resistors, if so, this is the value.  It is also
the resistance used to replace short circuits anywhere they are
not allowed and the program finds one.

\index{in option}
\index{input width option}
\index{width command}
\item[{\tt IN} = {\it x}] Input width.  (Default = 80.)
Sets the last column read from each line of input.  Columns
past this are ignored.  This option is present only for SPICE
compatibility, through the {\tt width} command, which is an
alias for {\tt options}.

\index{out option}
\index{output width option}
\item[{\tt OUT} = {\it x}] Output width.  (Default = 80.)
Sets the output print width, for tables and character graphics.

\item[{\tt ORder} = {\it x}] Equation ordering.  (Default = auto.)
Determines how external node numbers are mapped to internal numbers.  The
values are {\tt FORward}, {\tt REVerse}, and {\tt AUTo}.

\item[{\tt MODe} = {\it x}] Simulation mode selection.  (Default = mixed.)
Values are {\tt ANAlog}, {\tt DIGital}, and {\tt MIXed}.  In analog mode,
logic elements (type U) are replaced by their subcircuits as if they were
type X.  In digital mode, logic elements are simulated as digital regardless
of whether the signals are proper or not, as in traditional mixed-mode
simulation.  In mixed mode, logic elements may be simulated as analog or
digital depending on the signals present.

\item[{\tt BYPass}] Bypass model evaluation if appropriate.  If the last two
iterations indicate that an element is converged or dormant, do not evaluate
it but use its old values directly.  (Default)

\item[{\tt VBYpass}] Check only voltage to bypass model evaluation.  This
produces a faster but possibly less accurate simulation.

\item[{\tt NOBYpass}] Do not bypass model evaluation.

\item[{\tt INCmode}] Incrementally update the matrix.  (Default)

\item[{\tt NOIncmode}] Do not incrementally update the matrix.  This
eliminates a possible cause of roundoff error at the expense of a slower
simulation.

\item[{\tt LIMIT} = {\it x}] Internal voltage limit.  (Default = 100.)  All
circuit voltages may be limited to $\pm x$ to aid in convergence.  This is
intended as a convergence aid only.

\item[{\tt MRT} = {\it x}] Minimum resolvable time.  (Default = 1e-12.)  The
smallest internal time step in transient analysis.

\end{description}
%------------------------------------------------------------------------
\subsection{Examples}

\begin{description}

\item[{\tt OPTions}] Display the present settings.

\item[{\tt OPTions  ITL1=50}] Allows 50 iterations in a {\tt DC} or {\tt
OP} analysis.

\end{description}
%------------------------------------------------------------------------
%------------------------------------------------------------------------
SHAR_EOF
fi # end of overwriting check
if test -f 'man/Commands/pause.tex'
then
    echo shar: will not over-write existing file "'man/Commands/pause.tex'"
else
cat << \SHAR_EOF > 'man/Commands/pause.tex'
% pause  10/02/89
% man commands pause .
% Copyright 1983-1992   Albert Davis
%------------------------------------------------------------------------
\section{{\tt PAuse} command}
\index{pause command}
\index{suspend batch mode}
\index{wait for key hit}
%------------------------------------------------------------------------
\subsection{Syntax}
\begin{verse}
{\tt PAuse} {\it comment}
\end{verse}
%------------------------------------------------------------------------
\subsection{Purpose}

Suspend batch mode.  Wait for the user to hit a key.
%------------------------------------------------------------------------
\subsection{Status}

This command does not work on all systems, due to buffering of console i/o.
%------------------------------------------------------------------------
\subsection{Comments}

Prints {\tt Continue?} and waits for a key hit.  Type `{\tt n}', `{\tt N}',
escape or control-c to terminate the batch mode.  Anything else to continue.

Any {\it comment} is ignored.
%------------------------------------------------------------------------
\subsection{Examples}

\begin{description}

\item[{\tt PAuse Try more gain}]

\item[{\tt PAuse}] These both work the same.  Asks to continue, waits for a
key hit, then goes on.

\end{description}
%------------------------------------------------------------------------
%------------------------------------------------------------------------
SHAR_EOF
fi # end of overwriting check
if test -f 'man/Commands/plot.tex'
then
    echo shar: will not over-write existing file "'man/Commands/plot.tex'"
else
cat << \SHAR_EOF > 'man/Commands/plot.tex'
% plot  01/23/93
% man commands plot .
% Copyright 1983-1992   Albert Davis
%------------------------------------------------------------------------
\section{{\tt PLot} command}
\index{plot command}
\index{graphics: set-up}
\index{plotting: set-up}
%------------------------------------------------------------------------
\subsection{Syntax}
\begin{verse}
{\tt PLot}\\
{\tt PLot} {\it mode points ...} ...\\
{\tt PLot} {\it mode} CLEAR
\end{verse}
%------------------------------------------------------------------------
\subsection{Purpose}

Select points in the circuit for graphic output.
%------------------------------------------------------------------------
\subsection{Status}

The plotting leaves something top be desired.  Only two signals can be
plotted at a time.  The output file is corrupt when plotting is on.
%------------------------------------------------------------------------
\subsection{Comments}

The `{\tt PLot}' command selects where to look at the circuit, or where to
hook the voltmeter (ammeter, watt meter, ohm meter, etc@.) probe.

There are separate lists of probe points for each type of analysis.

To list the probe points, use the bare command `{\tt PLot}'.

The syntax for each point is always {\it parameter(node)(limits)}, {\it
parameter(componentlabel)(limits)}, or {\it parameter(index)(limits)}.  Some
require a dummy index.

You must set the scaling.  If you do not, the default range is fixed at -5
to 5.

Plot uses the same variables as Print.  See the print command for a list of
what is available.

The options {\tt plot} and {\tt noplot} on any analysis command turn
plotting on and off a single run.  The same options in the {\tt options}
command turn the plotting default on and off.
%------------------------------------------------------------------------
\subsection{Examples}

\begin{description}

\item[{\tt Plot AC vm(12)(0,5) vm(13)(-5,5)}] The magnitude of the voltage
at node 12 with a range of 0 to 5, and node 13 with a range of -5 to 5 for
AC analysis.

\item[{\tt Plot DC v(r26)}] The voltage across {\tt R26} for DC analysis.
Since there is no range, default values will be used.

\item[{\tt Plot tran v(r83)(0,5) p(r83)(0,1u}] Voltage and power of {\tt
R83}, for transient analysis.  The voltage scale is 0 to 5.  The power scale
is 0 to 1 microwatt.

\item[{\tt Plot}] List all the probes, for all modes.

\item[{\tt Plot DC}] Display the {\tt DC} plot list.

\item[{\tt Plot AC CLear}] Clear the AC list.

\end{description}
%------------------------------------------------------------------------
%------------------------------------------------------------------------
SHAR_EOF
fi # end of overwriting check
if test -f 'man/Commands/print.tex'
then
    echo shar: will not over-write existing file "'man/Commands/print.tex'"
else
cat << \SHAR_EOF > 'man/Commands/print.tex'
% print  01/23/93
% man commands print .
% Copyright 1983-1992   Albert Davis
%------------------------------------------------------------------------
\section{{\tt PRint} command}
\index{print command}
\index{probe command}
\index{output selection}
\index{selection of output}
\index{nodes: output selection}
%------------------------------------------------------------------------
\subsection{Syntax}
\begin{verse}
{\tt PRint}\\
{\tt PRint} {\it mode points ...} ...\\
{\tt PRint} {\it mode} CLEAR
\end{verse}
%------------------------------------------------------------------------
\subsection{Purpose}

Select points in the circuit for tabular output.
%------------------------------------------------------------------------
\subsection{Comments}

The `{\tt PRint}' command selects where to look at the circuit, or where to
hook the voltmeter (ammeter, watt meter, ohm meter, etc@.) probe.

There are separate lists of probe points for each type of analysis.

To list the probe points, use the bare command `{\tt PRint}'.

On start-up, probes are not set.  You must do the command `{\tt print op
v(nodes)}' or put `{\tt .print op v(nodes)}' in the circuit file to get any
output from the {\tt op} command.

The syntax for each point is always {\it parameter(node)}, {\it
parameter(componentlabel)}, or {\it parameter(index)}.  Some require a dummy
index.

You can access components in subcircuits by connecting the names with dots.
For example: {\tt R56.X67.Xone} is {\tt R56} in {\tt X67} in {\tt Xone}.
Some built-in elements, including diodes, transistors, and mosfets, contain
subcircuits with internal elements.  {\tt Cgd.M12} is the gate to drain
capacitor of mosfet {\tt M12}.

If the component does not exist, you will get an error message.  If the
component exists but the parameter is not valid for that type, there will be
no error message but the value printed will be obviously bogus.
%------------------------------------------------------------------------
\subsection{Node probes}

Several parameters are available at each node.
%------------------------------------------------------------------------
\subsubsection{All modes}

\begin{description}

\item[{\tt V}] Voltage.

\end{description}
%------------------------------------------------------------------------
\subsubsection{Transient, DC, OP only}
\begin{description}

\item[{\tt Logic}] A numeric interpretation of the logic value at the node.
The value is displayed encoded in a number of the form $a.bc$ where $a$ is
the logic state: $0 =$ logic $0$, $1 =$ rising, $2 =$ falling, $3 =$ logic
$1$.  $b$ is an indication of the quality of the digital signal.  $0$ is a
fully valid logic signal.  Nonzero indicates it does not meet the criteria
for logic simulation.  $c$ indicates how the node was calculated:  $0$
indicates logic simulation.  $1$ indicates analog simulation of a logic
device.  $2$ indicates analog simulation of analog devices.

\end{description}
%------------------------------------------------------------------------
\subsubsection{AC only}
\begin{description}

\item[{\tt VM}] Voltage magnitude.

\item[{\tt VDB}] Decibels relative to 1 volt.

\item[{\tt VP}] Voltage phase.

\end{description}
%------------------------------------------------------------------------
\subsection{Status probes}

There are several status variables that can be probed.
%------------------------------------------------------------------------
\subsubsection{All modes}

\begin{description}

\item[{\tt Temperature(0)}] The simulation temperature in degrees Celsius.

\item[{\tt TIme(0)}] The current time in a transient analysis.  In AC
analysis it shows the time at which the bias point was set, 0 if it was set
in a DC or OP analysis, or -1 if it is the bias was not set (power off).

\end{description}
%------------------------------------------------------------------------
\subsubsection{Transient, DC, OP only}
\begin{description}

\item[{\tt GEnerator}] The output of the ``signal generator''.  In a {\tt
TRansient} analysis, it shows the output of the signal generator, as set up
by the {\tt GENerator} command.  In a {\tt DC} analysis, it shows the DC
input voltage (not the power supply).  In a {\tt OP} analysis, it shows the
DC input, normally zero.

\index{iteration count}
\item[{\tt ITer(0)}] The number of iterations needed for convergence for
this printed step including any hidden steps.

\item[{\tt ITer(1)}] The number of iterations needed for convergence for
this printed step not including any hidden steps.

\item[{\tt ITer(2)}] The total number of iterations needed since startup
including check passes.

\item[{\tt Control(0)}] A number indicating why the simulator chose this
time to simulate at.
\begin{description}
\item{1} The user requested it.  One of the steps in a sweep.

\item{2} A discrete event.  An element required a solution at this time.

\item{3} The effect of the ``{\tt skip}'' parameter.

\item{4} The iteration count exceeded {\tt ITL4} so the last step was
rejected and is being redone at a smaller time step.

\item{5} The iteration count exceeded {\tt ITL3} so the time interval is the
same as it was last time.

\item{6} Determined by local truncation error or some other device dependent
approximation in hopes of controlling accuracy.

\item{7,8} The step size was limited to twice the previous step size.

\item{9} The step size was reduced to half the interval to an event to avoid
a tiny next step.

\item{10 + x} The previous step was rejected.

\item{20 + x} A zero time step was replaced by {\it mrt}.

\item{30 + x} The required step size less than {\it mrt}, so replaced by {\it mrt}.

\end{description}

\item[{\tt Control(1)}] The number internal time steps.  (1 if all steps are
printed.  One more than the number of hidden steps.)

\end{description}
%------------------------------------------------------------------------
\subsection{Element probes}

Each element type has several parameters that can be probed.  In general,
the form is {\tt Parameter(element)}.  Wild cards are allowed in element
names to allow probing the same parameter of a group of elements.

For components in a subcircuit, the names are connected with dots.  For
example {\tt R12.X13} is {\tt R12} in the subcircuit {\tt X13}.

Most two node elements (capacitors, inductors, resistors, sources) have at
least the following parameters available.  Others are available for some
elements.
%------------------------------------------------------------------------
\subsubsection{All modes}

\begin{description}

\item[{\tt V}] Branch voltage.  The first node in the net list is assumed
positive.

\item[{\tt I}] Branch current.  It flows into the first node in the net
list, out of the second.

\item[{\tt P}] Branch power dissipation.  Negative power indicates that the
part is supplying power.  In AC analysis, it is the real part only.

\item[{\tt EV}] The effective value of the part, in its units.  If the part
is ordinary, it will just show its value, but if it is time variant or
nonlinear, it shows what it is now.

\item[{\tt R}] Resistance.  The effective resistance of the part, in ohms.
In AC analysis, shows the magnitude of the self impedance.  In {\tt OP},
{\tt DC} or {\tt TRansient} analysis, shows its incremental resistance.  In
{\tt TRansient} analysis, it shows the effective Z-domain resistance of
inductors and capacitors.

\item[{\tt Y}] Admittance.

\item[{\tt Z}] Impedance at a port.  The port impedance seen looking into
the circuit across the branch.  In {\tt TRansient} analysis, it shows the
effective Z-domain impedance.

\end{description}
%------------------------------------------------------------------------
\subsubsection{AC only}

These parameters are available in addition to the above.

\begin{description}

\item[{\tt VM}] Voltage magnitude.

\item[{\tt VDB}] Decibels relative to 1 volt.

\item[{\tt VP}] Voltage phase.

\item[{\tt IM}] Current magnitude.

\item[{\tt IDB}] Decibels relative to 1 amp.

\item[{\tt IP}] Current phase.

\item[{\tt P}] Real power.

\item[{\tt PDB}] Decibels relative to 1 watt real power.

\item[{\tt PX}] Reactive (imaginary) power, volt-amps reactive.

\item[{\tt PXDB}] Decibels relative to 1 va reactive.

\item[{\tt PM}] Volt amps, complex power.

\item[{\tt PMDB}] Decibels relative to 1 va.

\item[{\tt PP}] Power phase (angle between voltage and current).

\item[{\tt PF}] Power factor (cosine of power phase).

\item[{\tt RM}] Self impedance magnitude.

\item[{\tt RP}] Self impedance phase.

\item[{\tt RR}] Resistance, self impedance real part.

\item[{\tt RI}] Reactance, self impedance imaginary part.

\item[{\tt YM}] Self admittance magnitude.

\item[{\tt YP}] Self admittance phase.

\item[{\tt YR}] Conductance, self admittance real part.

\item[{\tt YI}] Self admittance imaginary part.

\item[{\tt ZM}] Port impedance magnitude.

\item[{\tt ZP}] Port impedance phase.

\item[{\tt ZR}] Port impedance real part.

\item[{\tt ZI}] Port impedance imaginary part.

\end{description}
%------------------------------------------------------------------------
\subsection{Examples}

\begin{description}

\item[{\tt Print AC v(12) v(13) v(14)}] The voltage at nodes 12, 13, and 14
for AC analysis.

\item[{\tt Print DC v(r26)}] The voltage across {\tt R26}, for DC analysis.

\item[{\tt Print tran v(r83) p(r83)}] Voltage and power of {\tt R83}, for
transient analysis.

\item[{\tt Print dc i(c8) p(r5) z(r5)}] The current through {\tt C8}, power
dissipated in {\tt R5}, and the impedance seen looking into the circuit
across {\tt R5}.

\item[{\tt Print OP v(nodes)}] The voltage at all nodes for the {\tt op}
command.

\item[{\tt Print}] List all the probes, for all modes.

\item[{\tt Print OP}] Display the {\tt OP} probe list.

\item[{\tt Print AC CLear}] Clear the AC list.

\end{description}
%------------------------------------------------------------------------
%------------------------------------------------------------------------
SHAR_EOF
fi # end of overwriting check
if test -f 'man/Commands/quit.tex'
then
    echo shar: will not over-write existing file "'man/Commands/quit.tex'"
else
cat << \SHAR_EOF > 'man/Commands/quit.tex'
% quit  10/24/90
% man commands quit .
% Copyright 1983-1992   Albert Davis
%------------------------------------------------------------------------
\section{{\tt Quit} command}
\index{quit command}
\index{exit command}
%------------------------------------------------------------------------
\subsection{Syntax}
\begin{verse}
{\tt Quit}
\end{verse}
%------------------------------------------------------------------------
\subsection{Purpose}

Terminates the program.
%------------------------------------------------------------------------
\subsection{Comments}

`{\tt EXIt}' also works.

Be sure you have saved everything you want to!
%------------------------------------------------------------------------
%------------------------------------------------------------------------
SHAR_EOF
fi # end of overwriting check
if test -f 'man/Commands/save.tex'
then
    echo shar: will not over-write existing file "'man/Commands/save.tex'"
else
cat << \SHAR_EOF > 'man/Commands/save.tex'
% save  04/09/91
% man commands save .
% Copyright 1983-1992   Albert Davis
%------------------------------------------------------------------------
\section{{\tt SAve} command}
\index{save command}
\index{store the circuit}
\index{keep the circuit}
\index{file: save}
%------------------------------------------------------------------------
\subsection{Syntax}
\begin{verse}
{\tt SAve} {\it filename} \{{\it options} ...\}
\end{verse}
%------------------------------------------------------------------------
\subsection{Purpose}

Saves the circuit on the disk.
%------------------------------------------------------------------------
\subsection{Comments}

The {\it filename} extension {\tt .ckt} is added unless you specify something
else.  If you want it plain, with no extension, end the name with a dot.

%%%To save as a subcircuit, that can be included in other circuits, add the
%%%extension {\tt .mod} to the file name.

The file is in an ASCII format, so the list may be used as part of a
report.

If the file name specified already exists, the old file is deleted and
replaced by a new file of the same name, after asking you for permission.

You can save a part of a circuit.  See the {\tt List} command.
%------------------------------------------------------------------------
\subsection{Examples}

\begin{description}

\item[{\tt SAve works}] Save the circuit in the file {\tt works.ckt}, in the
current directory.

\item[{\tt SAve}] Save the circuit.  Since you did not specify a file name,
it will ask for one.

\item[{\tt SAve partof R*}] Save a partial circuit, just the resistors, to
the file {\tt partof.ckt}.  (See the {\tt List} command.)

\index{models: save}
\item[{\tt SAve q2n2222.mod}] Save this as a model file {\tt q2n2222.mod},
so it can be called as a macro-model later.  Note that model files must
start with a letter, so plain 2n2222.mod would be impossible to call.

\item[{\tt SAve /client/sim/ckt/no33}] You can specify a path name.

\end{description}
%------------------------------------------------------------------------
%------------------------------------------------------------------------
SHAR_EOF
fi # end of overwriting check
if test -f 'man/Commands/sens.tex'
then
    echo shar: will not over-write existing file "'man/Commands/sens.tex'"
else
cat << \SHAR_EOF > 'man/Commands/sens.tex'
% sens  04/09/91
% man commands sens
% Copyright 1983-1992   Albert Davis
%------------------------------------------------------------------------
\section{{\tt SENS} command}
\index{sens command}
\index{sensitivity analysis}
%------------------------------------------------------------------------
The Spice {\tt SENS} command is not implemented.  Similar
functionality is not available.
%------------------------------------------------------------------------
%------------------------------------------------------------------------
SHAR_EOF
fi # end of overwriting check
if test -f 'man/Commands/set.tex'
then
    echo shar: will not over-write existing file "'man/Commands/set.tex'"
else
cat << \SHAR_EOF > 'man/Commands/set.tex'
% set  04/03/90
% man commands set .
% Copyright 1983-1992   Albert Davis
%------------------------------------------------------------------------
\section{{\tt SEt} command}
\index{options command}
\index{set command}
\index{system options}
\index{options: global}
\index{global options}
%------------------------------------------------------------------------
\subsection{Syntax}
\begin{verse}
{\tt SEt}\\
{\tt SEt} {\it option-name value} ...
\end{verse}
%------------------------------------------------------------------------
\subsection{Purpose}

Sets options, iteration parameters, global data.
%------------------------------------------------------------------------
\subsection{Comments}

The `{\tt SEt}' command is the same as the `{\tt OPTions}' command.
%------------------------------------------------------------------------
%------------------------------------------------------------------------
SHAR_EOF
fi # end of overwriting check
if test -f 'man/Commands/status.tex'
then
    echo shar: will not over-write existing file "'man/Commands/status.tex'"
else
cat << \SHAR_EOF > 'man/Commands/status.tex'
% status  04/13/92
% man commands status .
% Copyright 1983-1992   Albert Davis
%------------------------------------------------------------------------
\section{{\tt STatus} command}
\index{status command}
\index{utilization}
\index{memory}
%------------------------------------------------------------------------
\subsection{Syntax}
\begin{verse}{\tt STatus}
\end{verse}
%------------------------------------------------------------------------
\subsection{Purpose}

Shows information on how the system resources are being utilized.
%------------------------------------------------------------------------
%------------------------------------------------------------------------
SHAR_EOF
fi # end of overwriting check
if test -f 'man/Commands/sweep.tex'
then
    echo shar: will not over-write existing file "'man/Commands/sweep.tex'"
else
cat << \SHAR_EOF > 'man/Commands/sweep.tex'
% sweep  04/03/90
% man commands sweep .
% Copyright 1983-1992   Albert Davis
%------------------------------------------------------------------------
\section{{\tt SWeep} command}
\index{sweep command}
\index{sweep component values}
\index{step component values}
%------------------------------------------------------------------------
\subsection{Syntax}
\begin{verse}
{\tt SWeep} \{{\it stepcount}\}  {\it partlabel value} ...
\end{verse}
%------------------------------------------------------------------------
\subsection{Purpose}

Sweep a component (or group of components) over a range.  Set up a loop for
iteration.
%------------------------------------------------------------------------
\subsection{Comments}

This command begins a loop which will sweep a component or group of
components.

When this command is given, the only apparent actions will be a change in the
prompt from `{\tt -->}' to `{\tt >>>}', and some disk action.

The different prompt means that commands are not executed immediately, but
are stored in a temporary file.

The bare command will repeat the same command sequence as the last time {\tt
SWeep} was run, and not prompt for anything else.

Additional components can be swept at the same time by entering a `{\tt
FAult}' command at the `{\tt >>>}' prompt.  The `{\tt FAult}' behaves
differently here:  It accepts a range, which is the sweep limits.

The `{\tt GO}' command will end the entry sequence, and make it all happen.
After this, the values are restored.  (Also, all {\tt FAult}s are restored,
as if by the `{\tt Restore}' command.)

All commands can be used in this mode.  Of course, some of them are not
really useful ({\tt Quit}) because they work as usual.

Only linear, ordinary parts can be swept.  (No semiconductor devices, or
elements using behavioral modeling.)  The tolerance remains unchanged.  If
you attempt to sweep a nonlinear or otherwise strange part, it becomes
ordinary and linear during the sweep.
%------------------------------------------------------------------------
\subsection{Example}

\begin{verbatim}
-->SWeep  5   R14=1,100k   R15=100k,1
>>>List
>>>AC 500 2k oct
>>>GO
\end{verbatim}

This sequence of commands says to simultaneously sweep R14 and R15 in 5 steps,
in opposite directions, list the circuit and do an AC analysis for each step.

Assuming the circuit was:
\begin{verbatim}
     R14  1   0   50k
     R15  2   0   50k
\end{verbatim}

The result of this sequence would be:
\begin{verbatim}
     R14  1   0   1
     R15  2   0   100k
\end{verbatim}
{\rm {\it an AC analysis}}
\begin{verbatim}
     R14  1   0   25.75k
     R15  2   0   75.25k
\end{verbatim}
{\rm {\it an AC analysis}}
\begin{verbatim}
     R14  1   0   50.5k
     R15  2   0   50.5k
\end{verbatim}
{\rm {\it an AC analysis}}
\begin{verbatim}
     R14  1   0   75.25k
     R15  2   0   25.75k
\end{verbatim}
{\rm {\it an AC analysis}}
\begin{verbatim}
     R14  1   0   100k
     R15  2   0   1
\end{verbatim}
{\rm {\it an AC analysis}}

After all this is done, the circuit is restored, so {\tt list} would show:
\begin{verbatim}
     R14  1   0   50k
     R15  2   0   50k
\end{verbatim}

You could accomplish the same thing by entering {\tt FAult} commands at the
`{\tt >>>}' prompt.

\begin{verbatim}
-->SWeep  5
>>>FAult  R14=1, 100k
>>>FAult  R15=100k, 1
>>>List
>>>AC 500 2k oct
>>>GO
\end{verbatim}
%------------------------------------------------------------------------
%------------------------------------------------------------------------
SHAR_EOF
fi # end of overwriting check
if test -f 'man/Commands/temp.tex'
then
    echo shar: will not over-write existing file "'man/Commands/temp.tex'"
else
cat << \SHAR_EOF > 'man/Commands/temp.tex'
% temp  04/05/90
% man commands temp .
% Copyright 1983-1992   Albert Davis
%------------------------------------------------------------------------
\section{{\tt TEmp} command}
\index{temp command}
%------------------------------------------------------------------------
The Spice {\tt TEmp} command is not implemented.  Similar
functionality is available by sweeping the {\tt op} command.
%------------------------------------------------------------------------
%------------------------------------------------------------------------
%------------------------------------------------------------------------
%------------------------------------------------------------------------
%------------------------------------------------------------------------
SHAR_EOF
fi # end of overwriting check
if test -f 'man/Commands/tf.tex'
then
    echo shar: will not over-write existing file "'man/Commands/tf.tex'"
else
cat << \SHAR_EOF > 'man/Commands/tf.tex'
% tf  04/05/90
% man commands tf .
% Copyright 1983-1992   Albert Davis
%------------------------------------------------------------------------
\section{{\tt TF} command}
\index{tf command}
\index{transfer function, dc}
%------------------------------------------------------------------------
The Spice {\tt TF} command is not implemented.  Similar functionality is
not available.
%------------------------------------------------------------------------
%------------------------------------------------------------------------
%------------------------------------------------------------------------
%------------------------------------------------------------------------
%------------------------------------------------------------------------
SHAR_EOF
fi # end of overwriting check
if test -f 'man/Commands/title.tex'
then
    echo shar: will not over-write existing file "'man/Commands/title.tex'"
else
cat << \SHAR_EOF > 'man/Commands/title.tex'
% title  04/02/90
% man commands title
% Copyright 1983-1992   Albert Davis
%------------------------------------------------------------------------
\section{{\tt TItle} command}
\index{title command}
\index{headings}
%------------------------------------------------------------------------
\subsection{Syntax}
\begin{verse}
{\tt TItle}\\
{\tt TItle} {\it a line of text}
\end{verse}
%------------------------------------------------------------------------
\subsection{Purpose}

View and create the heading line for printouts and files.
%------------------------------------------------------------------------
\subsection{Comments}

There is a header line at the beginning of every file, to help you identify
it in the future.  This command sets up what it says.  It also sets up a
heading for printouts and graphs.

When you use the `{\tt GET}' command to bring in a new circuit, it replaces the
title with the one in the file.  The `{\tt TItle}' command lets you change it,
for the next time it is written out.
%------------------------------------------------------------------------
\subsection{Examples}

\begin{description}

\item[{\tt TItle This is a test.}] Sets the file heading to `{\tt This is a
test.}' In the future, all files written will have `{\tt This is a test.}'
as their first line.

\item[{\tt TItle}] Displays the file heading.  In this case, it prints `{\tt
This is a test.}'

\end{description}
%------------------------------------------------------------------------
%------------------------------------------------------------------------
SHAR_EOF
fi # end of overwriting check
if test -f 'man/Commands/transient.tex'
then
    echo shar: will not over-write existing file "'man/Commands/transient.tex'"
else
cat << \SHAR_EOF > 'man/Commands/transient.tex'
% transient  12/29/92
% man commands transient .
% Copyright 1983-1992   Albert Davis
%------------------------------------------------------------------------
\section{{\tt Transient} command}
\index{transient command}
\index{time domain}
\index{nonlinear transient analysis}
%------------------------------------------------------------------------
\subsection{Syntax}
\begin{verse}
{\tt Transient} {\it start stop stepsize} \{{\it options} ...\}\\
{\tt Transient} {\it stepsize stop start} \{{\it options} ...\}
\end{verse}
%------------------------------------------------------------------------
\subsection{Purpose}

Performs a nonlinear time domain (transient) analysis.
%------------------------------------------------------------------------
\subsection{Comments}

The nodes to look at must have been previously selected by the {\tt Print} or
{\tt Plot} command.

Three parameters are normally needed for a Transient analysis: start time,
stop time and step size, in this order.  The SPICE order (step size, stop,
start) is also acceptable.

If all of these are omitted, the simulation will continue from where the most
recent one left off, with the same step size, unless the circuit topology has
been changed.  It will run for the same length of time as the previous run.

Do not use a step size too large as this will result in errors in the
results.  If you suspect that the results are not accurate, try a larger
argument to `Skip'.  This will force a smaller internal step size.  If the
results are close to the same, they can be trusted.  If not, try a still
larger `Skip' argument until they appear to match close enough.
\index{aliasing: transient}
\index{accuracy: transient}
\index{stability: transient}

The most obvious error of this type is aliasing.  You must select sample
frequency at least twice the highest signal frequency that exists anywhere in
the circuit.  This frequency can be very high, when you use the default step
function as input.  The signal generator does {\bf not} have any filtering.
%------------------------------------------------------------------------
\subsection{Options}

\begin{description}

%%%\item[{\tt <} {\it file}] Get circuit input from {\it file}.
%%%Default extension is {\tt .tr}.

\item[{\tt >} {\it file}] Send results of analysis to {\it
file}.  Default extension is {\tt .tr}.

\item[{\tt >>} {\it file}] Append results to {\it file}.
Default extension is {\tt .tr}.

%%%\item[{\tt ACMAx}] Use worst case max values, per last {\tt AC}
%%%analysis.

%%%\item[{\tt ACMIn}] Use worst case min values, per last {\tt AC}
%%%analysis.

\item[{\tt ALL}] Show all internal time steps.  (Extra steps
requested by {\tt Skip}, events, and by automatic time step control.)

\item[{\tt Cold}] Zero initial conditions.  Cold start from
power-up.

%%%\item[{\tt DCMAx}] Use worst case max values, per last {\tt DC}
%%%or {\tt OP} analysis.

%%%\item[{\tt DCMIn}] Use worst case min values, per last {\tt DC}
%%%or {\tt OP} analysis.

\item[{\tt Echo}] Echo disk reads to console, when input is
from a file.

%%%\item[{\tt LAg}] Use worst case values, for lagging phase, per
%%%{\tt AC} analysis.

%%%\item[{\tt LEad}] Use worst case values, for leading phase, per
%%%{\tt AC} analysis.

\item[{\tt NOPlot}] Suppress plotting.

\item[{\tt PLot}] Graphic output, when plotting is otherwise
off.

\item[{\tt Quiet}] Suppress console output.

\item[{\tt Skip} {\it count}] Force at least {\it count} simulation
steps for each one displayed.  If the output is a table or ASCII plot, the
extra steps are hidden.

\item[{\tt STiff}] Use a different integration method that will
suppress overshoot when the step size is too small.

%%%\item[{\tt Table}] Tabular output. Override default plot.

\item[{\tt TEmperature} {\it degrees}] Temperature, degrees C.

\end{description}
%------------------------------------------------------------------------
\subsection{Examples}

\begin{description}

\item[{\tt Transient 0 100u 10n}] Start at time 0, stop after
100 micro-seconds.  Simulate using 10 nanosecond steps.

\item[{\tt Transient}] No parameters mean to continue from the last run.  In
this case it means to step from 100 us to 200 us in 10 ns steps.  (The same
step size and run length, but offset to start where the last one stopped.

\item[{\tt Transient Skip 10}] Do 10 extra steps internally for every step
that would be done otherwise.  In this case it means to internally step at 1
nanosecond.  If the output is in tabular form, the extra steps are hidden.

\item[{\tt Transient 0}] Start over at time = 0.  Keep the same
step size and run length.

\item[{\tt Transient Cold}] Zero initial conditions.  This will
show the power-on transient.

\item[{\tt Transient >arun}] Save the results of this run in
the file {\tt arun.tr}.

%%%\item[{\tt Transient < aninput}] Use the file {\tt aninput.tr}
%%%as a user defined input.  It substitutes for the signal
%%%generator.

\end{description}
%------------------------------------------------------------------------
%------------------------------------------------------------------------
SHAR_EOF
fi # end of overwriting check
if test -f 'man/Commands/unfault.tex'
then
    echo shar: will not over-write existing file "'man/Commands/unfault.tex'"
else
cat << \SHAR_EOF > 'man/Commands/unfault.tex'
% unfault  03/07/90
% man commands unfault .
% Copyright 1983-1992   Albert Davis
%------------------------------------------------------------------------
\section{{\tt UNFault} command}
\index{faults: restore}
\index{unfault command}
\index{change values: temporary}
%------------------------------------------------------------------------
\subsection{Syntax}
\begin{verse}
{\tt UNFault}
\end{verse}
%------------------------------------------------------------------------
\subsection{Purpose}

Undo any action from {\tt FAult} commands.
%------------------------------------------------------------------------
\subsection{Comments}

This command reverses the action of all {\tt FAult} commands.

It will also clean up any side effects of an aborted {\tt SWeep} command.

{\tt UNFault} is automatically invoked on any {\tt CLEAR} command.

If you change the circuit in any other way, {\tt UNFault} will bring back the
old on top of the changes.  This can bring on some surprises.
%------------------------------------------------------------------------
\subsection{Example}

\begin{description}

\item[{\tt FAult R66=1k}] R66 now has a value of 1k, regardless of what it
was before.

\item[{\tt UNFault}] Clears all faults.  In this case, R66 has its old value
again.

\end{description}

{\tt UNFault} can bring on surprises.  Consider this sequence ...

\begin{verbatim}
V1   1   0    ac  1
C3   1   2    1u
R4   2   0    10k
\end{verbatim}

\begin{description}

\item[{\tt FAult C3=100p}] C3 is 100 picofarads, for now.

\item[{\tt Modify C3=220p}] C3 is 220 pf, for now.  It will be restored.

\item[{\tt Modify R4=1k}] R4 is 1k.  It will not be restored.

\item[{\tt Restore}] C3 back to 1 uf, but R4 still 1k.

\end{description}
%------------------------------------------------------------------------
%------------------------------------------------------------------------
SHAR_EOF
fi # end of overwriting check
if test -f 'man/Commands/unmark.tex'
then
    echo shar: will not over-write existing file "'man/Commands/unmark.tex'"
else
cat << \SHAR_EOF > 'man/Commands/unmark.tex'
% unmark  01/20/93
% man commands unmark .
% Copyright 1983-1992   Albert Davis
%------------------------------------------------------------------------
\section{{\tt UNMark} command}
\index{unmark command}
\index{transient reruns}
%------------------------------------------------------------------------
\subsection{Syntax}
\begin{verse}
{\tt UNMark}
\end{verse}
%------------------------------------------------------------------------
\subsection{Purpose}

Forget remembered circuit voltages and currents.  Undo the `{\tt mark}'
command.
%------------------------------------------------------------------------
\subsection{Comments}

Allow time to proceed.  It has been held back by the `{\tt mark}' command.
%------------------------------------------------------------------------
\subsection{Examples}

\begin{description}
\item[{\tt Transient 0 1 .01}] A transient analysis starting at zero,
running until 1 second, with step size .01 seconds.  After this run, the
clock is at 1 second.

\item[{\tt mark}] Remember the time, voltages, currents, etc.

\item[{\tt Transient}] Another transient analysis.  It continues from 1
second, to 2 seconds.  (It spans 1 second, as before.)  This command was not
affected by the {\tt mark} command.

\item[{\tt Transient}] This will do exactly the same as the last one.  From
1 second to 2 seconds.  If it were not for {\tt mark}, it would have started
from 2 seconds.

\item[{\tt Transient 1.5 .001}] Try again with smaller steps.  Again, it
starts at 1 second.

\item[{\tt UNMark}] Release the effect of {\tt mark}.

\item[{\tt Transient}] Exactly the same as the last time, as if we didn't
{\tt UNMark}.  (1 to 1.5 seconds.)

\item[{\tt Transient}] This one continues from where the last one left off:
at 1.5 seconds.  From now on, time will move forward.

\end{description}

%------------------------------------------------------------------------
%------------------------------------------------------------------------
SHAR_EOF
fi # end of overwriting check
if test -f 'man/Commands/width.tex'
then
    echo shar: will not over-write existing file "'man/Commands/width.tex'"
else
cat << \SHAR_EOF > 'man/Commands/width.tex'
% width  04/04/90
% man commands width .
% Copyright 1983-1992   Albert Davis
%------------------------------------------------------------------------
\section{{\tt Width} command}
\index{width command}
\index{in option}
\index{input width option}
\index{width command}
\index{out option}
\index{output width option}
%------------------------------------------------------------------------
\subsection{Syntax}
\begin{verse}
{\tt Width \{{\tt IN=}{\it value}\}} \{{\tt OUT=}{\it value}\}
\end{verse}
%------------------------------------------------------------------------
\subsection{Purpose}

Set input and output width.
%------------------------------------------------------------------------
\subsection{Comments}

The `{\tt Width}' command is the same as the `{\tt OPTions}'
command.  It is provided for SPICE compatibility.  SPICE uses
{\tt width} to set two parameters: {\tt IN} and {\tt OUT},
which we set with the {\tt options} command.
%------------------------------------------------------------------------
%------------------------------------------------------------------------
SHAR_EOF
fi # end of overwriting check
#    End of shell archive
exit 0