Command Line Options

It is possible to run CST STUDIO SUITE in batch mode.

Please note that the quotation marks are mandatory!

 

In addition to the command line options listed below also environment variables are available.

 

To start a specific module, open a help project or perform some basic settings, the following command line options are available:

Options

Description

-m

Starts CST MICROWAVE STUDIO

-s

Starts CST EM STUDIO

-t

Starts CST PARTICLE STUDIO

-mp

Starts CST MPHYSICS STUDIO

-c

Starts CST DESIGN STUDIO

-cs

Starts CST CABLE STUDIO

-pcbs

Starts CST PCB STUDIO

-?

Shows the online help (for the started module, if one has been started)

-d

Uses filename relative to the installation directory

-i

Starts the application in the iconified state

 

 

 

In general, the following extensions are valid for filename:

Extension

Description

.bas

Executes the BASIC file;  -m, -s, -t or -c must be specified

.cst

Loads the CST STUDIO SUITE project file; -m, -s, -t, -mp or -c must be specified

.mod

Loads the CST MICROWAVE STUDIO project file; -m, -s, -t, -mp or -c must be specified

.ems

Loads the CST EM STUDIO project file; -m, -s, -t, -mp or -c must be specified

.psf

Loads the CST PARTICLE STUDIO project file; -m, -s, -t, -mp or -c must be specified

.mpf

Loads the CST MHYSICS STUDIO project file; -m, -s, -t, -mp or -c must be specified

.des

Loads the CST DESIGN STUDIO project file; -c must be specified

 

 

 

The following options start a calculation after loading a project (and are only valid with a given project file):

Options

Description

-b

Executes the script file "Model.run" that has to be located in the "Model\3D\" folder of the corresponding project; only valid for -m, -s or -t

-par <mwsproject.par>

Imports parameters from a CST MICROWAVE STUDIO project, only valid for -c

-rebuild

Performs a complete history rebuild; only valid for -m, -s, -t, -mp or -cbl

-p

Starts a parameter sweep. This option always uses the solver that was used last for the saved project.

-o

Starts the optimizer. This option always uses the solver that was used last for the saved project.

-n

Starts a network parameter extraction; only valid for -m or -c

-f

Starts the frequency domain solver; only valid for -m

-r

Starts the time domain solver; only valid for -m

-e

Starts the eigenmode solver; only valid for -m

-q

Starts the integral equation solver; only valid for -m

-a

Starts the asymptotic solver; only valid for -m

-ml

Starts the multilayer solver; only valid for -m

-se

Starts the electric field solver; only valid for -s

-sh

Starts the magnetic field solver; only valid for -s

-sj

Starts the stationary current field solver; only valid for -s

-lf

Starts the LF frequency domain solver (magnetoquasistatic or fullwave); only valid for -s

-lfeqs

Starts the LF frequency domain solver (electroquasistatic); only valid for -s

-ltmqs

Starts the LF time domain solver (magnetoquasistatic); only valid for -s

-ht

Starts the stationary thermal solver; only valid for -mp

-httd

Starts the transient thermal solver; only valid for -mp

-mech

Starts the structural mechanics solver, only valid for -mp

-tp

Starts the particle tracking solver; only valid for -t

-te

Starts the electric field solver; only valid for -t

-th

Starts the magnetic field solver; only valid for -t

-tw

Starts the wakefield solver; only valid for -t

-pic

Starts the particle in cell solver; only valid for -t

-u

Updates the results in CST DESIGN STUDIO, only valid for -c

-withdc

-withdc=maincontroller:port

 

Starts the specified solver with distributed computing. If no main controller is specified, the main controller from the global or project dependent settings are taken. Otherwise the specified main controller is used.

Also supported by Job Control Center.

-dcn

This option sets the distributed excitations or frequency samples to n. Only valid for -withdc and -r, -f, and -q.

Example: -dc6

Also supported by Job Control Center.

-dcparn

Sets the number of distributed parameter sets to n. Only valid for -withdc and -p and -o.

When used with -dcn and a transient simulation, then the ports are also distributed.

Example: -dcpar10

Also supported by Job Control Center.

-withmpi

Enables MPI computing. Also a machinefile must be specified, when using MPI; only valid for CST MICROWAVE STUDIO (-m) and either the  transient solver (-r), the frequency domain solver (-f) or the integral equation solver (-q) as well as for CST PARTICLE STUDIO (-t) and the wakefield solver (-tw).

See introduction for Queuing System and MPI for the detailed command description and also an overview of Queuing system.

Also supported by Job Control Center.

-machinefile "mach_file"

Defines the location of the Machine file path (mach_file), in order to use MPI simulation jointly with a given queuing system launcher.

Machine file path should be enclosed in "" pair.

Must be used with -withmpi and can be used with -withdc

Also supported by Job Control Center.

-queuesys "qs_tag"

Defines the queueing system. Currently available queuing system tags (qs_tag) are {CST, MPI, SGE, OGE, PBS, LSF, LSF_MCPU}.

Also supported by Job Control Center.

-withgpu=<#n>

Defines the number of GPUs to be used for the given simulation. Currently available for CST MICROWAVE STUDIO (-m) with the  transient solver (-r) only. The number of selected GPUs can be either 1, 2 or 4.

Also supported by Job Control Center.

-numthreads=<#n>

 

Defines the number of threads to be used for the given simulation. Currently available for CST MICROWAVE STUDIO (-m) and CST EM STUDIO (-s) only.

Also supported by Job Control Center.

-defaultacc

Overwrites all project specific acceleration settings (related to threads, DC, MPI and GPU computing) to their default settings. All command line options related to acceleration are taken still into account, though.

Also supported by Job Control Center.

 

Example

To open a project and solve it using the transient solver, use:

<Installation Path>\CST DESIGN ENVIRONMENT.exe -m -r "C:\My Work\MyProject.cst"

 

If any other setting is necessary, it can be accomplished by executing an appropriate Visual Basic file.  Each module can be controlled through Visual Basic commands.

See also

Environment Variables, VBA Application Object