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.
Macro API Changes in Past Releases
The following sections provide a trail of macro API changes for the previous releases of Simcenter STAR-CCM+.
Macro API Changes 5.06
In Simcenter STAR-CCM+ 5.06, the macro API changed for scene and plot updates, and emissions modeling.

Share

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.
  - 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+.
    - Macro API Changes 2402
      In Simcenter STAR-CCM+ 2402, the macro API changed for 3D-CAD, motion, material properties, heat transfer, radiation, Eulerian multiphase, battery modeling, post-processing, and Design Manager.
    - Macro API Changes 2310
      In Simcenter STAR-CCM+ 2310, the macro API changed for tangential velocity specification, meshing, time, material properties, Lagrangian multiphase, Eulerian multiphase, DFBI, electromagnetism, post-processing, and CAE integration.
    - Macro API Changes 2306
      In Simcenter STAR-CCM+ 2306, the macro API changed for 3D-CAD, material properties, heat transfer, reacting flow, solid stress, Eulerian multiphase, electromagnetism, post-processing, and Simcenter STAR-CCM+ In-cylinder.
    - Macro API Changes 2302
      In Simcenter STAR-CCM+ 2302, the macro API changed for meshing, simulation operations, morphing, material properties, electromagnetism, battery modeling, and Simcenter STAR-CCM+ In-cylinder.
    - Macro API Changes 2210
      In Simcenter STAR-CCM+ 2210, the macro API changed for memory reporting, overset, material properties, aeroacoustics, reacting flow, Eulerian multiphase, electromagnetism, electrochemistry, and Design Manager.
    - Macro API Changes 2206
      In Simcenter STAR-CCM+ 2206, the macro API changed for materials, heat transfer, adjoint, reacting flow, multiphase, Eulerian multiphase, DFBI, solid stress, electromagnetism, electrochemistry, post-processing, and Simcenter STAR-CCM+ In-cylinder.
    - Macro API Changes 2022.1
      In Simcenter STAR-CCM+ 2022.1, the macro API changed for multiphase, DFBI, visualization, and update events.
    - Macro API Changes 2021.3
      In Simcenter STAR-CCM+ 2021.3, the macro API changed for 3D-CAD, meshing, heat transfer, aeroacoustics, reacting flow, Eulerian multiphase, dispersed multiphase, VOF, electromagnetism, battery modeling, visualization, Design Manager, CAE integration, and co-simulation.
    - Macro API Changes 2021.2
      In Simcenter STAR-CCM+ 2021.2, the macro API changed for adjoint, reacting flow, multiphase, Eulerian multiphase, electrochemistry, and Design Manager.
    - Macro API Changes 2021.1
      In Simcenter STAR-CCM+ 2021.1, the macro API changed for parts and regions, reacting flows, multiphase, Lagrangian multiphase, Eulerian multiphase, electromagnetism, visualization, and Design Manager.
    - Macro API Changes 2020.3
      In Simcenter STAR-CCM+ 2020.3, the macro API changed for 3D-CAD, motion, adjoint, Eulerian multiphase, DFBI, electromagnetism, and co-simulation.
    - Macro API Changes 2020.2
      In Simcenter STAR-CCM+ 2020.2, the macro API changed for directed meshing, material properties, adjoint, multiphase flow, solid stress, electrochemistry, visualization, and Simcenter STAR-CCM+ In-cylinder.
    - Macro API Changes 2020.1
      In Simcenter STAR-CCM+ 2020.1, the macro API changed for finite element models, motion, coupled flow, adjoint, reacting flows, DFBI, electromagnetics, multiphase, and co-simulation.
    - Macro API Changes 2019.3
      In Simcenter STAR-CCM+ 2019.3, the macro API changed for meshing, finite element models, overset, porous media, adjoint, DEM, Eulerian multiphase, VOF and N-Phase mixtures, electromagnetics, electrochemistry and plasma, Design Manager, co-simulation, and STAR-ICE (now Simcenter STAR-CCM+ In-cylinder).
    - Macro API Changes 2019.2
      In Simcenter STAR-CCM+ 2019.2, the macro API changed for surface preparation, time, motion, adjoint, wall distance, aeroacoustics, multiphase, electromagnetics, reports, co-simulation, and STAR-ICE.
    - Macro API Changes 2019.1
      In Simcenter STAR-CCM+ 2019.1, the macro API changed for meshing, derived units, finite element models, aeroacoustics, reacting flows, Lagrangian multiphase, Eulerian multiphase, electromagnetics, statistics reports, co-simulation, and STAR-ICE.
    - Macro API Changes 13.06
      In Simcenter STAR-CCM+ 13.06, the macro API changed for stopping criteria, reacting flows, Eulerian multiphase, electromagnetics, electrochemistry, Design Manager, and co-simulation.
    - Macro API Changes 13.04
      In Simcenter STAR-CCM+ 13.04, the macro API changed for surface preparation, radiation, reacting flows, Eulerian multiphase, multiphase segregated flow, DFBI, electromagnetics, Design Manager, and co-simulation.
    - Macro API Changes 13.02
      In Simcenter STAR-CCM+ 13.02, the macro API changed for surface preparation, boundary conditions, harmonic balance, heat transfer, DFBI, aeroacoustics, reacting flows, Eulerian multiphase, turbulence, monitors, plots, Design Manager, and co-simulation.
    - Macro API Changes 12.06
      In Simcenter STAR-CCM+ 12.06, the macro API changed for stopping criteria, surface preparation, mesh operations, species and material models, porous media, wall porosity, Eulerian multiphase, dispersed multiphase, reacting flows, DFBI, and monitors.
    - Macro API Changes 12.04
      In Simcenter STAR-CCM+ 12.04, the macro API changed for surface preparation, part operations, dynamic queries, DFBI, finite element analysis, reacting flows, Eulerian multiphase, electromagnetics, electrochemistry, and co-simulation.
    - Macro API Changes 12.02
      In Simcenter STAR-CCM+ 12.02, the macro API changed for morphing motion, Eulerian multiphase, meshing, and reacting flows.
    - Macro API Changes 11.06
      In Simcenter STAR-CCM+ 11.06, the macro API changed for electrochemistry, Eulerian multiphase, reacting flows, directed meshing, mesh deformation, client-server, tags, and meshing.
    - Macro API Changes 11.04
      In Simcenter STAR-CCM+ 11.04, the macro API changed for electrochemistry, simulation retrieval, server connections, co-simulation, VOF, DEM, the Segregated Time Step, material models, combustion, meshing, and morphing.
    - Macro API Changes 11.02
      In Simcenter STAR-CCM+ 11.02, the macro API changed for electrochemistry, combustion, erosion, GT-SUITE co-simulation, data mapping, and virtual disk modeling.
    - Macro API Changes 10.06
      In Simcenter STAR-CCM+ 10.06, the macro API changed for units, shell thickness, simple shape parts, combustion, material properties, turbulence, and heat transfer.
    - Macro API Changes 10.04
      In Simcenter STAR-CCM+ 10.04, the macro API changed for battery modeling, aeroacoustics, finite-volume solid stress, granular particle phases, motions, pressure boundaries, and meshing.
    - Macro API Changes 10.02
      In Simcenter STAR-CCM+ 10.02, the macro API changed for multiphase segregated flow, meshing, and combustion.
    - Macro API Changes 9.06
      In Simcenter STAR-CCM+ 9.06, the macro API changed for the On-The-Fly FW-H model, the Circuit Solver, the Dars-CFD Reaction model, the Fan Interface model, and simple shape parts.
    - Macro API Changes 9.04
      In Simcenter STAR-CCM+ 9.04, the macro API changed for the Granular Pressure model, Eulerian multiphase modeling, co-simulation, 1D coupling, STAR-Cast, and the Ffowcs Williams-Hawkings models.
    - Macro API Changes 9.02
      In Simcenter STAR-CCM+ 9.02, the macro API changed for OLGA coupling, the Phase Coupled Isothermal model, the Haugen Erosion Correlation, part surface contacts, the plane tool, the Molecular Diffusivity model, DFBI, and simple shape part creation.
    - Macro API Changes 8.06
      In Simcenter STAR-CCM+ 8.06, the macro API changed for dataset functions, the Turbulent Dispersion model, part contacts, planar motion, the Granular Temperature model, the Solid Stress model, and mesh operations.
    - Macro API Changes 8.04
      In Simcenter STAR-CCM+ 8.04, the macro API changed for VOF, the Ffowcs Williams-Hawkings models, multi-component fluids, battery meshing, and fluid film.
    - Macro API Changes 8.02
      In Simcenter STAR-CCM+ 8.02, the macro API changed for VOF, directed meshing, battery modeling, melting, plots, and vaporization.
    - Macro API Changes 7.06
      In Simcenter STAR-CCM+ 7.06, the macro API changed for battery modeling, VOF, and directed meshing.
    - Macro API Changes 7.04
      In Simcenter STAR-CCM+ 7.04, the macro API changed for the Melting-Solidification model, cavitation, DFBI, and Eulerian Multiphase modeling.
    - Macro API Changes 7.02
      In Simcenter STAR-CCM+ 7.02, the macro API changed for energy source options, battery modeling, thermal resistance, derived parts, harmonic balance, and thermal comfort.
    - Macro API Changes 6.06
      In Simcenter STAR-CCM+ 6.06, the macro API changed for DFBI, VOF, melting and solidification, the Solid Stress solver, battery modeling, and OLGA coupling.
    - Macro API Changes 6.04
      In Simcenter STAR-CCM+ 6.04, the macro API changed for Multiphase Segregated flow, Eulerian Multiphase turbulence, surface tension, cavitation, boiling, VOF, 3D-CAD, Abaqus co-simulation, thermal comfort, and OLGA coupling.
    - Macro API Changes 6.02
      In Simcenter STAR-CCM+ 6.02, the macro API changed for Abaqus co-simulation, CAE importing, 3D-CAD, and combustion.
    - Macro API Changes 5.06
      In Simcenter STAR-CCM+ 5.06, the macro API changed for scene and plot updates, and emissions modeling.
    - Macro API Changes 5.04
      In Simcenter STAR-CCM+ 5.04, the macro API changed for the materials database, NASA polynomials, surface repair, DFBI, and clearing solutions.
    - Macro API Changes 5.02
      In Simcenter STAR-CCM+ 5.02, the macro API changed for motion and reports (Body Force and Body Moment).
    - Macro API Changes 4.06
      In Simcenter STAR-CCM+ 4.06, the macro API changed for passive scalar, thermal porosity, and cavitation.
    - Macro API Changes 4.04
      In Simcenter STAR-CCM+ 4.04, the macro API changed for Flow-Split Outlet boundaries, VOF, system reports, porous energy, 6-DOF bodies, and the Turbo Wizard.
    - Macro API Changes 4.02
      In Simcenter STAR-CCM+ 4.02, the macro API changed for combustion, the materials database, passive scalar, and LES turbulence.
    - Macro API Changes 3.04
      In Simcenter STAR-CCM+ 3.04, the macro API changed for reflectivity, volume shapes, and meshing.
    - Macro API Changes 3.02
      In Simcenter STAR-CCM+ 3.02, the macro API changed for transmissivity.
    - Macro API Changes 2.10
      In Simcenter STAR-CCM+ 2.10, the macro API changed for stopping criteria and VOF.
- 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.

Macro API Changes 5.06

In Simcenter STAR-CCM+ 5.06, the macro API changed for scene and plot updates, and emissions modeling.

Changes to various items within the macro API are detailed below. Macros created using previous releases of the software will not necessarily run in Simcenter STAR-CCM+ 5.06.010 if any of the items in the Previous Release columns below have been accessed.

Update Frequency for Scenes and Plots

The method for specifying update frequency has changed, in order to accommodate the delta time method. Previously, Update Frequency, which is only meaningful for number of iterations or number of time steps, was just a property of the SceneUpdate and PlotUpdate objects. Now, the specific object related to each type of update should be obtained from the PlotUpdate object.


Previous Release	Simcenter STAR-CCM+ 5.06.010
PlotUpdate plotUpdate_0 = xYPlot_0.getPlotUpdate(); plotUpdate_0.setUpdateMode(1); // Iterations Update Policy plotUpdate_0.setUpdateFrequency(10);	PlotUpdate plotUpdate_0 = xYPlot_0.getPlotUpdate(); plotUpdate_0.setUpdateMode(1); // Iterations Update Policy IterationUpdateFrequency iterationUpdateFrequency_0 = plotUpdate_0 .getIterationUpdateFrequency(); iterationUpdateFrequency_0 .setIterations(10);
	plotUpdate_0.setUpdateMode(2); // Time Step Update Policy TimeStepUpdateFrequency timeStepUpdateFrequency_0 = plotUpdate_0 .getTimeStepUpdateFrequency(); timeStepUpdateFrequency_0 .setTimeSteps(5);
	plotUpdate_0.setUpdateMode(3); // Delta Time Update Policy DeltaTimeUpdateFrequency deltaTimeUpdateFrequency_0 = plotUpdate_0 .getDeltaTimeUpdateFrequency(); deltaTimeUpdateFrequency_0 . getDeltaTime() .setValue(1.1);

Activating PCFM and NOx Emissions

In previous releases, activating PCFM and NOx Emissions had the effect of turning on NOx PPDF automatically. However, this is not required in the case of PCFM Emissions as PCFM already has a PPDF solver. Previous macros would have had the line:

physicsContinuum_0.enable(NoxPpdfCombustionModel.class);

This line is no longer required for PCFM Emissions.