AcuSig

Signal AcuSolve to perform certain actions while it is executing.

Syntax

acuSig [options]

Type

AcuSolve Solver Program Command

Description

AcuSig is used to send a signal to AcuSolve while the latter is executing in order to change its behavior.

In the following, the full name of each option is followed by its abbreviated name and its type. For a general description of option specifications, see Command Line Options and Configuration Files. See below for more individual option details:

help or h (boolean)
If set, the program prints a usage message and exits. The usage message includes all available options, their current values, and the place where each option is set.
problem or pb (string)
The name of the problem is specified via this option. This name is used to generate and recognize internal files.
problem_directory or pdir (string)
The home directory of the problem. This is where the user input files reside. This option allows AcuSig to be executed from any directory and still affect the problem in the given directory. If problem_directory is set to ".", namely the Unix current directory, it is replaced by the full address of the current directory, as provided by the Unix getcwd command.
working_directory or dir (string))
All internal files are stored in this directory. This directory does not need to be on the same file system as the input files of the problem.
run_id or run (integer)
Run number the signal applies to. If 0, the latest run is used.
stop (boolean)
Signal AcuSolve to stop at the end of the current time step.
stop_time_step or sts (integer)
Signal AcuSolve to stop at the end of time step sts. -1 indicates do not stop.
halt (boolean)
Signal AcuSolve to stop as soon as possible.
output or out (boolean)
Signal AcuSolve to write nodal output to disk at the end of the current time step.
output_time_steps or ots (string)
Comma separated list of time steps to be output.
output_times or otv (string)
Comma separated list of times to be output.
force_output_restart or rst (boolean)
Signal AcuSolve to write restart output to disk at the end of the current time step.
output_residual or res (boolean)
Signal AcuSolve to write nodal residual to disk at the end of the current time step.
output_projection_vecs or pvout (boolean)
Signal AcuSolve to output the nodal projection vectors at the end of the current time step.
not_converged or nc (boolean)
Signal AcuSolve the current time step is not converged.
do_not_amp_timeinc or nati (boolean)
Signal AcuSolve to not increase the time increment of this step.
reduce_timeinc or rti (boolean)
Signal AcuSolve to reduce the time increment of the next time step.
redo_step or rts (boolean)
Signal AcuSolve to redo the current time step with a smaller time increment if possible.
must_redo_step or mrts (boolean)
Signal AcuSolve to redo the current time step with a smaller time increment, or exit if not possible.
flush (boolean)
Signal AcuSolve to flush the .log file buffer.
line_buff or lbuff (boolean)
Signal AcuSolve to flush the .log file buffer for each line.
set_verbose or sv (integer)
Set the solver verbose level for printing information to the screen. Each higher verbose level prints more information. If set_verbose is set to 0, or less, only solver warning and error messages are printed. If set_verbose is set to 1, basic processing information is printed in addition to warning and error messages. This level is recommended. set_verbose levels greater than 1 provide additional information useful only for debugging.
user_global_data or data (string)
Send a name=value message to AcuSolve.
verbose or v (integer)
Set the verbose level for printing information to the screen. Each higher verbose level prints more information. If verbose is set to 0, or less, only warning and error messages are printed. If verbose is set to 1, basic processing information is printed in addition to warning and error messages. This level is recommended. verbose levels greater than 1 provide information useful only for debugging.

Examples

The following command will cause AcuSolve to terminate normally at the end of the current time step, including performing all the output expected at the end of a run:
acuSig -pb channel -stop
or alternatively if the configuration file Acusim.cnf contains
problem = channel
then AcuSig may be invoked as:
acuSig -stop
Normally, AcuSig is issued in the problem directory. However, AcuSig may be issued from any directory provided that problem directory is given on the command line. For example,
acuSig -stop -pdir $ACUSIM_HOME/HP/latest/examples/channel
To signal AcuSolve to stop as above but as soon as possible, execute:
acuSig -halt
To signal AcuSolve to write out nodal output at the end of the current step, execute:
acuSig -out
To signal AcuSolve to write out nodal output at the end of several specific time steps, execute:
acuSig -ots "18,20,22"

For the three commands below, AcuSolve will continue to execute normally after the current step. However, they all may be combined with -stop to cause AcuSolve to stop after the output is written.

To signal AcuSolve to write out nodal output at several specific times, actual output is at the end of the time step containing each time, execute:
acuSig -otv "3.5,4.0,4.5"
To signal AcuSolve to write out restart output at the end of the current step, execute:
acuSig -rst
To signal AcuSolve to write out nodal residual output at the end of the current step, execute:
acuSig -res
Normally the .log file is flushed at the end of every step. To flush it immediately, but just once, execute:
acuSig -flush
To cause the .log file buffer to be flushed for every line, execute:
acuSig -lbuff
To return to the normal behavior of flushing the .log file buffer at the end of every step:
acuSig -no_lbuff
To change the verbose level of the solver so that it will output basic processing information in addition to warning and error messages, execute:
acuSig -sv 1
A value for the user global data var 1 may be passed to a running AcuSolve job by issuing the command:
acuSig -data "var 1 = 332"

The value takes effect at the beginning of the next time step.