hm_getloadoption
Returns the current values for load display options.
Syntax
hm_getloadoption option config
Type
HyperMesh Tcl Query
Description
This command returns the current display setting for the passed load option.
Inputs
- option
- The option to query. Valid values are:
- equationhandle
- Returns the *equationhandle setting (0 = off, 1 = on). No config value should be specified.
- graphic_label
- Returns the *graphic_label setting (0 = HM labels, 1 = template labels). All config values currently operate together.
- loadhandle
- Returns the *loadhandle setting (0 = off, 1 = on). Not valid for config 10. All other config values currently operate together.
- loadlabel
- Returns the *loadlabel setting (0 = off, 1 = on). Not valid for config 10. config 3 operates independently. All other config values currently operate together.
- loadsize_magnitude
- Returns the *loadsize "magnitude %" size. Not valid for config 3 or 10. All other config values currently operate together. This can be queried regardless of the loadsize_type
- loadsize_type
- Returns the *loadsize type setting (0 = uniform, 1 = magnitude %). Not valid for config 10. config 3 operates independently. All other config values currently operate together.
- loadsize_uniform
- Returns the *loadsize "uniform" size value. Not valid for config 10. config 3 operates independently. All other config values currently operate together. This option can be queried regardless of the loadsize_type value.
- config
- The load config to query for the specified option. Valid values are:
- 1 – forces
- 2 – moments
- 3 – constraints
- 4 – pressures
- 5 – temperatures
- 6 – fluxes
- 7 – (unused)
- 8 – velocities
- 9 – accelerations
Examples
To get the loadhandle setting for constraints:
hm_getloadoption loadhandle 3
To get the loadlabel setting for forces:
hm_getloadoption graphic_label 4
To get the loadlabel setting for forces:
hm_getloadoption loadlabel 1
To get the loadsize_type setting for moments:
hm_getloadoption loadsize_type 2
To get the loadsize_uniform setting for constraints:
hm_getloadoption loadsize_magnitude 5
To get the loadsize_magnitude setting for temperatures:
hm_getloadoption loadsize_magnitude 5
Errors
Incorrect usage results in a Tcl error. To
detect errors, you can use the catch
command:
if { [ catch {command_name...} ] } {
# Handle error
}
Version History
9.0