You are on page 1of 40

USER GUIDE

Optimate Version 9.04.007

2014 CD-adapco

Optimate User Guide

ii

Contents

Description. . . . . . . . . . . .
Requirements. . . . . . . . . . .
New In 9.04 . . . . . . . . . . .
Run Modes. . . . . . . . . . . .
Design Sweeps . . . . . . . . .
Optimization using SHERPA . . .
Single-objective . . . . . .
Multi-objective . . . . . .
Design of Experiments Mode. . .
Sensitivity and Screening . .
Response Surface Modeling .
Stochastic Analysis . . . . . . .
Variables. . . . . . . . . . . . .
Design Parameters . . . . . . .
Part Swapping . . . . . . . . .
Motions . . . . . . . . . . . .
Region Physics Values. . . . . .
Boundary Physics Values . . . .
Base Size . . . . . . . . . . .
Field Functions . . . . . . . . .
Interface and Capabilities Description
Run Mode Tab . . . . . . . . .
Variables Tab . . . . . . . . .
Definition Mode . . . . . .
Removal of Variables . . . .
Outputs Tab . . . . . . . . . .
Reports Recording . . . . .
Recording Modes . . . . .
Import from RSM . . . . .
Plots and Scenes Recording .
Requirements . . . . . . .
Assembly Tab . . . . . . . . .
Simultaneous Jobs . . . . .
Cores per STAR-CCM+ Job .

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.1
.2
.2
.3
.4
.4
.4
.4
.5
.5
.6
.6
.7
.7
.7
.8
.8
.8
.9
.9
.9
.9
10
10
12
12
12
12
13
13
13
13
13
14

Version 9.04.007

Optimate User Guide

iii

Macro Insertion Point . . . . . . . . . . . . . . . . . . . 14


Macros To Be Inserted . . . . . . . . . . . . . . . . . . . 14
STAR-CCM+ Run Options . . . . . . . . . . . . . . . . . 15
Optimate Save Option . . . . . . . . . . . . . . . . . . . 16
Number of STAR-CCM+ Runs . . . . . . . . . . . . . . . . 17
Check Frequency . . . . . . . . . . . . . . . . . . . . . 17
Maximum Run Time . . . . . . . . . . . . . . . . . . . . 17
Tokens Required. . . . . . . . . . . . . . . . . . . . . . 17
Licensing Options . . . . . . . . . . . . . . . . . . . . . 18
Study Directory . . . . . . . . . . . . . . . . . . . . . . 18
CAD Directory . . . . . . . . . . . . . . . . . . . . . . 18
Image Directory . . . . . . . . . . . . . . . . . . . . . . 19
Macro Directory . . . . . . . . . . . . . . . . . . . . . . 19
Build Study . . . . . . . . . . . . . . . . . . . . . . . . 19
Run Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Open HEEDS Post . . . . . . . . . . . . . . . . . . . . . 20
HEEDS POST can also be launched outside of Optimate to view the results. . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Run . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Stop . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Pause/Resume . . . . . . . . . . . . . . . . . . . . . . 20
Share Design . . . . . . . . . . . . . . . . . . . . . . . 21
Print Message File . . . . . . . . . . . . . . . . . . . . . 21
File Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Save . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Save As . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Tools Menu . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Set Optimate Solver . . . . . . . . . . . . . . . . . . . . 21
Set HEEDS Post . . . . . . . . . . . . . . . . . . . . . . 22
Configure Microsoft Queue . . . . . . . . . . . . . . . . . 22
Configure Linux Queue. . . . . . . . . . . . . . . . . . . 23
Manage Remote Profiles . . . . . . . . . . . . . . . . . . 24
Options. . . . . . . . . . . . . . . . . . . . . . . . . . 25
Help Menu . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Running Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Running the Baseline Model . . . . . . . . . . . . . . . . . . . 27
Local Jobs from Optimate . . . . . . . . . . . . . . . . . . . . 27
Local Jobs in Batch . . . . . . . . . . . . . . . . . . . . . . . 27
Linux. . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Windows . . . . . . . . . . . . . . . . . . . . . . . . . 27
Remote Execution . . . . . . . . . . . . . . . . . . . . . . . 28
Requirements for running a remote execution study . . . . . . 28
Creating a remote profile . . . . . . . . . . . . . . . . . . 28
Placement of required scripts . . . . . . . . . . . . . . . . 28
Generic Queue Cluster Jobs . . . . . . . . . . . . . . . . . . . 28

Version 9.04.007

Optimate User Guide

Microsoft Queue Cluster Jobs .


Resuming Jobs . . . . . . . .
Extending Jobs . . . . . . . .
Post-Processing . . . . . . . . .
STAR-CCM+ . . . . . . . . .
HEEDS POST . . . . . . . .
File Descriptions . . . . . . . .
Built Projects . . . . . . . . .
Running and Completed Projects
Debugging . . . . . . . . . . .
Message File . . . . . . . . .
STAR-CCM+ Log Files . . . .
HEEDS Post . . . . . . . . .
Known Issues . . . . . . . . .

iv

.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.

30
30
30
31
31
31
32
32
33
34
34
34
35
35

Version 9.04.007

Optimate User Guide

Optimate
Description
Optimate is an add-on for STAR-CCM+ that allows users to setup multiple
STAR-CCM+ runs without scripting. It also provides users the ability to
perform design exploration, optimization, design of experiment and
robustness studies without leaving the STAR-CCM+ environment.
Optimate allows users to do the following:
Select a run mode based on the goals of the analysis
Select variables from an existing simulation file to vary. Variables
can be geometry modifications or boundary conditions.
Define the values for each variable
Select reports, plots, and scenes from the simulation file that will be
recorded for each STAR-CCM+ job
Run the STAR-CCM+ jobs on a local machine or setup the jobs to be
submitted on a cluster
Post-process individual cases using STAR-CCM+ or post-process the
data from the set of analyses using HEEDS POST
Optimate uses technology from Red Cedar Technology to execute, monitor
and post-process the Design Exploration studies. The SHERPA search
algorithm is used for the Optimization and Pareto Optimization modes of
Optimate.
Optimate is designed to be used when STAR-CCM+ is the only analysis tool
in the automation or optimization process. If an additional tool is being
used (e.g., Abaqus, Excel, etc.) an external optimization package will need
to be used. If this is the case, Optimate can help create the necessary batch
scripting to run STAR-CCM+. This script usually includes importing a new
CAD file, remeshing the geometry, running the analysis and exporting
results. A more detailed description of this can be found in the Using
External Optimizer.

Optimate User Guide

Requirements
Typically, a simulation file will be loaded in STAR-CCM+ before Optimate
is launched. Users should verify that the simulation file produces acceptable
results and the required post-processing has already been set up. If a
simulation file is not loaded into STAR-CCM+, Optimate will open but
users will only be able to start a local job.
If Optimate will be modifying geometry, a process must exist in the
simulation to robustly mesh the modified geometry. This process will most
likely include 3D-CAD, mesh operations, or surface wrapping.
When jobs are executed for an Optimate project, each job will be run until
the stopping criteria are met within the simulation file. There is an option to
clear the solution and start from scratch. Users should be mindful of this
and the stopping criteria should be set accordingly. For example, a pipe
flow analysis has been converged and run to 200 iterations. Using Optimate
the radius of the pipe will be changed, the case remeshed and run. The
maximum iterations should be set to a value greater than 200 iterations to
allow STAR-CCM+ enough iterations to converge the solution in a robust
manner.
To build and run Optimate projects, users will need to install the Optimate
Netbeans module (nbm) and the Optimate solver. The Optimate Netbeans
module will need to be installed on the machine that will be used to setup
the cases. The Optimate solver will need to be installed on the machine
where the jobs will be executed.

New In 9.04
There have been several enhancements to Optimate for the current release.
This section will give a brief introduction of features that have been added
or modified in the current version of Optimate, more detail on these features
can be found in this documentation under the affected tabs.
Remote execution of STAR-CCM+ from within the Optimate Interface

Optimate now has the ability to submit STAR-CCM+ jobs on a remote


workstation or cluster. This means Optimate can run and post process in
real time on a local machine, which submitting each individual evaluation
to a remote machine.

Optimate User Guide

Automatic CAD Robustness Studies

Users can now check the robustness of their parametric CAD by running a
CAD robustness study. The CAD robustness study gives failure rates for the
regeneration of CAD and can pinpoint areas of the design space where the
CAD fails to update properly. A CAD Robustness study can only be run on
STAR-CCM+ generated CAD.
Create a response surface from a set of existing designs

A response surface can now be generated from a set of existing designs.


These designs can be exported from a previous study through HEEDS Post,
or can be a set of designs completely defined by the user.
Addition of Kriging and Radial Basis function response surfaces

Optimate now supports the creation of the Kriging and Radial Basis
function response surfaces in addition to the existing linear and quadratic
response surfaces.
Use a response surface model as the source for any study

A response surface from an previously completed design exploration study


can now be used to as the source of any study. This allows the user to save
a significant amount of time since no additional simulations have to be run.
Better control over optimization study from the interface

Optimate now allows the user to pause or stop the study directly from the
interface.
Misc Enhancements

Interface improvements for setting up a Windows HPC environment.


Multi-select and delete all for reports, plots and scenes
Various bug fixes and improvements to the interface

Run Modes
Optimate can be run in multiple ways. The appropriate run mode is selected
based on the goals of the analysis as described below. Choosing the
appropriate mode will determine how many STAR-CCM+ runs are
executed and how the inputs for each run are determined.

Optimate User Guide

Design Sweeps
In Design Sweeps mode the values for the variable are supplied by user
before the job is started. This mode is applicable when replicating test
results, creating aerodynamics loads databases, compressor maps or any
application when the configuration for each job is known a priori. There is
no optimization taking place in Design Sweeps mode. The variables used in
Design Sweeps mode must be defined using the Minimum, Maximum, N
method, the List method, or a CSV file.
Running in Design Exploration mode requires either the
STAR-CCM+/Optimate or STAR-CCM+/Optimate+ products and related
licensing features.

Optimization using SHERPA


Single-objective
When the single-objective run option is selected, the input values are
selected by the optimization algorithm to meet the specific goals of the
analysis. Possible goals include minimizing pressure drop, maximizing
outlet uniformity, minimizing component temperatures, and minimizing
stress. The user is able to define the minimum and maximum value for each
variable and the search algorithm is allowed to choose any value within the
bounds during the analysis. The optimization algorithm being used is the
SHERPA search algorithm by Red Cedar Technology.
The variables used in Optimization mode must be defined using the
Minimum, Maximum, Resolution/Increment method.
When using the single-objective run option, users must define at least one
objective. If multiple objectives are defined, a linear weighting will be used
to combine the objectives. Because the weighting of possibly competing
objectives is defined a priori, running an analysis in Optimization mode
with return one best design.
Running the single-optimization option requires the
STAR-CCM+/Optimate+ product and related licensing features.
Multi-objective
Using the multi-objective run option triggers a Pareto Optimization. Pareto
Optimization is a formulation for investigating multi-objective
optimization problems. It is particularly well suited when the two
objectives are competitive in nature. In such cases there is no single
optimum design. Rather there is a curve along which all designs are

Optimate User Guide

Optimum in one objective for a given value in the other. This is called
non-dominated sorting. The resulting curve is referred to as Pareto Front
and it defines the optimum trade-off relationship between two objectives.
When the multi-objective run option is selected, the weighting for
competing objectives does not need to be defined a priori. The study will
return a set of all optimal designs that lie on the Pareto front. The
optimization algorithm being used is the MO-SHERPA search algorithm by
Red Cedar Technology.
When the multi-objective run option is selected, two additional run options
are exposed:
1. Set Archive Size: This is the desired number of non-dominating
designs in your Pareto front or trade-off curve. A larger archive size
typically produces better resolved trade-off curves, but only if the
number of evaluation is increased as well. As a general rule, the optimal
archive size can be calculated as: Number of evaluations / 100
2. Stop on Pareto Convergence?: Checking this option forces the
optimization run to stop as soon as the Pareto front is converged. If the
Pareto front does not converge, Optimate will carry out the number of
evaluations as specified in the Assembly Tab.
The variables used in the multi-objective run option must be defined using
the Minimum, Maximum, Resolution/Increment method.
Running the multi-objective run option requires the
STAR-CCM+/Optimate+ product and related licensing features.

Design of Experiments Mode


The Design of Experiments mode can be used for local exploration around
a particular design. A user will supply variable values using the Minimum,
Maximum, Resolution/Increment method and Optimate will use Design of
Experiments to create a response surface and study sensitivities of design
factors and factor interaction.
When the Design of Experiments run mode is selected, three Run
Options are exposed:
Sensitivity and Screening
1. 2 Level Full Factorial: A full factorial DoE studies the various factors
and all possible combinations of the factors at a specified number of
levels. From such a study insight can be gained into the sensitivity of
each factor and every combination of factors to the design responses. A
2 level full factorial study examines all the factors at two levels, low

Optimate User Guide

and high. The number of runs required for a 2 level full factorial study
is 2n, where n is the number of DoE factors.
2. 3 Level Full Factorial: A 3 level full factorial DoE is in conceptually
similar to a 2 level full factorial, with the main difference being that all
factors and combinations of factors are evaluated at three levels, low,
mid and high. The number of runs required for a 3 level full factorial
study is 3n, where n is the number of DoE factors.
Response Surface Modeling
1. Latin Hypercube: The Latin Hypercube sampling option is an efficient
method to generate a response surface for the design space. This
generated response surface can be used for higher level DoE study
types like 2 or 3 level full factorial studies since running these studies on
a response surface is computationally inexpensive. The minimum
number of evaluations to fit a quadratic surface is (n+1)(n+2)/2, where
n is the number of DoE factors. It is recommended that the user
evaluates at least 2-4 more evaluations than the minimum, up to a
maximum of two times the minimum.
2. Use Existing Designs: The Use Existing Designs option allows the
user to create a response surface that fits a design set specified by the
user. The designs are to be specified through a .csv file which can be
exported through HEEDS Post. To export a set of designs from HEEDS
Post, open up the design table and select Save Plot Data.
Running in Design of Experiments mode requires either the
STAR-CCM+/enabling Optimate or STAR-CCM+/enabling Optimate+
products and related licensing features.

Stochastic Analysis
A Stochastic Analysis study is used to determine whether a particular
design is affected by minor variations in selected input values due to
installation or manufacturing tolerances. The user specifies a probability
distribution which is applied to the inputs and the distribution of the
outputs can lead to insights about the robustness of the design. The user can
also specify constraints on design responses to obtain a prediction of failure
rate.
The variable values using in Stochastic Analysis mode are defined using the
Value, Distribution mode where the user can specify either a Gaussian or
uniform probability distribution.
Running in Stochastic Analysis mode requires either the
STAR-CCM+/enabling Optimate or STAR-CCM+/enabling Optimate+
products and related licensing features.

Optimate User Guide

Variables
Optimate allows users to identify which variables to create from an existing
simulation file. These variables can be either geometry modifications or
boundary conditions. For this release, the support variables can be found
below.

Design Parameters
CAD models that have been modified and/or created in 3D-CAD and have
design parameters defined can be modified using Optimate. Changing
design parameters and pushing the modified geometry through the
meshing pipeline will require Optimate to remesh the geometry. Users
should be aware of this for memory considerations. Changing a design
parameter such that the geometry becomes invalid will result in a failure for
the analysis. Variables can be created from the following design parameters:
Scalar quantities
Translation components
Scalar quantities include distances, radii, extrusion lengths, and taper
angles.
For translation variables, Optimate will attempt to also translate a
coordinate system with the same name as the current design parameter.
This feature is useful if a rotation needs to be performed after the translation
is done. It is important to create the translate variable(s) first before any
rotation variables.
Design Parameters that result from CAD-Client geometry import are also
listed here. Supported CAD-Clients are STAR-NX, STAR-Works,
STAR-Creo, STAR-ProE, STAR-Inventor and STAR-CAT.

Part Swapping
Parts can be variables if they have been created from an imported CAD
model. Only parts that have been imported directly into the parts tree will
populate the parts for swapping drop down menu. Users will be able to
identify a list of CAD files to be used to replace the current part. User must
supply at least two CAD files. Swapping a part that causes a mesh operation
to return an invalid result will cause that specific analysis to fail.
With a part swapping variable, it is necessary to provide the execution CAD
directory.

Optimate User Guide

If a NASTRAN file (*.nas) is selected, the simulation preferred length unit is


selected as the import unit.

Motions
Motion variables are created from defined motions in the simulation file. If
a user is using reference frames for boundary conditions the variables will
not be created. Users must create a motion and use the automatically
created reference frame as the boundary condition for the region. Variables
can be created from the following motion types:
Rotation rate
Translational velocity

Region Physics Values


The following region physics values that have their method set to
Constant will have variables available:
Volumetric heat source

Boundary Physics Values


The following boundary physics values that have their method set to
Constant will have variables available:
Velocity magnitude
Mass flow rate
Static and total temperature
Static and total pressure
Mach number
Flow angles
Mass fractions
Wall roughness
Turbulence scalars
Thermal scalars
Flow Angles

Variations of inlet flow angles will attempt to modify a local Cartesian


coordinate system named wind. Users must create this coordinate system

Optimate User Guide

in the original simulation file and align it so that flow with zero pitch angle,
zero roll angle and zero yaw angle is aligned along the positive X axis.
Pitch, yaw and roll are defined as rotations about the Y,Z and X axis
respectively. All reports that should remain relative to the wind coordinate
system should reference the wind coordinate system.

Base Size
Mesh dependency studies can be performed by creating variables from the
base size in a mesh continua or automated mesh operation.

Field Functions
Variables can be created from user field functions in a simulation file. The
field function must be a scalar field function and its definition must be only
numeric.
Examples of allowable definitions:
10
-1.312
Field functions with invalid definitions will not appear in the field function
variable drop down menu.
For use in Optimate, please ensure that the presentation name and the
function name for the field function are the same.

Interface and Capabilities Description


Optimate is split into five tabs: run mode, variables, outputs, assembly and
run. The tabs are arranged in order of how users should setup cases, starting
with the variables tab and ending with the run tab.

Run Mode Tab


This is where a user picks the run mode for the analysis. Users can select
from the following modes:
Design Sweeps
Optimization Using SHERPA

Optimate User Guide

10

Design of Experiments
Stochastic Analysis
Depending on the Run Mode selected, additional Run Options are
exposed to the user. A description of each Run Option is given under each
Run Modes section.
In order to change the run mode after variables or outputs have been
created, the variables and outputs will be cleared. The user will prompted
before this action is completed.

Variables Tab
This is where a user identifies what variables in the simulation file should
be varied during the analyses. By choosing the applicable variable from a
drop-down menu and pressing the Add button, it will be added to the list
of variables to be modified. Once a variable is already added into the study,
it will appear grayed out within the drop-down list.
Definition Mode
The next step is to define the values that will be used for that variable. Users
can select from the following modes:
Minimum, Maximum, N
Minimum, Maximum, Resolution/Increment
List
CSV File Column
Value, Distribution
Geometry Files
The exact modes that are visible will depend on the selected run mode and
selected variable type.
Minimum, Maximum, N

Users will specify a minimum value, maximum value, and number of


increments. For example, if a user specifies a minimum of two, a maximum
of ten and five increments, a run will be completed for the values of two,
four, six, eight, and ten.
When running in Optimization mode, this definition method must be used.
The optimization algorithm will use the minimum and maximum value as
bounds for the variable and select values between the two values.

Optimate User Guide

11

Minimum, Maximum, Resolution/Increment

Users will specify a minimum value and maximum value. This mode is
used for optimization and Design of Experiment modes where the search
algorithms will be selecting the exact values to use between the provided
bounds. Users can also control discretization of the variable by specifying
the resolution or increment value of the variable.
List

Users will supply a comma separated list of values to use. Optimate will run
a case for each value in the list. This is useful if the values are not evenly
spaced.
CSV File Column

Users will choose a column from an imported CSV file. This file was
imported in the run mode tab. Once imported a user can choose a column
to supply values for a given variable.
This option is only available in Design Sweeps mode and cannot be used for
part swapping variables.
Value, Distribution

Users will define a distribution type and values for each variable. During
run time, input values will be chosen to fit the specified probably
distribution.
There are two distribution types available:
Uniform distribution: The Value field for the uniform distribution is
the mean value for the variable. The Maximum Variation field is the
maximum variable of the variable from the mean in either direction. For
example, a Value of 10 and a Maximum Variation of 5 gives us a
variable that is uniformly distributed for 5 to 15.
Gaussian distribution: The Value field for Gaussian distribution is the
mean value for the variable. The Standard Deviation field is normal
standard deviation of the variable from the mean value.
This option is only available in Stochastic Analysis mode.
Geometry Files

For variables created for part swapping users can specify geometry files to
swap with the current part.

Optimate User Guide

12

Removal of Variables
Variables can be removed by selecting it and right-clicking and selecting
Delete or selecting the Delete button.

Outputs Tab
This is where a user defines what outputs should be recorded during the
analysis.
Reports Recording
Reports from the simulation file can be recorded at the end of each analysis
by Optimate. Reports can be added individually using the Add button or
all at once using the Add All button.
The values used for the reports will always be in the units specified in the
report properties in the simulation file.
Recording Modes
Once a report has been added to the list of recorded reports, changing its
run mode will change how the Optimate solver treats the value exported
from STAR-CCM+. The recording mode for each recorded report can be set
to the following:
Output
Objective
Constraint
Output

For this recording mode, the Optimate solver will only record the value of
the report.
Objective

For this recording mode, the Optimate solver will use this report value to
judge how this design is performing relative to previous designs. For each
objective the user sets a goal, normalization and linear weight value. The
goal can be set to Minimize or Maximize. The normalization is important
if there are multiple objectives and it should be set such that all objectives
are the same order of magnitude. The Use Baseline check-box can be used
to automatically set the normalization values for each variable by using the
baseline run. The linear weight is important if there are multiple objective

Optimate User Guide

13

and determines how the objectives will be combined to determine the


performance of each design.
Constraint

For this recording mode, the Optimate solver will use this report value to
determine if this design is feasible or infeasible. If a particular set of inputs
creates an infeasible design, the Optimate solver will avoid this part of the
design space in subsequent analysis. For each constraint the user sets the
type and limit. The type can be set to Less Than or Greater Than and the
limit is set to the value which cannot be exceeded or below. For example, if
a user created a constraint based on a drag report, set the type to Less Than
and the limit to 300, any analysis with a converged value higher than 300
would be considered infeasible.
Import from RSM
If a response surface is being used as the source of the study, the check-box
for Import from RSM should be selected. This will open up a dialog to
allow the user to select the response surface associated with that output.
Plots and Scenes Recording
Users can also define which plots and scenes should be saved at the end of
each STAR-CCM+ run. Plots and scenes can be added individually using
the Add button or all at once using the Add All button. The directory to
which the images are placed will be defined in the assembly tab.
Requirements
For all analysis at least one report must be recorded as either an output,
objective or constraint. For cases run in Optimization mode, there must be
at least one objective and for cases run in Pareto Optimization mode there
must be at least two objectives. It is recommended that objectives be defined
for Design Sweeps mode as the Optimate solver can sort the results
according to the performance of the analyses.

Assembly Tab
This tab is used to define how the STAR-CCM+ jobs will be run.
Simultaneous Jobs
This number defines how many jobs will be executed at once. This number
should be as small as practical when running in Optimization mode. The

Optimate User Guide

14

Optimate optimization algorithm (SHERPA) works best when it can learn


as many times as possible. If you are running 100 cases in total in blocks of
twenty-five at a time, SHERPA can only learn three times. If you are
running those same 100 cases in blocks of two, SHERPA can learn forty-nine
times and can perform much better.
When a response surface is the source for a 2 level or 3 level full factorial
DoE study, the number of simultaneous jobs is fixed to 1.
Cores per STAR-CCM+ Job
This defines how many cores each STAR-CCM+ job will be run on.
Macro Insertion Point
Allows the user to identify the desired insertion point for custom macros
into the StarDriver.java macro. The Insert Macro STAR-CCM+ Run Option
must be selected to enable this portion of the Assembly Tab.
Before Meshing

Updates the Macros To Be Inserted list to display macros selected to be


inserted immediately before the execute meshing pipeline command is
executed in StarDriver.java.
After Meshing

Updates the Macros To Be Inserted list to display macros selected to be


inserted after the simulation mesh has been generated but prior to running
the solver.
After Running

Updates the Macros To Be Inserted list to display macros selected to be


inserted immediately after the solver has been completed and before any
results (reports, scenes, and plots) are returned to the Optimate solver.
Macros To Be Inserted
This list displays user selected macros to insert into the StarDriver.java file
at the location specified by the Macro Insertion Point selection. Users are to
browse to the location of the desired macros and insert them into the desired
list. The order that they are displayed in the list represents the order that
they will be played in the specified insertion point. The same macro cannot
be played more than once at a given insertion point, but may be played
again at a different insertion point. It is a requirement that any macro to be
inserted meet all the requirements necessary to play a macro directly in

Optimate User Guide

15

STAR-CCM+. For this reason it is recommended that even if the user is


writing their own macro they record a shell of it in STAR-CCM+ and modify
this file to reflect the full set of instructions. It is also recommended that the
user ensure their macro will execute manually in STAR-CCM+.
Remove Macro

This button removes the selected macro in the currently displayed Macros
To Be Inserted list.
STAR-CCM+ Run Options
The following options will determine how STAR-CCM+ jobs are submitted,
executed and saved.
Re-mesh Required

This will be checked if any variables were created from a design parameter
or for part swapping.
Remove Invalid Cells

When selected STAR-CCM+ will execute the remove invalid cells command
on each individual job submitted. This is advisable if it is determined that
the mesh settings in the base sim file might occasionally generate invalid
meshes. This is more likely for projects where widely varying geometries
are being generated and when the surface wrapping is being used on
complex geometry.
Convert to 2D

When selected the project will convert each submitted job into a 2D
problem. All of the same restrictions for running 2D cases in STAR-CCM+
apply when running Optimate analyses in 2D. The mesh must have a face
aligned with the X-Y plane. The physics continua, interfaces, and reports
will automatically be updated to the appropriate forms for 2D simulations.
Any scene selected in the output tab will automatically be updated such that
the displayer parts are the newly created 2D regions.
Save all Simulation Files

When this option is activated the save command will be added to


StarDriver.java macro which is executed for each simulation in the analysis.
The result is that any star_0/Design<N>/star/ (where N is the design
number) directories retained by Optimate will contain the completed sim
file and any other simulations file (e.g. *.trk) for that particular simulation.
Note that if the simulation has the auto save batch runs activated in the

Optimate User Guide

16

File>Auto Save menu then a sim file will be retained even if this option is
deactivated. It is advisable to check this setting (activated as default in
STAR-CCM+) before starting the project.
Clear Solution

Checking this box will clear the current solution in STAR-CCM+ before
running each case. By leaving this box unchecked STAR-CCM+ will use the
existing solution as a starting point which can significantly reduce the
iterations required to reach a converged solution.
Insert Macro

Checking this box will activate the macro insertion portion of the Assembly
Tab allowing the user to insert custom recorded or written macros into the
StarDriver.java macro used to execute each STAR-CCM+ simulation.
Use Windows Queue

This allows Optimate to submit the jobs using a Windows Scheduler that
can be configured in Tools > Configure Microsoft Cluster.
Use Linux Queue

This allows Optimate to submit the jobs using a generic queuing system that
can be configured in Tools > Configure Linux Queue.
Optimate Save Option
Last Best Design

This option is only available when the Run Mode is set to either
Optimization using Sherpa or Pareto Optimization using MO-SHERPA.
When selected this option instructs the Optimate solver to remove all
design directories with the exception of that identified as the best design
based on the specified objectives.
Save All Best

This option is only available when the Run Mode is set to either
Optimization using Sherpa or Pareto Optimization using MO-SHERPA.
When selected this option instructs the Optimate solver to remove all
design directories with the exception of those that were identified as the
best design during the history of the project run. As an example the first run
of an Optimization project will always be the first best design identified,
subsequently as the Optimate solver identifies improved designs it will no

Optimate User Guide

17

longer be the best design. With this option turned on however the directory
for the first design will be retained because it was identified at one point as
the best design.
All Designs

When selected this option instructs Optimate to retain all design directories.
None

When selected this option instructs Optimate to remove all design


directories after the outputs of a completed simulation (report values, plots,
scenes) has been extracted.
Number of STAR-CCM+ Runs
The number of runs is determined by the number of variables and how
many values will be used for each variable in Design Sweeps mode. In
Optimization mode, the value is set by the user based on how many cases
there is time to run. For a Pareto optimization problem at least forty cases
must be run. For 2 Level Full Factorial or 3 Level Full Factorial runs, the
number of runs is determined by the algorithm and automatically
populated.
Check Frequency
This number determines how often Optimate checks each STAR-CCM+ job
to see if it has finished. By default it will check every 360 seconds but this
should be modified according to the expected run times.
Maximum Run Time
This number determines how long Optimate will wait for one job to be
completed before submitting the next one. By default it will wait 360,000
seconds before submitting the next job. This should be modified to be only
slightly longer than the job should take to run, but it is important to keep
queue times and possible solver slowdowns in mind.
Tokens Required
Multiplying the number of simultaneous jobs by the number of cores per job
will determine how many Power Tokens will be required to run. Please be
aware that if using a cluster, this number will not reflect the correct amount
of tokens unless you change the cores per STAR-CCM+ job to reflect the
command provided in the queue configuration window.

Optimate User Guide

18

Licensing Options
During run time, Optimate jobs will use with an Optimate or Optimate+
license as well as the necessary licenses for starting STAR-CCM+ jobs. In
this release, existing STAR-CCM+ license features can be used in addition
to Power Tokens and the options below allow users to control how licenses
will be checked out.
Use Power Tokens

This is the default licensing scheme for Optimate. Optimate will check out
Power Tokens for each STAR-CCM+ job based on the number of cores each
job will be run on.
Use Serial and HPCs

This will allow Optimate to check out STAR-CCM+ session licenses and
HPC licenses for each STAR-CCM+ run.
Use Power Sessions

This will allow Optimate to check out a Power Session for each
STAR-CCM+ run.
Use Power on Demand

This will allow Optimate to check out a Power Session from the CD-adapco
FlexLM server. Users will be prompted for a Power-on-Demand key. The
license server is set to 1999@flex-cd-adapco.com. However, this can be
changed manually by modifying the Process1.in file after building the
project.
Study Directory
This should be set to the directory where the project files are to be written.
The project will run in this directory as well. If the case is to be run on a
remote cluster, just this directory needs to be copied over.
The directory can be set by browsing the local file system or manually if the
run directory is not currently mounted. Relative paths are acceptable when
manually setting this directory.
CAD Directory
This only needs to be modified if a variable is created for a part swap. By
default, the directory is set assuming that the CAD files exist in the same

Optimate User Guide

19

directory as the original simulation file. If this is not the case, the directory
needs to be changed.
The directory can be set by browsing the local file system or manually if the
run directory is not currently mounted. Relative paths are acceptable when
manually setting this directory.
Image Directory
This should be set to the directory where the plot and scene images should
be saved. By default it will place all of the images in the same directory as
the original simulation file. It is recommended that a new directory is
created for all of the images.
The directory can be set by browsing the local file system or manually if the
run directory is not currently mounted. Relative paths are acceptable when
manually setting this directory.
Macro Directory
This only needs to be modified if a macro has been selected for insertion into
StarDriver.java. And represents the location where STAR-CCM+ will go to
find all macros.
The directory can be set by browsing the local file system or manually if the
run directory is not currently mounted. Relative paths are acceptable when
manually setting this directory.
Build Study
Pressing the Build Study button will write all the files necessary to execute
the Optimate solver for the job defined in the previous three tabs. It will also
modify and save the simulation file to allow the use of the Power Token
licensing scheme.
All of the files will be written to the same directory as the original
simulation file. If running the job on a cluster, all of the written files must be
copied to the cluster file system.

Run Tab
The run tab is used once the project has been built to start local jobs, kill local
jobs, post-process, view the message file and run the baseline analysis.

Optimate User Guide

20

Open HEEDS Post


Once a local job has completed, pressing the Post Process button will
launch HEEDS POST to post-process the results.
HEEDS POST can also be launched outside of Optimate to view the results.
Run
The run button gets activated once the study has been built. The run button
itself has three options.
Run

The Run will being the design exploration study by starting the Optimate
solver on the local machine.
Run Baseline

The Run Baseline option runs the baseline design by itself. This can be
used to ensure the robustness of the starting simulation.
CAD Robustness

This feature can be used to check the robustness of the CAD regeneration.
Optimate will sample the design space using a Latin Hypercube sampling
technique. Once a CAD Robustness is run/running, it can be post processed
by clicking on the Open HEEDS Post button. In HEEDS Post, an objective
called CAD Robustness Report is found. Any design with a value of 0 for
this report means that the design was unable to regenerate the CAD
correctly.
Stop
The stop button can be used to stop the Optimate study. It is important to
note that this does not kill the actual STAR-CCM+ jobs that have already
been launched.
Pause/Resume
The pause button can be used to pause the Optimate study. The resume
button continues the job from the paused state.

Optimate User Guide

21

Share Design
This option allows the user to insert their own design to the study. A
design can be inserted into the study at any time during the run. This allows
the user to study the current set of results and make a best guess at a good
design. Optimate will then evaluate this design and use the results for the
rest of the run. The Share Designs button opens up a panel that allows the
user to set values for each of the design parameters. This design will be run
after the set of current evaluations is complete.
Print Message File
Pressing the Print Message File button will print the contents of the
Optimate solver message file (Agent_Group_1.mes) to the output window.
This file contains information about the Optimate job and can be useful for
debugging jobs that fail to start.

File Menu
The file menu includes the following options:
Save
This will overwrite the open .optm project file with the current project.
Save As
This option saves the Optimate project in a .optm file with a specified name
and location.
Exit
This will close down the Optimate interface, however the license that was
used to start Optimate will not be released until the server is shutdown.

Tools Menu
The tools menu can be used to control the external programs that Optimate
is calling and to configure cluster setups.
Set Optimate Solver
This is used to set the Optimate solver executable for local jobs. Users will
be prompted to set this the first time Optimate is started and it can be
modified if needed.

Optimate User Guide

22

Set HEEDS Post


This is used to set the HEEDS POST executable for launching HEEDS POST
from Optimate. Users will be prompted to set this the first time Optimate is
started and it can be modified if needed.
Configure Microsoft Queue
This will bring up a window to setup the commands to run on a Microsoft
cluster. The values should be modified to reflect the configuration that users
plan on running on.
Queue Submission Command

This is the system command to put a job in the queue. In almost all cases,
this is going the be the default value of job submit
Job Name Specifier

This is the command that is used to identify the name for each submitted
job. This is the command line argument that allows the users to identify the
name for each submitted job. In almost all cases, this is going the be the
default value of /jobname:.
Job Name Prefix

This is the prefix of each STAR-CCM+ job that is launched. The full name of
the job will be this prefix, appended by the evaluation number
corresponding to that job.
STAR-CCM+ Execution Command

This is either the STAR-CCM+ command or the batch script used to launch
STAR-CCM+ on the cluster. It is important to provide the shared path of the
executable for the full installation of STAR-CCM+.
Full Command

Shows the user a preview of the submission command that gets run.
Remote Execution

This check box toggles the remote execution run option. If remote execution
is selected, a drop down box with the available remote profiles is available.
More details on the remote execution option can be found under the
Remote Execution section.

Optimate User Guide

23

Configure Linux Queue


This will bring up a window to setup the commands to run on a generic
queueing system. The defaults reflect the commands to run on a Linux
cluster running OpenPBS. The values should be modified to reflect the
configuration that users plan on running on. Two methods are now
available
Use Generic Scheduler

This method requires the following information


Job Submit
This is the command that is used to submit each job on the cluster. The
default value is setup for a cluster running OpenPBS where each job is
submitted on one node running four cores per node.
Please note that modifying the number of nodes per job and cores per node
will not affect the number of Power Tokens displayed in the assembly tab.
However, it will affect the number of Power Tokens required to run.
Job Name Specifier
This is the command that is used to identify the name for each submitted
job. The default value is setup for a cluster running OpenPBS.
Command to Execute STAR-CCM+
This is the command that is given for each submitted job. By default each
job will be started by executing the contents of the shell script
./ccmprun.csh. This shell script needs to be created by the user for a
specific machine. Requirements for the contents of the shell script can be
found here.
Direct Parallel Execution

This method requires the following information:


Command to submit job to cluster
This is the exact command that a user would enter into the command line to
start a STAR-CCM+ simulation minus any files associated with the
submission. Typically this will be the command to submit to a job scheduler.
As an example a user might directly launch STAR-CCM+ via the command
line which could include
starccm+ -np 3 -batch StarDriver.java

Optimate User Guide

24

followed by the simulation file. The above command would be entered into
the Command to submit job to cluster text box. Alternatively a user might
use a scheduling tool and a script to submit a job. In this case everything but
the script file itself is included in the Command to submit job to cluster text
box. As an example using OpenPBS the user would include
qsub -l nodes=1:ppn=8

in the Command to submit job to cluster text box.


Run Script
This is the name of any file needed in addition to the command given the
Command to submit job to cluster text box. For the first example above this
box would contain
<simulation file name>.sim

with the appropriate simulation file name. For the second example it would
contain the run script name. The file specified here is copied from the project
directory to the directory created by Optimate to launch the individual
design variant. The complete command executed by Optimate from this
directory is the combined command from both this box and the Command
to submit job to cluster text box.
Remote Execution

This check box toggles the remote execution run option. If remote execution
is selected, a drop down box with the available remote profiles is available.
More details on the remote execution option can be found under the
Remote Execution section.
Manage Remote Profiles
This panel allows the user to manage remote profiles that can be used in the
remote execution run mode. For more details on how remote execution
works, please refer to the Remote Profiles section of the documentation. A
remote profile contains information about the remote machine on which
evaluations can be run on. The list on the left side of the panel allows the
user to add or remove distinct remote profiles, so that different remote
machines can be used easily. The following data is needed to create a remote
profile:
Remote Host Type: Select the operating system environment for the
remote machine
Profile Name: The name to store the remote profile as in Optimate
Remote Host Name: The name of the remote host. Include the domain
if it is needed to connect from your local machine

Optimate User Guide

25

Remote User Name: The user name needed to log in to the remote
machine. A password free ssh must also be set up to this user account
on the remote machine
Shared Drive: Tick this option if your local workstation shares the same
drive with your remote machine. i.e., both local and remote machines
can access the same files.
SSH Command: The command used to ssh from the local machine to
the remote machine
SCP Command: The command used to scp (copy files) from the local
machine to the remote machine
Options
The Options option opens up the Options pane where the following
settings can be specified:
Optimate Options

Always On Top: Checking this option will tell the Optimate frame to
site in front of all other windows. This can be useful because Optimate
will fall to the back if the mouse is moved over a plot or scene in
STAR-CCM+ and when a local job is started. Note, that this option
should not be selected when browsing to files and directories as the
Optimate frame will remain on top of the File chooser window. This
option will be remembered when Optimate is started in the future.
Use External Optimizer: Checking this option will choose the Use
External Optimizer run mode. All current variables will be cleared and
the user can pick the new variables and outputs for the study. The run
mode tab is grayed out since that is selected on the external optimizer
side.
Hide Messages: By default, messages related to incorrect inputs and
execution errors will create pop-up menus that the user must close. If
this box is checked, the messages will instead be printed to the
STAR-CCM+ output window. This option will be remembered when
Optimate is started in the future.
Power Session Core: By default, the core STAR-CCM+ license for the
design exploration study is a serial license (ccmpsuite). This option
gives Optimate permission to use a power session in the event that a
serial license cannot be found.
CAD Robustness Study Options

Sampling Intensity: This slider controls the number of samples that are
run for a CAD Robustness study. The higher the sampling intensity, the
greater the number of samples picked throughout the design space.

Optimate User Guide

26

Concurrent Runs: Controls the number of CAD Robustness evaluations


run in parallel.
STAR-CCM+ Command Line Options

The user can specify any additional command line arguments for launching
each STAR-CCM+ evaluation (eg. -dp for double precision). By default,
Optimate picks power tokens before selecting HPCs for each additional
CPU within an evaluation. To modify licensing behavior to prefer HPCs
over power tokens, the -doe-prefer-hpcdomains flag should be used.

Help Menu
Optimate User Guide

This user guide is opened up through this menu item.


Tutorials

The documentation for all the Optimate tutorials is found under this
sub-menu.

Running Jobs
Optimate can setup cases to run locally on the same machine that is setting
up the job or on a cluster.
STAR-CCM+ is called with the following command on Windows:
starccm+.exe

or on Linux:
starccm+

In order for the above commands to work, the path environment variable
must be set to launch the correct version of STAR-CCM+. The full path can
be inserted into the Process1.in file if it is not possible to change the path.

Running the Baseline Model


The baseline model can be run either directly from the run tab using the
Run Baseline Model button or the command can be copied and pasted to
a command prompt. This is useful if the model needs to be run using Power
Tokens as the necessary command line flags are shown.

Optimate User Guide

27

Local Jobs from Optimate


Local jobs can be start through Optimate using the Start Local Job button
in the run tab.
Optimate must be open to start a local job. If the project is being built in the
same session, this is straightforward. If the project has already been built in
another session, users will need to load the original simulation file again,
start Optimate, navigate to the run tab, and press the Start Local Job
button. The project will not need to be built again.
If the previous Optimate job did not exit correctly, users will be prompted
to delete the lock file. The extension of the UserDesigns0_Initialize will be
changed from .in_backup_at_0_evals to .in.

Local Jobs in Batch


Jobs can also be submitted in batch by executing the Optimate solver from
the command line. Users will need to navigate to the directory that contains
the original simulation file and the project files.
If the previous Optimate job did not exit correctly, users will need to delete
the lock file named star0.lock and also change the extension of the
UserDesigns0_Initialize file back to .in.
Linux
On Linux machines, execute the following command:
PATH_TO_OPTIMATE/optimate/Ver2014.06/LX64/solver/Optimate
i=Agent_Group_1.in overwrite skipEvalCheck

Substitute the path to reflect the local installation.


Windows
On Windows machines, execute the following command:
PATH_TO_Optimate/optimate\Ver2014.06\Win64\solver\Optimat
e.exe i=Agent_Group_1.in overwrite skipEvalCheck

Substitute the path to reflect the local installation.

Remote Execution
For large cases where the STAR-CCM+ evaluations need to be run on a
remote workstation or cluster, the remote execution option is the preferred

Optimate User Guide

28

method. The remote execution option runs Optimate on the local


workstation, and sends STAR-CCM+ data to and from the remote
environment. Functionally, this means that the user can set up and
effectively run Optimate locally, while the STAR-CCM+ jobs are
automatically run on a separate workstation or cluster.
Requirements for running a remote execution study
The user needs to have password free SSH set up between the local and
remote machines. For detailed instructions on how to set this up, please
contact your dedicated support engineer.
For the duration of the study, the local machine cannot be restarted or
shut down.
Creating a remote profile
The user first needs to create a remote profile, which stores all the
information about the remote machine. Remote profiles can be managed by
clicking on Tools -> Manage Remote Profiles. Details about managing
remote profiles can be found in the Manage Remote Profiles section. Once
a remote profile is created, it is stored so that it can be used for future
studies.
Placement of required scripts
When running in remote execution mode, all files need to exist on the local
machine first, so they can be transferred over to the remote machine as
necessary. Therefore, the script used to launch Optimate on the remote
workstation also needs to be placed in local directory where the project is
built.

Generic Queue Cluster Jobs


To submit jobs on a cluster with a generic queuing system, all of the project
files must be copied to the users run directory on the cluster file system. The
Optimate solver must be installed on the cluster as well as the correct
version of STAR-CCM+.
When setting up a generic queue case, Optimate will create an additional
file named optimate.txt. The file contains an ID flag that must be passed to
STAR-CCM+ to access the Power Token licensing scheme. This ID must be
incorporated into the c-shell script that is used to call STAR-CCM+ that is
identified in the setup. For example, a variable is created as follows:
set UUID=cat optimate.txt

Optimate User Guide

29

This variable is passed to STAR-CCM+ via the command line option:


-doeuuid $UUID

Optimate is also creating the batch script to run STAR-CCM+. The name of
this file is StarDriver.java and this also needs to be passed to STAR-CCM+
via the command line option:
-batch StarDriver.java

By default, Optimate will submit a job that executes the following


command:
./ccmprun.csh

At a minimum, the called cshell script should contain:


#!/bin/tcsh
set UUID=cat optimate.txt
starccm+ -doeuuid $UUID -batch StarDriver.java -np 2
test.sim >>& test.log

It is likely that this will need to be appended to include machine information


related to the specific cluster being used. It should also be noted that the
command that executes STAR-CCM+ is back-grounded. This is necessary
for the Optimate solver to function correctly.
Optimate requires the following environment variables need to be set:
PYTHONHOME=PATH_TO_Optimate/optimate/Ver2014.06/Python27
HEEDS_ROOT=PATH_TO_Optimate/optimate/Ver2014.06/LX64/solv
er
LD_LIBRARY_PATH=PATH_TO_Optimate/optimate/Ver2014.06/LX64
;PATH_TO_Optimate/optimate/Ver2014.06/LX64/solver
PATH=PATH:PATH_TO_Optimate/optimate/Ver2014.06/LX64

When submitting the job on the cluster directly (without remote execution),
use the following command on the head node of the cluster:
PATH_TO_OPTIMATE/optimate/Ver2014.06/LX64/solver/Optimate
i=Agent_Group_1.in overwrite skipEvalCheck

Substitute the path to reflect the local installation.

Microsoft Queue Cluster Jobs


To submit jobs on a cluster with a Microsoft queuing system, all of the
project files must be copied to the users run directory on the cluster file
system.

Optimate User Guide

30

Optimate requires the following environment variables to be set:


PYTHONHOME=PATH_TO_Optimate\optimate\Ver2014.06\Python27
HEEDS_ROOT=PATH_TO_Optimate\optimate\Ver2014.06\Win64\sol
ver
LD_LIBRARY_PATH=PATH_TO_Optimate\optimate\Ver2014.06\Win6
4;PATH_TO_Optimate\optimate\Ver2014.06\Win64\solver
PATH=PATH:PATH_TO_Optimate\optimate\Ver2014.06\LX64

When submitting the job on the cluster directly (without remote execution),
use the following command on the head node of the cluster:
PATH_TO_OPTIMATE\optimate\Ver2014.06\Win64\solver\Optimat
e.exe i=Agent_Group_1.in overwrite skipEvalCheck

Substitute the path to reflect the local installation.

Resuming Jobs
If a job aborts for any reason and needs to be resumed, the job can be started
and will pick up from the last completed design using the following
command line:
PATH_TO_OPTIMATE/optimate/Ver2014.06/LX64/solver/Optimate
i=Agent_Group_1.in useHistory skipEvalCheck

Note: this can only be done from the command prompt and not via the
Optimate interface.

Extending Jobs
If a job completes but further designs are needed to achieve the desired
results, the job can be continued. First, the number of jobs must be increased
in the Agent_Group_1.in file. An example of the lines to be modified is
shown below:
$Start Agent ID, End Agent ID, Number of Designs Evaluated
0, 0, 20

The number is set to the Number of Designs Evaluated should be modified


to the number of additional runs that are needed. In the following
modification, 10 additional designs are requested.
0,0,10

Modify the end of the file to include an *EXTENDING command right


before the *END command as follows:
*EXTENDING

Optimate User Guide

31

*END

The file is then saved and the following command is given to extend the job:
PATH_TO_OPTIMATE/optimate\Ver2014.06\Win64\solver\Optimate.e
xe i=Agent_Group_1.in

Note: this can only be done from the command prompt and not via the
Optimate interface.

Post-Processing
Once a series of jobs have completed the results can be post-processing
either further in STAR-CCM+ or using HEEDS POST.

STAR-CCM+
If a user selected to save all simulation files, individual simulation files can
be found in the following directories:
star_0/DesignN/star/

Where N is the design ID for each job. Each simulation file will be appended
with a three digit design ID so that they can all be copied into the same
directory for archiving but still reference the ID for post-processing in
HEEDS POST.

HEEDS POST
HEEDS POST can be started from Optimate or outside of Optimate.
HEEDS POST can be accessed from within Optimate by clicking on the
Post-Process button in the Run tab. This will automatically load the
study that is running, or just finished running within Optimate.
To import an existing study in HEEDS POST, select File -> Open and
then select the *.optm file. If your study results do not get imported
automatically, click on the Refresh Study Data button in the top
ribbon.
If the study is moved to a new folder, the association needs to be reset in
HEEDS Post. To re-associate the study folder, right click on the study
name in the tree and select the Find Study Folder option. Then
navigate to the study folder and accept.

Optimate User Guide

32

Please refer to the HEEDS POST documentation for more information. This
can be found in the installation directory of HEEDS POST.

File Descriptions
The file descriptions are given below to aid in debugging cases that are not
executing as expected.

Built Projects
When an Optimate project is built, the following files can be found in the
same directory as the simulation file.
Agent_Group_1.in

This file contains information about the run mode and the number of runs
to be completed.
Assembly.in

This file contains information about the run mode.


Definitions.in

This file contains information variables that will be changed at run time. The
name of the variable, the minimum value, the maximum value and the
baseline value can be found here.
M_{SIM FILE NAME}.in

The file tells Optimate how to modify the input file for each run such that
STAR-CCM+ runs using the updated variable values.
Performance0.in

This file contains information about the outputs, objectives and constraints
for each project and tells Optimate where it can find these values after each
STAR-CCM+ job has completed.
{SIM FILE NAME}.in

This file contains the variable names and values that will be read by
STAR-CCM+ at run time. This file is copied to the design directory at run,
modified with the new values by Optimate and the STAR-CCM+ batch

Optimate User Guide

33

script will read this file and update the fields in STAR-CCM+ before
running the analysis.
{SIM FILE NAME}.out

This file is written by each STAR-CCM+ job at completion and contains the
values of the outputs that will be read by Optimate. If the STAR-CCM+
analysis does not complete successfully, this file will not be written and
Optimate will mark the analysis as a failure.
Process1.in

This file contains the command to start each STAR-CCM+ analysis (either
via a queuing system or directly), information about how often to check for
completion and the named files to by copied into each design directory.
Representation0.in

This file contains information about the resolution of each variable.


StarDriver.java

This is the batch script that each STAR-CCM+ job will execute. It is
responsible to reading the input file, adjusting parameters in STAR-CCM+,
remeshing if necessary, running the analysis and exporting the results.
UserDesigns0_Initialize.in

This file is only written for analysis run using Design Exploration mode. It
contains the value of each variable to be used for each STAR-CCM+ job.

Running and Completed Projects


The following additional files can be found in the directory where are
project is running or has completed.
Agent_Group_1.mes

The file is the output from the Optimate process and contains information
about when each STAR-CCM+ job is started and completed. If there are any
errors parsing the other input files, a detailed message can be found here.
star0.gph star0.hst star0.res star0.rpt

These are the post-processing files that are loaded into HEEDS POST. If a
project is run on a computer that does not have HEEDS POST, these four

Optimate User Guide

34

files and the star0.hds file must be copied to the machine with HEEDS
POST.
star_0/

This directory is created at run time and contains all the design directories.

Debugging
Information regarding failed jobs can be found in the files written by
Optimate and STAR-CCM+.

Message File
During an Optimate run, Optimate is always writing to the
Agent_Group_1.mes file. This file is in the directory with the original
simulation file. If there are any errors parsing the project files written by
Optimate it will be documented here. These errors can include:
Licensing error
Check CDLMD_LICENSE_FILE variable
Ensure license server is running
Error executing STAR-CCM+
Check command in Process1.in file

STAR-CCM+ Log Files


During an Optimate run, Optimate is creating directories for each
STAR-CCM+ job. The directory for each run can be found in the directory
named:
star_0/DesignN/star/

Where N is the design ID of each job starting at one and ending with the
number of jobs to be run. If the Save all Simulation Files box is checked,
these folders will not be deleted and will persist after the run is complete. If
the box is unchecked, these directories will only persist during the run.
If any job fails it will be placed in a directory named:
star_0/DesignN-ERROR/star/

Optimate User Guide

35

The above directories will contain all of the input files, outputs files, a log
file, and the simulation file for each run. If STAR-CCM+ fails, an error
message will be in the star.log file. Errors can include:
Error getting appropriate licenses
Change number of simultaneous jobs in Process1.in file
Change number of core per STAR-CCM+ job in Process1.in file
Check CDLMD_LICENSE_FILE variable
Ensure license server is running
Error modifying 3D-CAD model
Change values to avoid invalid geometry
Error meshing
Check mesh settings in original simulation file
Floating point error
Review solver settings
Review initial conditions from original simulation file
Error importing CAD files
Check directoryCAD variable in StarDriver.java file
Error exporting scenes
Check directoryPOST variable in StarDriver.java file
Error saving simulation file
Check for specific cause at end of log file
Incompatible version error
The path environmental variable needs to be modified such that the
correct version of STAR-CCM+ is listed first in the path

HEEDS Post
If HEEDS Post fails to open or does not work as expected, the use can take
a look at the HEEDS Post log file for further information. The log file is
called HEEDSPost.log and is created in the users home directory.

Known Issues
1. If a job fails due to a licensing failure, Optimate will continue to wait for
this job to complete. Optimate will wait until the maximum time is
reached before submitting the next job.

Optimate User Guide

36

2. When restarting a Design Sweep study, the


UserDesigns0_DesignSweep.in_backup_at_0_evals file needs to be
renamed to UserDesigns0_DesignSweep.in. Not doing so will lead to
the design sweep variables not respecting the specific list of values
specified.
3. All of the licensing options cannot be selected at the same time.
Specifically, power sessions and serial/HPC licenses cannot be selected
together. A combination of either one with power tokens is a valid
combination (eg.: power sessions & tokens OR serial/HPCs & tokens
are valid). The currently invalid combination is planned to be
implemented in future releases.
4. Optimate Frame will fall behind STAR-CCM+ window when the mouse
hovers over an open STAR-CCM+ scene. The Always On Top option
in the File menu prevents this from happening, but the Optimate Frame
will now prevent file browsing, and message widows from Optimate
from being on top of itself.
5. When choosing variables from a .csv file, each variable should be
assigned by selecting the relevant column from the drop down box in
the Variables tab. Any automatic association created by Optimate is
purely coincidental and the association is not reflected for the actual
study.
6. For every field function variable, please ensure that the function name
is the same as the presentation name for the field function.