HFSS15: Examples and Further Explanations of -batchoptions use

This section provides further examples explanations of -batchoptions.

• Example with registry settings specified on the command line

• Example with registry settings specified in a file

• -batchoptions Uses Relative Registry Paths

• When to Use the -batchoptions Desktop Command Line Option

The following examples use hfss, but this feature is available for all desktop products.

• The registry path separator is the slash "/"

• Registry key pathnames are enclosed in single quotes

• Registry string values are enclosed in single quotes

• Backslashes in registry key values must be escaped with another backslash

Example with registry settings specified on the command line

hfss.exe -batchsolve -batchoptions

"'HFSS/Preferences/NumberOfProcessors'=4

'Desktop/ProjectDirectory'='C:\projects\test'" projectname.hfss

This command line overrides the values of the HFSS/Preferences/NumberOfProcessors and Desktop/ProjectDirectory registry settings.

Notes:

• Multiple registry settings may appear in a single -batchoptions value, separated by whitespace

• The -batchoptions value must be enclosed in double quotes if it contains any whitespace

Example with registry settings specified in a file

hfss.exe -batchsolve -batchoptions filename projectname.hfss

where file filename contains:

$begin 'Config'

'HFSS/Preferences/NumberOfProcessors'=4

'Desktop/ProjectDirectory'='C:/projects/test'

$end 'Config'

This command line overrides the values of the HFSS/Preferences/NumberOfProcessors and Desktop/ProjectDirectory registry settings. These overrides apply only to the current hfss session.

-batchoptions Uses Relative Registry Paths

When using the -batchoptions command line option, the registry paths specified on the command line or in the batchoptions file are relative paths. The paths are relative to the current version of the current product. If the examples above are used with HFSS version 14.0, then the following table shows the relative and absolute paths of the registry overrides in the above examples.

For additional options and paths for use with -batchoptions, see

For -batchoptions Use: Project Directory and Lib Paths

For -batchoptions Use: TempDirectory

For -batchoptions Use: Various Desktop Settings

For -batchoptions Use: HFSS and HFSS-IE Options with Paths

When to Use the -batchoptions Desktop Command Line Option

Many analysis parameter settings may be done using the GUI. For example, a number of HFSS options may be set using the HFSS Options dialog box, which is brought up by the Tools>Options>HFSS Options... menu item. These parameter settings include the following solver options (not a complete list):

• NumberOfProcessors

• NumberOfProcessorsDistributed

• MemLimitSoft: (Desired RAM Limit)

• MemLimitHard: (Maximum RAM Limit)

HFSS and HFSS-IE include a -batch option for distributed memory:

• SetMPIVendor (either "Intel" or "Platform Computing".

These values of these parameters are saved in the registry when HFSS is not running.

When running a batch analysis, these parameters will take the values from the registry. The -batchoptions Desktop command line option allows you to override the parameter values set in the registry with values specified on the command line or in a file. The values specified using the -batchoptions command line option only apply to the batch job, and do not affect the parameter values in the registry. For example, you could specify the following command to ensure that this analysis uses 2 processors for distributed processing and 2 processors for non-distributed processing. If the -batchoptions value is not specified, then the number of processors for distributed processing or for non-distributed processing could be affected by an interactive HFSS job running on the same host as the same user.

hfss -ng -BatchSolve -Distributed
-machinelist num=2

-batchoptions

"'HFSS/Preferences/NumberOfProcessorsDistributed'=2
'HFSS/Preferences/NumberOfProcessors'=2
'HFSS/Preferences/UseHPCForMP'=1
'HFSS/Preferences/HPCLicenseType'=pool"
OptimTee.hfss