4.2.4. aaS Commands (aaS.)

aaS commands are used to perform client/server interactions with a connected Fluent as a Server session. These include commands to set/get rpvar values, alter verbosity, and so on. aaS commands begin with the prefix aaS.

The aaS commands are described in the following sections, and are grouped based on whether they can provide an “instant” response (because they only require existing data) or whether they must “collaborate” with Fluent processes and therefore may require a waiting period to respond. Note that instant commands can be called from a collaborative object, but will not be executed until Fluent is idle or at a stable point.

4.2.4.1. Instant Commands

The following commands can always provide an instant response, as they use existing data and can be executed even if Fluent is not currently idle or at a stable point.

aaS.get_current_flow_time

provides the current flow time.

aaS.get_current_iteration

provides the current iteration.

aaS.get_current_time_step

provides the current time step.

aaS.get_dimensionality

provides the dimensionality of the current case.

aaS.get_last_casefile_name

provides the name of the last case file accessed before the current case. This can be useful if you have written the case file with a new name.

aaS.get_list_input_parameters

provides a list of the input parameters available in the current case.

aaS.get_list_output_parameters

provides a list of the output parameters available in the current case.

aaS.get_nr_input_parameters

provides the number of input parameters available in the current case.

aaS.get_nr_output_parameters

provides the number of output parameters available in the current case.

aaS.get_paused_index

returns an index indicating the “depth” of pause. When Fluent is not paused, it will return 0. It is incremented with each successive pause instruction. This can be useful to determine the state of a session if the connection is lost while Fluent is paused.

aaS.get_precision

specifies whether the solution calculations for the current case will be performed in single- or double-precision mode.

aaS.get_release

provides the name of the solver and the release number.

aaS.get_status

provides information about the status of the Fluent session (for example, journaling, iterate).

aaS.list_monitors <monitor_type> <monitor_name>

returns a JSON-formatted listing of the monitor definitions in the current case. <monitor_type> may be one of the following types: residuals, lift, drag, moment, surface, or volume. If no arguments are given, Fluent returns all defined monitors. If only <monitor_type> is given, all monitors of the specified type are returned.

aaS.list_monitors_with_persisted_data <monitor_type> <monitor_name> <filter> <filter_value>

returns a JSON-formatted listing of the monitor definitions in the current case, including the data from the monitor history file (if any). Options for <monitor_type> are the same as those listed for aaS.list_monitors. <filter> allows you to return incremental monitor data, by removing the data calculated before the specified <filter_value>; a single command can include one or more of the following <filter> options: start-flow-time, start-iteration, and start-time-step.

aaS.list_report_definitions

returns a JSON-formatted listing of the report definitions in the current case. For more information about report definitions, see Creating Report Definitions in the Fluent User's Guide.

aaS.list_report_files

returns a JSON-formatted listing of the report file definitions in the current case. If no arguments are given, Fluent returns all defined report files. For more information about report files, see Report Files and Report Plots in the Fluent User's Guide.

aaS.list_report_files_with_persisted_data <filter> <filter_value>

returns a JSON-formatted listing of the report file definitions in the current case, including the data from the report file .out file (if any). For more information about report files, see Report Files and Report Plots in the Fluent User's Guide. <filter> allows you to return incremental report file data, by removing the data calculated before the specified <filter_value>; a single command can include one or more of the following <filter> options: start-iteration and start-time-step.

aaS.list_report_plots

returns a JSON-formatted listing of the report plot definitions in the current case. For more information about report plots, see Report Files and Report Plots in the Fluent User's Guide.

aaS.save_monitors_with_persisted_data <monitor_file_name>

saves a JSON-formatted file on the remote Fluent machine with the data (if it exists) from all monitors defined in the current case.

aaS.set_auto_save_period_json_monitors <period_in_minutes>

allows you to change the period for when monitor history data is automatically saved as a JSON-formatted file (named monitor.json) on the remote Fluent machine. By default, the period is set to 60 minutes. Note that it is recommended that you do not have multiple sessions in a single folder, as they will all have the same name for the monitor history file.

4.2.4.2. Collaborative Commands

The following commands collaborate with Fluent processes and therefore cannot be executed until Fluent is idle or at a stable point. This means that you are not guaranteed to have an instant response when you enter the command.


Tip:  The following strategies can be used to minimize the lag between when you enter a command and when it is executed:

  • Set the aaS.set_aaslistening_step_at <number> iteration|timestep command to a minimum value, based on your objectives. Note that by decreasing the iterations / timesteps between stable points, you are favoring cosimulation over simulation (that is, you are prioritizing your ability to manipulate the settings over the time it will take to calculate the solution).

  • You can nest a number of commands between aaS.pause and aaS.continue commands, so that they are all executed during the same stable point; otherwise, each command will have to wait for a separate stable point.

  • For aaS. commands that have an equivalent fluent. command (see Fluent as a Server Commands (fluent.)), it may be preferable to use the latter: fluent. commands undergo lexical and semantic checks that ensure you are not needlessly waiting on a poorly formed command, and allow you to use the Tab key to automatically complete partially typed commands for the sake of convenience and accuracy.


aaS.continue

continues remote execution of a journal file on the Fluent server.

aaS.get_aaslistening_step

provides information about the aaslistener that listens for commands from Fluent as a Server clients.

aaS.interrupt

interrupts remote execution of a journal file on the Fluent server. Note that this terminates reading of the journal file. If you want to be able to resume execution where it was stopped, use aaS.pause.

aaS.pause

pauses remote execution of a journal file on the Fluent server. Execution can be resumed using the aaS.continue command.

aaS.set_aaslistening_step_at <number> iteration|timestep

configures the aaslistener to listen for commands from Fluent as a Server clients every <number> iterations or timesteps.

aaS.read_journal

loads a journal and executes it asynchronously (control is immediately returned to the user). The status of the journal execution can be checked using aaS.get_status.


Release 18.2 - © ANSYS, Inc. All rights reserved.