Home
User Interface
Simcenter STAR-CCM+ provides a Graphical User Interface generally known as the client workspace. This interface appears when you launch Simcenter STAR-CCM+ interactively.
Scripting the Application
Scripting allows you to work more efficiently by automating repetitive tasks.
Playing the Macro
A macro can be played from the workspace and stopped or, maybe more typically, can be run in batch mode. It is also possible to replay recent macros.
Running the Macro in Batch Mode
You can run a macro in batch mode.

Link: copied

Breadcrumb: copied

User Interface
Simcenter STAR-CCM+ provides a Graphical User Interface generally known as the client workspace. This interface appears when you launch Simcenter STAR-CCM+ interactively.
- Using the Simcenter STAR-CCM+ Workspace
  This chapter shows you how to use the various components of Simcenter STAR-CCM+, with a focus on the user interface.
- What Are the Important Concepts?
  This section presents the key concepts you come across when using Simcenter STAR-CCM+.
- Working with Simulation Objects
  Objects are the key components of Simcenter STAR-CCM+. They represent various aspects of a simulation and have properties that you can set as required for your particular problem.
- Automation
  The Automation node provides easy access to a number of frequently used automated processes.
- Expressions
  In Simcenter STAR-CCM+, you can define property values using expressions, which you write using a function language that is a subset of the C programming language. Expressions can define mathematical expressions or perform other operations, such as interpolating tabular data from XY tables in the simulation.
- Global Parameters
  Global parameters include scalar and vector physical quantities (for example, 120.0 K or [0.0, 1.0, 0.0] m) that can be defined once and used in multiple objects. Another type of global parameter is a file, currently used for the Replace Parts operation in Geometry > Operations and in Design Manager.
- Field Functions
  Field functions allow you to access fields (scalar or vector data that are evaluated at cells, vertices, or boundary faces) in Simcenter STAR-CCM+. You can use field functions to visualize the computed fields, to specify boundary and region values, or to define initial conditions.
- Engineering Units
  Simcenter STAR-CCM+ has flexible and customizable support for engineering units. The standard SI and USCS systems are built in, and you can add new units as desired. Physical quantities can be specified and displayed in any of these units. Individual quantities can be specified with new units on the fly by simply typing something like “80 mph”.
- Simulation Operations
  Simulation operations allow you to automate the solution processes in Simcenter STAR-CCM+ without using Java macros. Condition and loop operations provide the basic logic control common to many programming languages.
- Staged Physics
  In Simcenter STAR-CCM+, staged physics allows you to store multiple configurations of physics settings and apply them in sequence during a simulation. Simulation operations provide the framework in which physics stages are applied.
- Working with Volume Shapes
  A volume shape is a closed geometric figure that can be shaped as a block, cone, cylinder, or sphere.
- Simulation Guide
  The simulation guide is a single embedded document that you can edit within a simulation file. This document can contain formatted text, tables, images, and hyperlinks to nodes in the Simcenter STAR-CCM+ object tree or external web resources.
- Template Simulation Files
  Template simulation files allow you to define pre-configured setups for use in new simulations. When used in conjunction with query-based selection, template files present a powerful technique for automating repeat analyses on similar geometries.
- Scripting the Application
  Scripting allows you to work more efficiently by automating repetitive tasks.
  - Recording a Macro
    The easiest way to create your Java macro file is to record one in Simcenter STAR-CCM+ while you perform all the steps that belong in the macro file.
  - Editing the Macro
    The macro file is a regular text file containing Java code that can be edited and customized to suit your task.
  - Playing the Macro
    A macro can be played from the workspace and stopped or, maybe more typically, can be run in batch mode. It is also possible to replay recent macros.
    - Running the Macro in Batch Mode
      You can run a macro in batch mode.
      - Adding Arguments to a Macro in Batch Mode
        You can use command-line arguments in a batch run macro.
    - Running Using the Recent Macros List
      Simcenter STAR-CCM+ keeps a record of macros that were run previously in any simulation and makes them available in a list.
  - Debugging a Macro Using an IDE
    You can debug a Simcenter STAR-CCM+ macro using a special command-line option and an Integrated Development Environment (IDE) program.
  - Running Multiple Simulations Consecutively
    You can load and run multiple simulation files consecutively using a single macro. You do not need a separate shell or DOS script.
  - Playing Macros Within Macros
    For greater automation of your simulation work, you can create a macro that calls other macros.
  - Adding Custom Macros to the Toolbar
    You can add toolbar buttons that instantly launch the macros of your choice.
  - Using the Java API
    The Java API, or Application Programmer Interface, contains a comprehensive range of Java code that functions in Simcenter STAR-CCM+ macros.
  - Working with Default Macros
    The default macro is a Java macro that is automatically created at the start of each interactive session.
  - Macro API Changes in Past Releases
    The following sections provide a trail of macro API changes for the previous releases of Simcenter STAR-CCM+.
- Working with User Code
  User code allows Simcenter STAR-CCM+ to be customized with functions written in a compiled language such as C, C++ or Fortran.
- Working with the Plugins Manager
  The Plugins Manager makes it possible to install and manage NetBeans modules for Simcenter STAR-CCM+.
- Simulation Assistants
  A Simulation Assistant provides a visual workflow within the Simcenter STAR-CCM+ user interface (UI).
- Wizard Guide
  This part of the documentation illustrates how Simcenter STAR-CCM+ is used for special application tools and projects.

Running the Macro in Batch Mode

You can run a macro in batch mode.

Batch mode for macros is run from the command line using the -batch option:

% starccm+ -batch cavity.java file.sim

This option runs Simcenter STAR-CCM+ with a script (cavity.java in the above example). The -batch option ensures that no GUI is displayed. If you do not want the server process to exit once the batch file has completed, then add the -noexit option to the command line. For example, maybe you want to connect to it to analyze results. If you wish to monitor the progress of a batch run, an additional client can access the server process interactively.

Alternatively, you can start a new simulation and run a macro in batch mode:

% starccm+ -new -batch macro.java

The following command-line arguments can be used in a batch run macro:

Pass in property definitions (Windows or Linux):
-jvmargs -Dmyprop=myvalue
Multiple instances of -jvmargs are permitted.
Include System.getProperty("myprop") in the macro.