Chapter 8: Parametric Study Text Commands

These are the text commands available for using parametric studies:

parametric-study/

Enter the parametric study menu.

parametric-study/design-points/

Enter the design point menu for a parametric study.

parametric-study/design-points/add

Adds the design point to the parametric study.

parametric-study/design-points/auto-create/

Enters the auto-create menu for automatically creating and adding design points to your parametric study.

parametric-study/design-points/auto-create/create-design-points

Creates design points based on your settings. Choose from a list of sampling types, specify the number of samples, whether or not you want to remove existing design points, as well as upper and lower limits for your input parameters.

parametric-study/design-points/auto-create/export-designs

Generates an optiSLang-compatible output file to a location of your choice, containing the details of the updated design points.

parametric-study/design-points/auto-create/get-number-of-designs

Computes the number of designs of experiments, based on the sampling type designation and the number of levels.

parametric-study/design-points/auto-create/go-to-optislang

Creates a copy of the optiSLang project from the simulation directory (*.opf), places it inside your working directory (as designated in the Fluent Launcher, and opens the copied project in optiSLang.

parametric-study/design-points/auto-create/list-current-settings

Lists the current settings for the automatically generated design points (for example, samping type, number of levels,number of samples, etc.).

parametric-study/design-points/auto-create/open-designs-in-optislang-postprocessor

Opens the optiSLang postprocessor using a generated optiSLang-compatible output file (located, by default, under the current simulation directory) containing the details of the updated design points.

parametric-study/design-points/auto-create/print-to-console/

Enters the print-to-console menu where you can manage settings for automatically creating design points for your parametric study.

parametric-study/design-points/auto-create/print-to-console/delete-existing-design-points?

Prints the current value of the Delete Existing Design Points setting.

parametric-study/design-points/auto-create/print-to-console/number-of-levels

Prints the current value of the Number of Levels setting.

parametric-study/design-points/auto-create/print-to-console/number-of-samples

Prints the current value of the Number of Samples setting.

parametric-study/design-points/auto-create/print-to-console/range-of-input-parameter

Prints the current range of the specified input parameter

parametric-study/design-points/auto-create/print-to-console/sampling-type

Prints the current value of the Sampling Type setting.

parametric-study/design-points/auto-create/optimize/

Enter the optimization menu where you can set optiSLang-specific optimization methods and their various properties.

parametric-study/design-points/auto-create/optimize/print-to-console/

Enters the print-to-console menu where you can manage settings for automatically creating optimized design points for your parametric study.

parametric-study/design-points/auto-create/optimize/print-to-console/active-and-inactive

Prints the currently active and inactive design points.

parametric-study/design-points/auto-create/optimize/print-to-console/algorithm

Prints the current optimization algorithm.

parametric-study/design-points/auto-create/optimize/print-to-console/algorithm-settings/

Enters the menu that controls the printing of your optimization algorithm settings to the console.

parametric-study/design-points/auto-create/optimize/print-to-console/algorithm-settings/consider-failed-designs

Prints the value of the Consider Failed Designs field.

parametric-study/design-points/auto-create/optimize/print-to-console/algorithm-settings/iteration-number-of-samples

Prints the value of the iteration-based Number of Samples field.

parametric-study/design-points/auto-create/optimize/print-to-console/algorithm-settings/iteration-sampling-type

Prints the value of the iteration-based Sampling Type field.

parametric-study/design-points/auto-create/optimize/print-to-console/algorithm-settings/max-iterations

Prints the value of the convergence criteria-based Maximum Iterations field.

parametric-study/design-points/auto-create/optimize/print-to-console/algorithm-settings/max-number-of-samples

Prints the value of the Maximum Number of Samples field.

parametric-study/design-points/auto-create/optimize/print-to-console/algorithm-settings/refinement-number-of-samples

Prints the value of the refinement-based Number of Samples field.

parametric-study/design-points/auto-create/optimize/print-to-console/algorithm-settings/refinement-sampling-type

Prints the value of the refinement-based Sampling Type field.

parametric-study/design-points/auto-create/optimize/print-to-console/algorithm-settings/refinement-type

Prints the value of the Refinement Type field.

parametric-study/design-points/auto-create/optimize/print-to-console/algorithm-settings/stagnation-iterations

Prints the value of the convergence criteria-based Stagnation Iterations field.

parametric-study/design-points/auto-create/optimize/print-to-console/algorithm-settings/target-cop

Prints the value of the convergence criteria-based Target CoP field.

parametric-study/design-points/auto-create/optimize/print-to-console/criteria

Prints the current criteria that have been defined.

parametric-study/design-points/auto-create/optimize/print-to-console/results-csv-path

Prints the current file name and location of the CSV file that contains the results of the optimized parametric study.

parametric-study/design-points/auto-create/optimize/run-optimization

Prints a summary of your current optimization settings, prompting you to confirm whether or not you want to run the optimization with the current settings.

parametric-study/design-points/auto-create/optimize/set/

Enters the menu where you can set your optimization properties.

parametric-study/design-points/auto-create/optimize/set/algorithm

Specify the optimization algorithm.

parametric-study/design-points/auto-create/optimize/set/algorithm-settings/

Enter the menu for setting specific optimization algorithm properties.

parametric-study/design-points/auto-create/optimize/set/algorithm-settings/consider-failed-designs

Sets the value of the Consider Failed Designs field.

parametric-study/design-points/auto-create/optimize/set/algorithm-settings/iteration-number-of-samples/levels

Sets the value of the iteration-based Nunber of Samples/Levels field.

parametric-study/design-points/auto-create/optimize/set/algorithm-settings/iteration-sampling-type

Sets the value of the iteration-based Sampling Type field.

parametric-study/design-points/auto-create/optimize/set/algorithm-settings/max-iterations

Sets the value of the convergence criteria-based Maximum Iterations field.

parametric-study/design-points/auto-create/optimize/set/algorithm-settings/max-number-of-samples

Sets the value of the settings-based Maximum Number of Samples field.

parametric-study/design-points/auto-create/optimize/set/algorithm-settings/refinement-number-of-samples

Sets the value of the refinement-based Number of Samples field.

parametric-study/design-points/auto-create/optimize/set/algorithm-settings/refinement-sampling-type

Sets the value of the refinement-based Sampling Type field.

parametric-study/design-points/auto-create/optimize/set/algorithm-settings/refinement-type

Sets the value of the settings-based Refinement Type field.

parametric-study/design-points/auto-create/optimize/set/algorithm-settings/target-cop

Sets the value of the convergence criteria-based Target CoP field.

parametric-study/design-points/auto-create/optimize/set/criteria

Specify a criteria to add, delete, or edit for your optimization study.

parametric-study/design-points/auto-create/optimize/set/lower-and-upper-bounds

Specify the lower and upper bounds of your input parameters.

parametric-study/design-points/auto-create/optimize/set/results-csv-path

Specify the location and file name for the CSV file that will hold the results of your optimization study.

parametric-study/design-points/auto-create/optimize/set/set-parameter-as-active-or-inactive

Specify the value of your input parameters and whether or not they will be active or inactive.

parametric-study/design-points/clear-data-and-edit-values

Removes the data of a designated design point, allowing you to reset the design point and enter new information.

parametric-study/design-point/concurrent

Enters the concurrent menu for parametric design points.

parametric-study/design-point/concurrent/abort-all-design-points

Stops the concurrent update of all design points.

parametric-study/design-point/concurrent/abort-design-point

Stops the concurrent update of the design point.

parametric-study/design-point/concurrent/refresh-status

Refreshes the status of the design points that are being updated in the session, if any.

parametric-study/design-points/delete

Removes the design point from the parametric study.

parametric-study/design-points/duplicate

Creates a copy of a specified design point.

parametric-study/design-points/load-case-data-for-current-dp

Takes the case data for the current design point and loads the data into Fluent.

parametric-study/design-points/print-to-console/

Enters the print-to-console menu for the design points of your parametric study.

parametric-study/design-points/print-to-console/capture-simulation-report-data

Prints the value for the Capture Simulation Report Data setting for the design point, where this field determines whether or not design point data is captured for the simulation report.

parametric-study/design-points/print-to-console/current-dp

Prints the "current" design point.

parametric-study/design-points/print-to-console/input-parameters-of-dp

Prints the value(s) for the input parameters of a design point.

parametric-study/design-points/print-to-console/output-parameters-of-dp

Prints the value(s) for the output parameters of a design point.

parametric-study/design-points/print-to-console/status-of-all-dps

Prints the status for all design points in the study.

parametric-study/design-points/print-to-console/status-of-dp

Prints the status for the current design point in the study.

parametric-study/design-points/print-to-console/write-data

Prints the value for the Write Data setting for the design point (where the Write Data field determines how a design point writes its data upon update).

parametric-study/design-points/save-journals

Allows you to save the journal files for all design points that are currently in a "Needs Update" state.

parametric-study/design-points/set/

Enter the set menu for the design points of your parametric study.

parametric-study/design-points/set/capture-simulation-report-data

Sets the value for the Capture Simulation Report Data setting for the design point, where this field determines whether or not design point data is captured for the simulation report.

parametric-study/design-points/set/current-dp

Sets the designated design point to be "current."

parametric-study/design-points/set/input-parameters-of-dp

Sets the value(s) of the input parameters for a design point.

parametric-study/design-points/set/write-data

Sets the value for the Write Data setting for the design point (where the Write Data field determines how a design point writes its data upon update).

parametric-study/design-points/table/

Enter the table menu for the design points of your parametric study.

parametric-study/design-points/table/export-design-table

Export the contents of your design point table to an external .csv file.

parametric-study/design-points/table/import-design-table

Import the contents for your design point table from an external .csv file.

parametric-study/study/

Enter the study menu for a parametric analysis. If a parametric study has yet to be defined, then only the initialize text command is available. Once a study is initialized, then additional parametric commands become available to use.

parametric-study/study/delete

Removes a specified parametric study.

parametric-study/study/duplicate

Creates a copy of a specified parametric study.

parametric-study/study/initialize

Initializes and starts the parametric study using the current case and/or data files to set up the supporting files and structures for the associated parametric project.

parametric-study/study/list

Prints a listing of the available studies.

parametric-study/study/rename

Allows you to assign a new name for a specified study.

parametric-study/study/set-as-current

Allows you to set a specified study as the "current" study.

parametric-study/study/use-base-data

Assigns the data of a specified study to use the data from the base case of the original study.

parametric-study/study/use-data-of-previous-dp

Assigns the data from a previously updated design point.

parametric-study/update/

Enter the update menu for a parametric study where you can control how to update your design points.

parametric-study/update/auto-update-mesh-morphs

Automatically executes any configured mesh morphing definitions that are specified. This command is available if there are any defined input parameters attached to mesh morphing definitions. When invoked, Fluent executes the mesh morphing operation(s) after updating the parameter values and before solution initialization.

parametric-study/update/concurrent/

Enter the concurrent menu for updating your parametric study.

parametric-study/update/concurrent/delete-endpoint

Removes the end point of the concurrent update of all design points.

parametric-study/update/concurrent/licensing/

Enter the licensing menu for concurrently updating the parametric study.

parametric-study/update/concurrent/licensing/print-to-console/
parametric-study/update/concurrent/licensing/print-to-console/license-type

Prints the current license type.

parametric-study/update/concurrent/licensing/print-to-console/optislang-license-count

Prints the number of optiSLang licenses.

parametric-study/update/concurrent/licensing/print-to-console/license-optislang-license-type

Prints the type optiSLang license.

parametric-study/update/concurrent/licensing/set/

Enter the settings menu for licensing options when updating your concurrent parametric study.

parametric-study/update/concurrent/licensing/set/license-type

Sets the license type for the concurrent parametric study. Choices include "Solver License" or "HPC Parametric".

parametric-study/update/concurrent/licensing/set/optislang-license-count

Sets the number of optiSLang licenses.

parametric-study/update/concurrent/licensing/set/license-optislang-license-type

Sets the type of optiSLang license. Choices include "None", "Premium", or "Enterprise". Using "None" initiates standard HPC parametric licensing.

parametric-study/update/concurrent/print-to-console/

Enter the print-to-console menu for updating parametric studies using concurrent design points.

parametric-study/update/concurrent/print-to-console/number-of-concurrent-dps

Prints the number of concurrent design points to update.

parametric-study/update/concurrent/print-to-console/number-of-cores-per-dp

Prints the number of cores to allocate for each design point run.

parametric-study/update/concurrent/register-new-endpoint

Registers a new end point for parametric studies using concurrent design points.

parametric-study/update/concurrent/set/

Enter the settings menu for parametric studies using concurrent design points.

parametric-study/update/concurrent/set/current-endpoint

Sets the input URL as the current submission endpoint.

parametric-study/update/concurrent/set/current-queue

Sets the queue on which the design points will be updated.

parametric-study/update/concurrent/set/number-of-concurrent-dps

Sets the number of concurrent design points to update.

parametric-study/update/concurrent/set/number-of-cores-per-dp

Sets the number of cores to allocate for each design point run.

parametric-study/update/print-update-method

Prints the method used for updating the study.

parametric-study/update/set-update-method

Sets the method used for updating design points.

parametric-study/update/update-all

Updates all design points in the parametric study.

parametric-study/update/update-current

Updates the design point set as "current" in the parametric study.

parametric-study/update/update-selected-design-points

Updates a selection of design points in the parametric study.