Index: mttroot/mtt/doc/mtt.texi ================================================================== --- mttroot/mtt/doc/mtt.texi +++ mttroot/mtt/doc/mtt.texi @@ -14,10 +14,14 @@ @comment %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @comment Version control history @comment %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @comment $Id$ @comment $Log$ +@comment Revision 1.27 2005/01/06 14:42:33 geraint +@comment Fixed explicit/implicit descriptions of forward/backward Euler. +@comment Replaced -c examples with -cc. +@comment @comment Revision 1.26 2005/01/06 12:28:36 geraint @comment Minor typos. @comment @comment Revision 1.25 2004/08/27 20:12:34 geraint @comment Added note about "none" as an option for units. @@ -443,12 +447,18 @@ * Options:: * Utilities:: Options +* Available options:: * Model-specific options:: +Available options + +* Experimental options:: +* Deprecated options:: + Utilities * Help:: * Copy:: * Clean:: @@ -1275,76 +1285,115 @@ Means that the previous example can be executed using @example mtt syst cbg view @end example -The available options are: -@vtable @code -@item -q - quiet mode -- suppress MTT banner -@item -A - solve algebraic equations symbolically -@item -ae - solve algebraic equations numerically - (this option requires -cc or -oct) -@item -D - debug -- leave log files etc -@item -I - prints more information -@item -abg - start at abg.m representation -@item -c - c-code generation -@item -cc - C++ code generation -@item -d - use directory -@item -dc - Maximise derivative (not integral) causality -@item -dc - Maximise derivative (not integral) causality -@item -i - Use implicit, euler or Runge Kutta IV integration -@item -o - ode is same as dae -@item -oct - use oct files in place of m files where appropriate -@item -opt - optimise code generation -@item -p - print environment variables -@item -partition - partition hierachical system -@item -r - reset time stamp on representation -@item -s - try to generate sensitivity BG (experimental) -@item -ss - use steady-state info to initialise simulations -@item -stdin - read input data from standard input for simulations -@item -sub - operate on this subsystem -@item -t - tidy mode (default) -@item -u - untidy mode (leaves files in current dir) -@item -v - verbose mode (multiple uses increase the verbosity) -@item -viewlevel - View N levels of hierachy -@item --version - print version and exit -@item --versions - print version of mtt and components and exit -@end vtable - @menu +* Available options:: * Model-specific options:: @end menu -@node Model-specific options, , Options, Options +@node Available options, Model-specific options, Options, Options +@comment node-name, next, previous, upThe available options are: +@subsection Available options +@vtable @code +@item -A + solve algebraic equations symbolically +@item -abg + start at abg.m representation +@item -ae + algebraic equation solver: reduce|hybrd|dassl|hooke +@item -cc + C++ code generation +@item -cr + use cr before resolving equations +@item -D + debug -- leave log files etc +@item -d + use directory +@item -dc + maximise derivative (not integral) causality +@item -dr + use files contained in +@item -I + prints more information +@item -i + integration method: implicit|euler|rk4|dassl +@item -o + ode is same as dae +@item -oct + use oct files in place of m files where appropriate +@item -opt + optimise code generation (equivalent to -optl) +@item -optl + locally optimise code generation (line-by-line) +@item -ntmpvar + declare temporary variables (default=$num_tmp_var) +@item -p + print environment variables +@item -partition + partition hierachical system +@item -pdf + generate pdf in place of ps +@item -q + quiet mode -- suppress MTT banner +@item -r + reset time stamp on representation +@item -s + generate sensitivity BG (use mtt -s sSys rep lang) +@item -ss + use steady-state info to initialise simulations +@item -stdin + read input data from standard input for simulations +@item -sub + operate on subsystem +@item -t + tidy mode (default) +@item -trace + just indicate what mtt will do - but do not do it +@item -u + untidy mode (leaves files in current dir) +@item -v + verbose mode (multiple uses increment the verbosity) +@item --version + print version and exit +@item --versions + print version of mtt and components and exit +@item -viewlevel + view levels of hierachy +@end vtable + +@menu +* Experimental options:: +* Deprecated options:: +@end menu + +@node Experimental options, Deprecated options, Available options, Available options +@comment node-name, next, previous, up +@subsubsection Experimental options +There are some experimental options. These have not yet been heavily tested and should be used with caution. +@vtable @code +@item -optg + globally optimise code generation (full vector) +@item -make-sort + use sorted equations (sese, generated by make) +@item -no-reduce + try not to use symbolic algebra +@item -sort + use sorted equations (sese, generated by seqn) +@end vtable + +@node Deprecated options, , Experimental options, Available options +@comment node-name, next, previous, up +@subsubsection Deprecated options +C code generation is now deprecated in favour of C++ generation +@vtable @code +@item -c + c-code generation +@end vtable + +@node Model-specific options, , Available options, Options @subsection Model specific options @cindex Model-specific options It is often desirable to keep the options used to build a model associated with the directory in which the model is contained, along with information about compiler options or paths to component libraries. In these cases, it is convenient to create an executable shell script, say @code{call_mtt} which sets environment variables and options before calling mtt proper, for example: @example @verbatim @@ -4708,10 +4757,14 @@ # %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% # %% Version control history # %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% # %% $Id$ # %% $Log$ +# %% Revision 1.27 2005/01/06 14:42:33 geraint +# %% Fixed explicit/implicit descriptions of forward/backward Euler. +# %% Replaced -c examples with -cc. +# %% # %% Revision 1.26 2005/01/06 12:28:36 geraint # %% Minor typos. # %% # %% Revision 1.25 2004/08/27 20:12:34 geraint # %% Added note about "none" as an option for units.