*setoption

Sets various option values.

Syntax

*setoption <option>=<value>

Type

HyperMesh Tcl Modify Command

Description

Sets various option values.

Inputs

<option>=<value>
The name of the option and the corresponding value to assign. Valid options and values are as follows:
1d_at_centroid=<value>
Controls whether the 3D representation of 1D elements is relative to the centroid or the shear center. Valid values are:
0 - The 3D representation of 1D elements is relative to the shear center.
1 - The 3D representation of 1D elements is relative to the centroid.
alt_lmb_rmb_binding=<value>
Select action for Alt key and left + right mouse button drag.
Valid values are Pan, Rotate, Zoom and CircleZoom.
alt_mmb_binding=<value>
Select action for Alt key and middle mouse button drag.
Valid values are Pan, Rotate, Zoom and CircleZoom.
alt_rmb_binding=<value>
Select action for Alt key and right mouse button drag.
Valid values are Pan, Rotate, Zoom and CircleZoom.
anti_alisasing=<value>
Sets the anti-aliasing mode:
0 - Disable anti-aliasing.
1 - Enable anti-aliasing.
auto_bs_thickness =<value>
Enables automatic calculation of the default thickness of shell beamsection.
0 - Off
1 - On
auto_cleanuptol=<value>
Sets the geometry cleanup calculation mode. Valid values are:
0 - Manually set the tolerance.
1 - Auto calculate the tolerance.
auto_elementsize=<value>
Sets the element size calculation mode. Valid values are:
0 - Manually set the size.
1 - Auto calculate the size.
auto_nodetol=<value>
Sets the node tolerance calculation mode. Valid values are:
0 - Manually set the tolerance.
1 - Auto calculate the tolerance.
auto_mesh_color_mode=<value>
Sets the auto mesh color mode for mesh lines. Valid values are:
0 - Disable auto mesh line coloring and instead use the color specified by mesh_line_color.
1 - Enable auto mesh line coloring.
axis_drawn_view_cube=<value>
Control axis arrows when show_view_cube=1 or show_view_cube=2. Valid values are:
0 - Arrows are hidden (default)
1 - Arrows are visible
beam_lod_threshold=<value>
The zoom level required to make beams visible, as an integer value from 0-10 (default 6.5). 0 means mesh lines are always visible. Smaller values indicate minimal zoom is needed. Higher values mean more zoom is needed.
beam_lod_threshold=<value>
0 - Off/disabled
1 - The number of elements in the frustum (default 4080).
beam_mesh_vis=<value>
The visualization of mesh lines on beams.
0 - Off
1 - On (default).
bitmap_animation=<value>
The bitmap animation graphics mode. Valid values are:
0 - None (default)
1 - Simple
2 - Compressed
block_error_messages=<value>
Controls the display of error messages.
0 - Displays error messages
1 - Blocks error messages. Error messages can still be displayed from Tcl scripts by using hm_errormessage.
block_messages=<value>
Controls the display of info messages.
0 - Displays info messages
1 - Blocks info messages. Info messages can still be displayed from Tcl scripts by using hm_usermessage.
block_redraw=<value>
Controls the graphics redraw. When the redraw operation is blocked, HyperMesh will not redraw unless the size of its window changes or it is de-iconified or maximized. When the redraw operation is unblocked, HyperMesh returns to normal.
0 - Allows redraw
1 - Blocks redraw
blue_auto_color_range_max=<value>
The maximum value of the blue color range for auto coloring. Valid values are 0-255 (default 200).
blue_auto_color_range_min=<value>
The minimum value of the blue color range for auto coloring. Valid values are 0-255 (default 40).
br_autofit_graphics=<value>
Automatically fit selected entity in graphics upon isolating from browsers.
0 - Off
1 - On
br_autoscroll=<value>
Automatically scroll browser list to selected entity upon selecting entity in graphics.
0 - Off
1 - On
br_autosort=<value>
Automatically sort the entities with applied sorting upon creating and editing entities.
0 - Off
1 - On
br_filter_mode=<value>
Automatically filter the entities with the applied filter upon creating and editing entities.
0 - Off
1 - On
br_filter_nested=<value>
Show nested entities when a parent entity passes for the applied filter.
0 - Off
1 - On
br_partbrowser_show_components=<value>
Show components in the Part browser hierarchy view.
0 - Off
1 - On
br_show_entities_all=<value>
Show entities under subfolders in hierarchical browsers (Model, Subsystem).
0 - Off
1 - On
br_show_treelines =<value>
Show tree lines in hierarchical browsers.
0 - Off
1 - On
bs_thickness=<value>
The user-defined default thickness of shell beamsection.
buffer_command_file=<value>
Controls the command file buffering state.
0 - Disable buffering the command file
1 - Enable buffering the command file
CAD_topology_revision_auto_remesh_layers=<value>
Number of layers around operation areas to be remeshed. A value of -1 indicates that entire affected surface will be remeshed.
CAD_topology_revision_edit_at_fe_mode=<value>
Avoid remesh when geometry topology matches with 2D mesh edges after revision. Applicable only for remesh mode.
0 - Remesh always
1 - Remesh only if geometry topology is different than mesh topology.
CAD_topology_revision_mesh_mode=<value>
The remesh setting for topology revision.
0 - Delete mesh
1 - Dissociate Mesh
2 - Remesh
CAD_topology_revision_remesh_tetra_mesh =<value>
3D tetra remesh mode. Applicable only for remesh mode.
0 - No 3D tetra remesh
1 - 3D tetra remesh
CAD_topology_revision_transform_mode=<value>
Option to control 2D remesh on transformation of geometry. Applicable only for remesh mode.
0 - Remesh
1 - Do not remesh
CAD_topology_revision_transform_mode_rule=<value>
Option to move mesh along geometry during geometry transformation. Applicable only for remesh mode and transformation mode.
0 - Keep and break connectivity.
1 - Move and break connectivity.
cadupdate_inspire_installation=<value>
The Inspire installation path for CAD update operation.
cadupdate_parameter_immediate=<value>
0 - When changing parameters associated to external CAD files, do not update the parameters back in the CAD system automatically
1 - When changing parameters associated to external CAD files, update the parameters back in the CAD system automatically
cleanup_tolerance=<value>
The geometry cleanup tolerance used for geometry creation and editing operations.
clip_boundary_elements=<value>
The boundary element display mode for hidden line, section cut and spherical clipping.
0 - Boundary elements are not clipped and entire elements are shown
1 - Boundary elements are clipped and a smooth boundary is shown
ctrl_lmb_rmb_binding=<value>
Select action for Ctrl key and left + right mouse button drag.
Valid values are Pan, Rotate, Zoom and CircleZoom.
ctrl_mmb_binding=<value>
Select action for Ctrl key and middle mouse button drag.
Valid values are Pan, Rotate, Zoom and CircleZoom.
ctrl_rmb_binding=<value>
Select action for Ctrl key and right mouse button drag.
Valid values are Pan, Rotate, Zoom and CircleZoom.
coincident_picking=<value>
The state of coincident graphical picking.
0 - Disable coincident picking
1 - Enable coincident picking
command_file_state=<value>
The state of writing to the command file.
0 - Disable writing to the command file
1 - Enable writing to the command file
constraints_handle=<value>
Controls the display of DOF and weights label. Valid values are:
0 – Hide the DOFs and weights label.
1 – Show the DOFs and weights label.
constraints_node_limit=<value>
Controls the display of DOF and weights label. Valid values are:
Draws a spider to the bounding box of node selection if selection exceeds threshold (default 10000).
contact_surface_peak_factor=<value>
The factor for scaling the contact surface graphical height.
contact_surface_percent=<value>
The percent of the element size to use for scaling the contact surface graphical length and width.
contour_type=<value>
The result color mode.
0 - Blended contour
1 - Discrete contour
create_fe_topo_upon_element_copy=<value>
Option to create FE Topology for duplicated elements upon element copy.
0 - Do not create FE Topology.
1 - Create FE Topology and disassociate nodes for duplicated elements from original geometry.
delete_assemblies_children=<value>
Delete associated assemblies when deleting assemblies.
0 - Do not delete.
1 - Delete associated assemblies.
delete_attachments_realization=<value>
Delete associated FE realization when deleting attachments.
0 - Do not delete.
1 - Delete attachment FE realization.
delete_connectors_realised_fe=<value>
Delete associated FE realization when deleting connectors.
0 - Do not delete.
1 - Delete connectors FE realization.
delete_discrete_topology_mode=<value>
Select a remeshing method for revising modified discrete topology.
Valid values are "Keep mesh", Remesh and "Advanced remesh".
delete_elements_mode=<value>
The remesh setting for topology revision.
0 - Keep mesh
1 - Delete mesh
2 - Remesh
3 - Advanced remesh
4 - 2D + 3D (tetra) remesh
delete_line_with_elements=<value>
Delete associated 1D elements to FE Geometry line while line deletion.
0 - Do not delete.
1 - Delete associated 1D elements to FE Geometry line.
delete_part_contents=<value>
Delete associated part content when deleting parts.
0 - Do not delete.
1 - Delete associated part content.
delete_preserve_nodes=<value>
Delete preserve nodes when deleting selected nodes.
0 - Off
1 - On
delete_solids_with_elements=<value>
Delete associated elements when deleting solids.
0 - Do not delete.
1 - Delete elements associated with solids.
delete_solids_with_surface=<value>
Delete associated surfaces when deleting solids.
0 - Do not delete.
1 - Delete surfaces associated with solids.
delete_surface_with_elements=<value>
Delete associated elements when deleting surfaces.
0 - Do not delete.
1 - Delete elements associated with surfaces.
delete_surface_with_solids=<value>
Delete associated solids when deleting surfaces.
0 - Do not delete.
1 - Delete solids associated with surfaces.
delete_subsystem_contents=<value>
Delete subsystem content when deleting subsystems.
0 - Do not delete.
1 - Delete the content of subsystem.
detailed_elements=<value>
The 3D visualization mode for 1D/2D elements.
0 - Traditional 1D/2D element display.
1 - Detailed 1D/2D element display. 1D elements are viewed as 3D representations with proper cross-section, orientation and offset. 2D elements are views as 3D representations with proper thickness and offset.
2 - Combined traditional and detailed 1D/2D element display.
detailed_elements_beamvis=<value>
The 3D visualization mode for 1D elements.
0 - Traditional 1D element display
1 - Detailed 1D element display. 1D elements are viewed as 3D representations with proper cross-section, orientation and offset.
2 - Combined traditional and detailed 1D element display
detailed_elements_shellvis=<value>
The 3D visualization mode for 2D elements.
0 - Traditional 2D element display.
1 - Detailed 2D element display. 2D elements are views as 3D representations with proper thickness and offset.
2 - Combined traditional and detailed 2D element display.
display_associated_geometry_fe=<value>
Display associated geometry and FE on show, hide, and isolate.
0 - Off
1 - On
display_color-<item>=<value>
The color for various objects. Valid values are 1-64. A value of 0 indicates to set the color of that object to the background color value.
The item modifier is required and specifies a specific item:
  • 1 - Free edges
  • 2 - Shared edges
  • 3 - Suppressed edges
  • 4 - Non-manifold edges
  • 5 - Global coordinate axis labels
  • 6 - Fin faces on solids
  • 7 - Bounding faces on solids
  • 8 - Full partition faces on solids
  • 9 - 2D topology faces
  • 10 - Component edges
  • 12 - Ignored topology faces
  • 13 - Elements no props/mats
  • 14 - Ignored solid mappable
  • 15 - Not solid mappable
  • 16 - 1 directional solid mappable
  • 17 - 3 directional solid mappable
  • 18 - Global X axis
  • 19 - Global Y axis
  • 20 - Global Z axis
display_import_errors=<value>
Defines whether the import process errors/warnings are displayed in a Tcl window in HyperMesh.
0 - Import process errors/warnings will not be displayed
1 - Import process errors/warnings will be displayed.
duplicate_ids=<value>
Defines whether duplicate entity IDs are allowed for supported solvers.
0 - Duplicate IDs are not allowed
1 - Duplicate IDs are allowed
dynamic_center_of_rotation=<value>
Dynamic center during model rotation. values are 1 or 0.
edge_lod_threshold=<value>
The zoom level required to make geometry lines visible, as an integer value from 0-10. 0 means geometry lines are always visible. Smaller values indicate minimal zoom is needed. Higher values mean more zoom is needed.
edge_lod_width_auto=<value>
Defines whether to enable edge LOD auto mode.
0 - Auto mode disabled
1 - Auto mode enabled
elem_sphere_radius=<value>
Controls the radius of 1D element sphere visualization (default 1.0).
element_color_mode=<value>
The element color mode value:
1 - By component
2 - By property
3 - By material
4 - By thickness
5 - 1D/2D/3D
6 - By config
7 - By assembly
8 - By body
9 - By 2D element quality criteria
10 - By thickness difference
11 - Reserved for future use
12 - Reserved for future use
13 - By domain
14 - Reserved for future use
15 - Reserved for future use
16 - By part
17 - By topology
18 - By 3D topology
19 - By mappable
20 - By 3D element quality criteria
21 - By 2D element quality QI
22 - Reserved for future use
23 - By subsystem
element_connectivity=<value>
Select how newly created elements and any adjacent existing elements are connected.
Valid values are Previous, Break, Keep, and Redo.
element_handle=<value>
The display of element handles.
0 - Off
1 - On
element_internal_edges_mode=<value>
The element internal edges visualization mode. This only applies to the two wireframe modes supported by *setdisplayattributes/*setmarkdisplayattributes.
0 - Do not visualize internal element edges
1 - Visualize internal element edges
element_order=<value>
The order of newly created elements.
1 - First
2 - Second
element_organization=<value>
Select in which component the newly created elements are placed.
Valid values are "Current component" and "Surface component".
element_size=<value>
The default element size to use when calculating element densities in the auto-meshing module.
element_window_selection_mode=<value>
all - All nodes of an element must be inside the window to be selected
any - Any node of an element must be inside the window to be selected
centroid - The centroid of an element must be inside the window to be selected
entity_highlighting=<value>
The mode for pre-highlighting selected entities.
0 - Do not pre-highlight. This may improve script performance.
1 - Pre-highlight
equation_handle=<value>
The display of equation handles.
0 - Off
1 - On
exponential_display=<value>
The display of floating-point numbers in the menu as standard or exponential.
0 - Standard
1 - Exponential
feature_angle=<value>
The feature angle used for mesh creation and editing operations.
fe_display=<value>
0 - Turns off FE display without changing the state of components.
1 - Turns on FE display without changing the state of components.
fe_geom_dupl=<value>
Option to duplicate FE geometry when copying associated mesh. Valid values are 1 and 0. If the option is enabled, FE geometry is created when copying associated mesh or else orphan mesh is created. Orphan mesh is always created for orphan mesh and FE geometry is always created for FE geometry.
feoutput_time_info=<value>
Generates a text file containing export time info for FE entities. The file is written to the same directory as the exported file, with the name <export_file_name>_timing.txt.
0 - Do not write file
1 - Write file
fixed_point_handle=<value>
The display of fixed point handles.
0 - Off
1 - On
force_text_black=<value>
The display of graphical text between black and white. By default, text in HyperMesh is displayed in white. However white text is not always legible, especially when users change the background color to a lighter color.
0 - White
Non-zero - Black
front_face_orientation_view_cube=<value>
The view cube front face orientation:
0 - XZ
1 - ZX
2 - YZ
3 - ZY
4 - XZ
5 - ZX
6 - YZ
7 - ZY
8 - XY
9 - XY
10 - YX
11 - YX
g_ce_aspect_ratio_option=<value>
Fail hexa seam or area connectors based on aspect ratio check.
0 - Off
1 - On
g_ce_aspect_ratio_value=<value>
The minimum aspect ratio value to fail hexas.
g_ce_autocreate_attachments=<value>
Auto-create attachments during bolt connector realization.
0 - Off
1 - On
g_ce_autocreate_parts=<value>
Create parts during automatic organization of realized connector entities.
0 - Off
1 - On
g_ce_auto_load_control=<value>
Automatically load a connector control file.
0 - Off
1 - On
g_ce_bl_connection_angle=<value>
The maximum angle allowed between two shells for a B connection.
g_ce_boltcylinderdisplaystatus=<value>
Show cylinder bolts.
0 - Off
1 - On
g_ce_boltcylinderdisplaytransparency=<value>
The level of transparency for cylinder bolts.
g_ce_colorby=<value>
Defines the connector color scheme.
0 – By state
1 – By connector group
2 – By layer
3 – By style
g_ce_consider_custom_metadata_mapping=<value>
Consider custom metadata mapping file during connector creation using geometry extraction.
0 - Off
1 - On
g_ce_consider_link_for_review=<value>
Perform SHII operations on link entities.
0 - Off
1 - On
g_ce_considerboltcolinearity=<value>
Perform collinearity check during bolt connector realization.
0 - Off
1 - On
g_ce_control_config=<value>
Use a connector control config to identify redundant connector control entities.
0 - Off
1 - On
g_ce_control_file_path=<value>
The connector control file path name.
g_ce_control_id=<value>
Use the connector control ID to identify redundant connector control entities.
0 - Off
1 - On
g_ce_control_keep=<value>
The method of handling redundant connector control entities. Valid values are:
“Keep both”
“Keep incoming attributes”
“Keep existing attributes”
g_ce_control_name=<value>
Use the connector control name to identify redundant connector control entities.
0 - Off
1 - On
g_ce_custom_metadata_file_path=<value>
Absolute file path to the metadata mapping file containing connector metadata name mapped to CAD metadata name.
g_ce_Cwelddisplaystatus=<value>
Show a graphical representation of the CWELD definition.
0 - Off
1 - On
g_ce_elem_org_comp_id=<value>
The component ID for the organization of realized connector entities.
g_ce_elem_org_option=<value>
The organize options for realized connector entities. Valid values are:
0 – Current component
1 – Connector group
2 – Automatic
3 – Component ID
4 – Current include
g_ce_equia_skew_option=<value>
Fail hexa seam or area connectors based on equia skew check.
0 – Off
1 – On
g_ce_equia_skew_value=<value>
The minimum equia skew value to fail hexas.
g_ce_jacobian_option=<value>
Fail hexa seam or area connectors based on equia jacobian check.
0 – Off
1 – On
g_ce_jacobian_value=<value>
The maximum jacobian value to fail hexas.
g_ce_line_vertex_angle=<value>
The line vertex angle for significant points.
g_ce_linked_connector=<value>
Consider connector/attachment during connector/attachment link SHII operations.
0 – Off
1 – On
g_ce_linked_entity=<value>
Consider link entities during connector/attachment SHII operations.
0 – Off
1 – On
g_ce_long_weld_length=<value>
The upper bound tolerance allowed by the weld length.
g_ce_lt_connection_angle=<value>
The minimum angle allowed between two shells for a T connection.
g_ce_realization_connector=<value>
Consider realized FE entities during connector/attachment SHII operations.
0 – Off
1 – On
g_ce_realization_link=<value>
Consider realized FE entities during connector/attachment Link SHII operations.
0 – Off
1 – On
g_ce_se_auto_register=<value>
Automatically register shared connector entities during connector realization, feabsorb, and import.
0 – Off
1 – On
g_ce_se_cleanup_delete=<value>
Clean-up shared connector entities during deletion.
0 – Off
1 – On
g_ce_se_cleanup_unrealize=<value>
Clean-up shared connector entities during unrealization.
0 – Off
1 – On
g_ce_shell_thickness_off_for_solids=<value>
Use linked FE attributes when positioning realized solids.
0 – Off
1 – On
g_ce_short_weld_length=<value>
The lower bound tolerance allowed by weld length.
g_ce_size=<value>
The connector display size in model units.
g_ce_subsystem_org_option=<value>
Organize connector realization entities into subsystems. Valid values are:
1 – Paired
2 – Single
g_ce_warpage_option=<value>
Fail hexa seam or area connectors based on warpage check.
0 – Off
1 – On
g_ce_warpage_value=<value>
The minimum warpage value to fail hexas.
g_ce_weld_database_file_path=<value>
The path to a local weld database file which specifies the details of the welds.
geom_display=<value>
0 - Turns off geometry display without changing the state of components.
1 - Turns on geometry display without changing the state of components.
geom_feature_angle=<value>
The geometry feature angle used for geometry creation and editing operations.
geom_point_size=<value>
Sets the size of the geometry points, between 1 and 10 (default 4).
geom_refine_level=<value>
The refinement level for geometry graphical faceting. Valid values are 1-5 and 11 (which indicates auto refinement). Each level increases the refinement, but also uses more memory and takes more time to compute.
geom_stitching=<value>
The automatic stitching mode when creating surfaces. This applies to all surface creation commands.
0 - Created surfaces are stitched to surfaces from the same component
1 - Created surfaces are stitched to any surfaces that are within geometry cleanup tolerance
2 - Created surfaces are stitched to surfaces attached to selected surfaces/edges
3 - Created surfaces are stitched only to selected surfaces or surfaces that have edges/vertices selected
geometry_parasolid_boolean=<value>
0 - Boolean operations will use the legacy AFC (default)
1 - Boolean operations will use Parasolid (not tested or recommended for use with panels)
geometry_parasolid_removefillets =<value>
0 – Fillet removal operations use the legacy AFC (default)
1 – Fillet removal operations use Parasolid
geometry_style_view_cube=<value>
Geometry of the view cube.
0 - Chamfered cube (26 faces) (default)
1 - Simple cube (6 faces)
graph_enable=<value>
The visibility of plot entities in graphics.
0 - Hide plot entities in graphics.
1 - Show plot entities in graphics.
graphics_file_blank_background=<value>
The graphics file image background color mode.
0 - Use the graphics window background color for the image
Non-zero - Use a blank (white) background color for the image
graphics_optimize_view_ctrl=<value>
0 - Do not remove graphical annotations and entities when you rotate, zoom (via the mouse wheel), or pan the model.
1 - Remove graphical annotations and entities when you rotate, zoom (via the mouse wheel), or pan the model. Graphical annotations and entities are restored once you release the mouse button.
graphics_simplification_component=<value>
The graphics simplification component.
0 - Do not simplify the current component
1 - Simplify the current component
graphics_simplification_mode={<mode> <style>}
The graphics simplification mode. This produces smoother animation when rotating or panning a model by refraining from calculating and rendering some model elements until the model manipulation stops.
mode values:
  • 0 - None
  • 1 - Automatic
  • 2 - Ctrl-Shift
style values:
  • 0 - No simplification
  • 1 - Feature lines (default)
  • 2 - Bounding box
  • 3 - Node cloud
  • 4 - Element centroid
  • 5 - Simplified shading
green_auto_color_range_max=<value>
The maximum value of the green color range for auto coloring. Valid values are 0-255 (default 200).
green_auto_color_range_min=<value>
The minimum value of the green color range for auto coloring. Valid values are 0-255 (default 40).
highlight-<option>=<value>
Sets various highlight options. The option modifier is required and specifies a specific highlight type.
  • edge_thickness - The thickness of feature edge highlight (default 2.0).
  • face_alpha - A value between 0 and 1 (default 0.5)
  • face_color - The RGB highlight face color (default #FEB317) .
  • onoff - The transparent highlight, 0 (off, default) or 1 (on).
history_memory_limit=<value>
The amount of memory to allow for undo-redo.
hv_launch_flag=<value>
Controls the launching of HyperView after an H3D creation.
0 - Disable HyperView launch
1 - Enable HyperView launch
intell_max_name=<value>
Maximum number of suggestions to be shown for name in IntelliSearch.
intell_max_id=<value>
Maximum number of suggestions to be shown for ID in IntelliSearch.
intell_exact_match=<value>
Match exact phrase while searching for names in IntelliSearch.
0 - Off
1 – On
last_simulation_current=<value>
Set the last simulation step as current after loading the results.
0 - Off
1 - On
left_justify_num_fields=<value>
Left justify numeric values in Entity Editor.
0 - Off
1 – On
legend_allow_background_transparency=<value>
0 - Do not allow
1 - Allow
legend_beyond_threshold=<value>
The visualization for elements beyond the legend threshold.
0 - Off
1 - Transparent
2 - Feature lines
legend_colormap_divergent=<value>
0 - Disable legend divergent colormap style (use rainbow style)
1 - Enable legend divergent colormap style
legend_ranged_discrete_button=<value>
Controls the legend double button.
0 - Off
1 - On
lighting_mode=<value>
The lighting mode.
0 - 1 light (legacy)
2 - 2 light
line_handle=<value>
The display of line handles.
0 - Off
1 - On
lmb_rmb_binding=<value>
Select action for left + right mouse button drag.
Valid values are Pan, Rotate, Zoom and CircleZoom.
load_base_size=<value>
Change the base size of loads.
load_handle=<value>
The display of load handles.
0 - Off
1 - On
load_label-<config>=<value>
The display of load labels.
0 - Off
1 - On
The config modifier is required and specifies a specific load config. Currently all config values besides 3 are linked together.
  • 1 - Forces
  • 2 - Moments
  • 3 - Constraints
  • 4 - Pressures
  • 5 - Temperatures
  • 6 - Fluxes
  • 8 - Velocities
  • 9 - Accelerations
load_label_color=<value>
The load label color. Valid values are 1-64. A value of 0 indicates to set the color to the background color value.
load_max_size=<value>
Change the maximum size of loads.
load_min_size=<value>
Change the minimum size of loads.
load_new_scaling=<value>
Set new scaling options
Valid values are New and Legacy.
load_scale_type=<value>
Set scale type fixed or limits on load entities.
Valid values are Limits and Fixed.
load_size_magnitude-<config>=<value>
The load display percentage when load_size_type is 1.
The config modifier is required and specifies a specific load config. Currently all config values are linked together.
  • 1 - Forces
  • 2 - Moments
  • 4 - Pressures
  • 5 - Temperatures
  • 6 - Fluxes
  • 8 - Velocities
  • 9 - Accelerations
load_size_type-<config>=<value>
0 - Uniform display
1 - Magnitude display
The config modifier is required and specifies a specific load config. Currently all config values are linked together.
  • 1 - Forces
  • 2 - Moments
  • 4 - Pressures
  • 5 - Temperatures
  • 6 - Fluxes
  • 8 - Velocities
  • 9 - Accelerations
load_size_uniform-<config>=<value>
The load display size in model units when load_size_type is 0.
The config modifier is required and specifies a specific load config. Currently all config values besides 3 are linked together.
  • 1 - Forces
  • 2 - Moments
  • 3 - Constraints
  • 4 - Pressures
  • 5 - Temperatures
  • 6 - Fluxes
  • 8 - Velocities
  • 9 - Accelerations
load_solver_label=<value>
The label type for elements and loads.
0 - HyperMesh labels
1 - Template labels
load_visual_vector=<value>
The location of the vector in relation to the attachment location.
0 - Tip
1 - Tail
locate_view_cube=<value>
The position of the view cube when show_view_cube=1 or show_view_cube=2. Valid values are:
0 - Cube is displayed to the lower left (default)
1 - Cube is displayed to the lower right
2 - Cube is displayed to the upper left
3 - Cube is displayed to the upper right
lod_threshold=<value>
The zoom level required to make element handles visible, as an integer value from 0-10. 0 means element handles are always visible. Smaller values indicate minimal zoom is needed. Higher values mean more zoom is needed.
mb_ask_delete_table_on_exit=<value>
Prompt the user to delete existing Matrix Browser tables upon closing Matrix Browser.
0 – Off
1 – On
mb_color=<value>
The highlight color of the entity column in Matrix Browser. Valid values are 1-64.
mb_csv_separator=<value>
The separator character used in the CSV file exported from Matrix Browser.
0 – Comma (default)
1 – Space
2 – Semicolon
3 – Forward slash
mb_display_expression=<value>
Show the expressions instead of values in Matrix Browser.
0 – Off
1 – On
mb_numeric_format=<value>
The numeric format of result values queried in Matrix Browser.
0 – Scientific (default)
1 – Fixed
mb_numeric_precision=<value>
An integer to define the number of decimal places in result values queried in Matrix Browser.
mb_query_id_order=<value>
The order of the queried entity IDs returned in the entity column in Matrix Browser.
0 – Default, based on the order returned by the hm_getmark command
1 – Increasing
2 – Decreasing
mb_show_subcase_simulation_in_col_header=<value>
Include the subcase and simulation name in the result column label in Matrix Browser.
0 – Off
1 – On
mb_update_hm_on_table_cell_edit=<value>
Automatic update of HyperMesh database upon editing queried data name values in Matrix Browserr.
0 – Off
1 – On
mb_userdir_path=<value>
The Matrix Browser user directory path.
mb_visible_rows=<value>
The number of rows initially visible in the Matrix Browser table.
mesh_line_color=<value>
The mesh line color. Valid values are 1-64.
mesh_lod_threshold=<value>
The zoom level required to make element mesh lines visible, as an integer value from 0-10 (default 6.5). 0 means mesh lines are always visible. Smaller values indicate minimal zoom is needed. Higher values mean more zoom is needed.
mesh_transparency=<value>
The mesh transparency as a double value from 0-10. 0 means no transparency. Smaller values indicate minimal transparency. Higher values mean more transparency.
method_xml_file=<value>
The user defined StressToolMethodDefinition.xml file path to access the user defined design methods.
mixed_property_warning=<value>
The state of the mixed direct/indirect property assignment warning dialog.
0 - Do not show the warning when mixing direct/indirect property assignments.
1 - Show the warning when mixing direct/indirect property assignments.
mmb_binding=<value>
Select action for middle mouse button drag.
Valid values are Pan, Rotate, Zoom and CircleZoom.
morph_1d_domain_method=<value>
The method used to determine the relationship between 1D domains and their surrounding domains. Valid values are:
Independent
Secondary
Main
Cluster
morph_2d_domain_color=<value>
The color used for all 2D domains. Valid values are 1-64.
morph_3d_domain_color=<value>
The color used for all 3D domains. Valid values are 1-64.
morph_autofix_squashed_domains=<value>
Automatically invoke the large domain solver to unfold small domains which became folded during morphing. Valid values are:
Off
On release
Real time
morph_biasing_style=<value>
The style of biasing exerted by handles over their nodes. Valid values are:
Exponential
Sinusoidal
morph_check_neg_jacobians=<value>
Check for negative Jacobians after each morph. Valid values are 0 and 1.
morph_cluster_mode=<value>
The method for morphing connectors, clusters (1D domains and morphconstraints), and equations. Valid values are:
Use doms/mvols
All as clusters
All stretchable
Morph by type
Fix equations
Free equations
morph_cluster_rotation=<value>
The type of rotation to apply to connectors, clusters (1D domains and morphconstraints), and equations during morphing. Valid values are:
None
Tilt
Spin
Full
morph_cluster_stretch=<value>
Use the large domain solver to smooth over distortions in the mesh around clusters during morphing. Valid values are 0 and 1.
morph_color-<option>=<value>
Sets various morph color options. The option modifier is required and specifies a specific morph color object.
  • domain - The domain RGB color.
  • face - The face RGB color.
  • symmetry - The symmetry RGB color.
  • volume - The morph volume RGB color.
morph_constraint_size=<value>
The display size of morphing constraints in model units or screen units.
morph_constraint_size_mode=<value>
The type of units used for morph constraint size. Valid values are:
Screen units
Model units
morph_edge_domain_color=<value>
The color used for all edge domains. Valid values are 1-64.
morph_element_midnodes=<value>
The method for adjusting element midnodes during morphing.
No correction
Force midpoint
Hold current
Curve edge domains
Curve 2D domains
morph_faces_color=<value>
The color used for shell elements created on 3D domains. Valid values are 1-64.
morph_global_influence_method=<value>
Defines how global handles and morphvolumes influence nodes.
Direct
Hierarchical
Mixed method
morph_global_influence_solver=<value>
The solver used for global domains.
Kriging
Geometric
Spatial
morph_handle_size=<value>
The display size of morphing handles in model units.
morph_handle_tolerance=<value>
The tolerance factor used for symmetry linking, for example. Must be less than morph_handle_size/10.
morph_kriging_covariance=<value>
The covariance value used for Kriging algorithm. Valid values are:
h
h^2 log(h)
h^3
exp(-1/x)
morph_kriging_drift=<value>
The drift value used for Kriging algorithm. Valid values are:
No drift
Constant
Linear
Quadratic
Cubic
Trigonometric
morph_kriging_finish=<value>
Returns true if manual Kriging can be finished. Set to true to finish any manual Kriging that has been applied since starting.
morph_kriging_global_domains=<value>
Apply Kriging to all global domains. Valid values are 0 and 1.
morph_kriging_local_domains=<value>
Apply Kriging to all local domains. Valid values are 0 and 1.
morph_kriging_mode=<value>
Defines when the Kriging solver runs. Valid values are:
Off
Manual
Automatic
morph_kriging_morphvolumes=<value>
Apply Kriging to all morph volumes. Valid values are 0 and 1.
morph_kriging_nugget_option=<value>
Use nugget value during Kriging. Valid values are 0 and 1.
morph_kriging_nugget_value=<value>
The nugget value used for Kriging.
morph_kriging_resume=<value>
Returns true if manual Kriging can be resumed. Set to true to resume any manual Kriging that has been finished.
morph_kriging_start=<value>
Returns true if manual Kriging can be started. Set to true to start manual Kriging.
morph_large_domain_mode=<value>
Defines when the large domain solver runs. Valid values are:
Manual
On release
Real time
morph_large_domain_size=<value>
The smallest number of elements in a domain for it to be considered a large domain.
morph_large_domain_solve=<value>
Always returns true. Set to true to solve large domains when in manual mode.
morph_large_domain_unfold=<value>
Defines whether the large domain solver runs when the mesh gets folded. Valid values are:
Never unfold
Ask to unfold
Always unfold
morph_min_handle_influence=<value>
The minimum value of influence between handles and nodes. Valid values are between 0 and 1.
morph_min_step_size_angle=<value>
The step size (in degrees) used for angle changes when rotating manipulators.
morph_min_step_size_dist=<value>
The step size (in model units) used for distance changes when dragging manipulators.
morph_morphing_system=<value>
The ID of system used for morphing. Use 0 for the global system.
morph_morphvolumes_color=<value>
The color used for all morph volumes. Valid values are 1-64.
morph_morphvolumes_connector_mode=<value>
Defines which connectors get registered to morphvolumes during creation and after adjustment. Valid values are:
None
Displayed
All
morph_morphvolumes_connector_realize=<value>
The treatment of registered connectors during morphing. Valid values are:
Maintain
Unrealize
Unrealize + Rerealize
morph_morphvolumes_edge_continuity_adjust=<value>
Defines whether the initial continuity between linked edges is maintained or reset during adjustment. Valid values are:
Maintain
Reset
morph_morphvolumes_edge_continuity_morph=<value>
Defines whether the initial continuity between linked edges is maintained or reset during morphing. Valid values are:
Maintain
Reset
morph_morphvolumes_edge_method=<value>
The method used to calculate the curvature of the morphvolume edges. Valid values are:
Lagrange
Spline
morph_morphvolumes_edge_points=<value>
The number of points used by each morph volume edge to represent curves
morph_morphvolumes_mode=<value>
Defines whether the entities registered to morphvolumes are morphed or only the morphvolumes are adjusted. Valid values are:
Adjust
Morph
morph_morphvolumes_skin_only=<value>
If 1, only the nodes and the skin of registered meshes will be morphed until this option is set to 0 or morph_morphvolumes_mode is changed, at which point the interior will be morphed. Valid values are 0 and 1.
morph_morphvolumes_tolerance=<value>
The mapping tolerance. The accuracy increases as the tolerance decreases. Valid values are between 0 and 1.
morph_morphvolumes_transparency=<value>
The level of transparency to display faces of morph volumes. Valid values are:
Wireframe
Light tint
Medium tint
Heavy tint
Opaque
morph_multithread=<value>
The preferred computation method for the morphing library. Valid values are:
Library – off
Single CPU
Multithread
GPU
morph_other_domain_color=<value>
The color used for all general, 1D, and global domains. Valid values are 1-64.
morph_partitioning_add_geometry=<value>
Merge partitioned domains and those created from geometry (where applicable). Valid values are 0 and 1.
morph_partitioning_curve_tolerance=<value>
The tolerance value (in degrees) for curvature changes which determine partition lines.
morph_partitioning_domain_angle=<value>
The break angle (in degrees) for determining partition lines.
morph_partitioning_inside_3d=<value>
Enables the partition faces inside solid meshes. Valid values are 0 and 1.
morph_partitioning_method_quads=<value>
The method used to partition predominantly quad meshes. Valid values are:
Element based
Node based
morph_partitioning_method_trias=<value>
The method used to partition predominantly tria meshes. Valid values are:
Element based
Node based
morph_partitioning_order=<value>
The order of partitioning.
First – Use break angles.
Second – Use break angles and curvature changes.
morph_partitioning_use_geometry=<value>
Enables partitioning along surface edges of associated geometry. Valid values are 0 and 1.
morph_quality_color_plotting=<value>
0 - Plot element quality as pass or fail
1 - Plot element quality with color bands
morph_quality_limit=<value>
The threshold value for element quality.
morph_quality_mode=<value>
The element quality check to be displayed after each morph. Valid values are Off, Max. 1D Length, Min. 1D Length, 2D Warpage, 2D Skew, 2D Aspect Ratio, Max. 2D Length, Min. 2D Length, 2D Jacobian, 2D Chordal Deviation, Max. 2D Quad Angle, Min. 2D Quad Angle, Max. 2D Tria Angle, Min. 2D Tria Angle, 2D Equia Skew, 2D Squish, 2D Taper, 3D Warpage, 3D Aspect Ratio, Tetra Aspect Ratio, 3D skew, 3D Volumetric Skew, Max. 3D Length, Min. 3D Length, 3D Jacobian, Tetra Collapse, Max. 3D Quad Angle, Min. 3D Quad Angle, Max. 3D Tria Angle, Min. 3D Tria Angle, 3D Squish, 3D Equia Skew, 3D Orthogonality, 3D Size Ratio, Time Step, and Quality Index.
morph_remeshing_edge_mode=<value>
Defines whether to keep the nodes along edges or remesh them to a new distribution. Valid values are:
Keep nodes
Remesh
morph_remeshing_element_size=<value>
The preferred element size when remeshing.
morph_remeshing_interval=<value>
Defines whether to remesh all morphed elements since the last remesh or just those for the most recent morph. Valid values are:
Since last remesh
Current morph
morph_remeshing_mesh_type=<value>
The mesh type for remeshing. Valid values are:
Trias
Quads
Mixed
R-trias
Quads only
morph_remeshing_mode=<value>
Defines when remeshing after morphing occurs. Valid values are:
Off
Manual
After failed QA
After each morph
morph_remeshing_preserved_shapes=<value>
Enables conversion of handle-based shapes in remeshed area to node-based shapes. Valid values are 0 and 1.
morph_remeshing_qa_fail_pct=<value>
The threshold at which the percentage of elements failing the quality check triggers a remesh. Valid values are between 0 and 100.
morph_remeshing_remesh=<value>
Returns true if remeshing can be performed. Set to true to manually remesh.
morph_remeshing_remesh_3D=<value>
Enable remeshing 3D domains as tetras and pyramids. Valid values are 0 and 1.
morph_remeshing_size_control=<value>
Enabled bias toward similar element size during remeshing. Valid values are 0 and 1.
morph_remeshing_size_mode=<value>
The mode for target size. Valid values are:
Average elements
Use criteria size
Set value
morph_remeshing_skew_control=<value>
Enables bias toward minimizing skew during remeshing. Valid values are 0 and 1.
morph_remeshing_style=<value>
Defines whether the morphed mesh is remeshed or rebuilt. Valid values are:
Remesh
Rebuild
morph_remeshing_zone=<value>
Defines how much of the morphed mesh to remesh. Valid values are:
All morphed elems
Only failed elements
Failed elements + 1 row
Failed elements + 2 rows
Failed elements + 3 rows
morph_results_component=<value>
The component to be plotted. Valid values are:
Magnitude
x comp
y comp
z comp
morph_results_datatype=<value>
The FEA results datatype to be displayed during results plotting. The string must match one of the datatypes available in the results file.
morph_results_datatype_values=<value>
Return all available datatypes in the results file.
morph_results_info_titles=<value>
Display the information title during results plotting. Valid values are 0 and 1.
morph_results_max_option=<value>
Defines whether the maximum plot value is calculated automatically or set manually. Valid values are:
Automatic
User defined
morph_results_max_value=<value>
The maximum plot value.
morph_results_mesh_color=<value>
The color of mesh during results plotting. Valid values are 0-64.
morph_results_min_max_titles=<value>
Display the minimum and maximum titles during results plotting. Valid values are 0 and 1.
morph_results_min_option=<value>
Defines whether the minimum plot value is calculated automatically or set manually. Valid values are:
Automatic
User defined
morph_results_min_value=<value>
The minimum plot value.
morph_results_mode=<value>
Defines when to display FEA results after morphing. Valid values are:
Off
Manual
On release
Real time
morph_results_plot=<value>
Always returns true. Set to true to plot the results of a previously run FE analysis.
morph_results_plot_style=<value>
The FEA results plotting style. Valid values are:
Assign plot
Contour plot
morph_results_refresh=<value>
Always returns true. Set to true to trigger HyperMorph to write out a new solver file.
morph_results_simulation=<value>
The FEA results simulation to display during results plotting. The string must match one of the simulations available in the results file.
morph_results_simulation_values=<value>
Return all available simulations in the results file.
morph_results_solve=<value>
Always returns true. Set to true to run FE analysis on the mesh and plot the results.
morph_results_solver_type=<value>
The solver used for FEA results. Valid values are:
Linear static
Nonlinear explicit
Stamping 1-step
Stamping incr
morph_results_stamping_direction_x=<value>
The x component of the vector defining the stamping direction.
morph_results_stamping_direction_y=<value>
The y component of the vector defining the stamping direction.
morph_results_stamping_direction_z=<value>
The z component of the vector defining the stamping direction.
morph_save_morphs=<value>
Save the list of morphs along with the HyperMesh binary file. Valid values are 0 and 1.
morph_show_domain_icons=<value>
Show icons at the centroids of domains. Valid values are 0 and 1.
morph_small_domain_mode=<value>
Defines when the small domain solver runs. Valid values are:
Manual
On release
Real time
morph_small_domain_properties=<value>
The properties used when running the FEA solver. Valid values are:
Automatic
User defined
morph_small_domain_size=<value>
The number of elements at or below which a domain is considered a small domain.
morph_small_domain_solve=<value>
Always returns true. Set to true to solve small domains manually.
morph_small_domain_solver=<value>
The solver used for small domains. Valid values are:
Standard
Kriging
Linear static
Nonlinear explicit
morph_smoothing_iterations=<value>
The number of smoothing iterations.
morph_smoothing_mode=<value>
Defines when smoothing after morphing occurs. Valid values are:
Real time
On release
morph_smoothing_type=<value>
The type of smoothing applied after morphing. Valid values are:
Off
Autoselect
Size corrected
Shape corrected
Angle corrected
Kriging
QI optimized
Kriging + autoselect
Kriging + size corrected
Kriging + shape corrected
Kriging + angle corrected
Kriging + QI optimized
Unsquish – fast
Unsquish – even
Unsquish – best
morph_symmetry_color=<value>
The color used for all symmetries. Valid values are 1-64.
morph_symmetry_size=<value>
The display size of morphing symmetries in model units.
morph_use_constraints=<value>
Use all active constraints when morphing. Valid values are 0 and 1.
morph_use_symmetry_links=<value>
Apply handle morphing to other handles linked by active symmetries. Valid values are 0 and 1.
mouse_append_mode=<value>
Always add to the current selection in idle mode without holding Ctrl.
Valid values are 1 and 0.
mouse_mapping=<value>
Set current mouse controls.
Valid values are HyperWorks and Legacy.
mouse_over_highlighting=<value>
Highlight entities on mouse hover.
Valid values are 1 and 0.
nearby_output_entities=<types>
Sets the nearby output entity types. Valid values are components, elements, equations, loads, systems and vectors.
nearby_radius=<value>
Sets the nearby search radius/tolerance.
nearby_search_method=<value>
Sets the nearby search method. Valid values are sphere and box.
nearby_selected_operation=<value>
Sets the nearby selection operation. Valid values are 0 (show) and 1 (isolate).
nodelod=<value>
0 - Disable node level-of-detailing
1 - Enable node level-of-detailing
node_size=<value>
Sets the size of the nodes, between 1 and 10 (default 6).
node_tolerance=<value>
The global node tolerance. Must be greater than cleanup_tolerance/100.
num_history_steps=<value>
The maximum number of undo-redo steps to store in memory.
numeric_legend_force_ranged=<value>
0 - Discrete legend
1 - Ranged legend
numeric_legend_threshold=<value>
The threshold value for automatic switching from discrete to ranged.
numeric_precision=<value>
An integer to define the number of decimal places in numerical values.
numeric_style=<value>
The style of numerical values.
0 - Auto
1 - Fixed
2 - Scientific
number_remesh_layers=<value>
Number of layers for advanced remesh.
pdm_check_latest_partrev=<value>
Check for the latest part revision.
0 – Off
1 - On
pdm_check_latest_partrev_interval=<value>
The time interval to check for the latest part revision.
performance_normal=<value>
The light setting, based on the direction of element normals.
0 - Flat, each face has a normal
1 - Smooth, vertices have normals
perspective_fov=<value>
The perspective field of view.
perspective_view=<value>
The state of the perspective view.
0 - Off
1 - On
pick_tolerance=<value>
The picking tolerance in pixels which the cursor must be within before an entity is selected.
ply_link_color_and_orientation=<value>
Auto update of colors based on ply orientation.
Valid values are 1 and 0.
ply_thickness_factor=<value>
The ply thickness scale factor for composite layer visualization. This applies for show_composite_layers values 1 and 2.
pr_auto_preserve_connections=<value>
1 - Preserve the internal connections.
0 - Do not preserve the internal connections (default).
pr_box_approach_node_set=<value>
0 - Proximity approach will be used to find the replacement nodes to update the SETS of type NODES. (default).
1 - Bounding box approach will be used to find the replacement nodes to update the SETS of type NODES. All the nodes of an element will be used to update the SETS of type NODES or none of it.
pr_check_log=<value>
0 - Do not allow the user to provide a file path to log replacement details. (default 0)
1 - Allow the user to provide a file path to log replacement details.
pr_custom_bbox_for_equivalence=<value>
Custom tolerance for bounding box can be provided for connecting the 1D elements from incoming file to source components
0 - Use default tolerance.
1 - Use custom tolerance (default).
pr_delete_src_comp=<value>
0 - Delete existing component.
1 - Do not delete existing component. Both existing and incoming component(s) will remain in session after replacement (default).
pr_invoke_model_checker=<value>
0 - Do not invoke a Model Checker Browser (default).
1 - Invokes a Model Checker Browser after replacement.
This option is not available for single component replacement.
pr_keep_src_comp_cardimage=<value>
0 - Do not copy existing component card image to incoming component.
1 - Copy existing component card image to incoming component (default).
pr_keep_src_comp_id=<value>
0 - Do not assign existing component ID to incoming component.
1 - Assign existing component ID to incoming component (default).
pr_keep_src_comp_name=<value>
0 - Do not assign existing component Name to incoming component.
1 - Assign existing component Name to incoming component (default).
pr_keep_src_ent_type=<value>
0 - Do not assign existing component element type to incoming component element type (default).
1 - Assign existing component element type to incoming component element type.
pr_keep_src_include=<value>
0 - Organize incoming entities to new include.
1 - Organize incoming entities to existing component include (default).
pr_keep_src_mat=<value>
0 - Do not assign existing component material to incoming component.
1 - Assign existing component material to incoming component (default).
pr_keep_src_prop=<value>
0 - Do not assign the existing component material/property to incoming component.
1 - Assign existing the component material/property to incoming component (default).
pr_merge_nodes=<value>
0 - Do not merge the nodes present on the boundaries of incoming component (default).
1 - Merge the nodes present on the boundaries of incoming component.
pr_prefix_basename_suffix_based_name_pairing=<value>
Controls whether component pairing should be done using prefix-basename-suffix matching approach. Valid values are:
0 – Do not use prefix-basename-suffix approach to find the component pairing
1 - Use prefix-basename-suffix approach first to find the component pairing
pr_retain_plotel_elem_nodeIds_from_src_comp=<value>
The node IDs of the source component can be retained if its nodes have comments.
It is available only for OptiStruct and Nastran.
0 - Do not retain the node ids of source component. (default 0)
1 - Retain the node ids of source component.
pr_show_component_pairing=<value>
0 - Do not show component pairing (default ).
1 - Show component pairing.
quick_topo_selection=<value>
Controls holding the Alt key to enable quick advanced selection for faces and edges (elements) and by path (lines and nodes).
0 - Disable
1 - Enable
rbody_label=<value>
The display of rigid body labels.
0 – Off
1 – On
rdata_memory_clean=<value>
Clean results memory cache after running Results Query.
0 – Off
1 – On
realize_loads=<value>
Realize loads to their engineering form at the time of model load.
It is available only for OptiStruct and Nastran.
0 - Unrealize (default, classical loads are created)
1 - Realize (engineering loads are created after model load)
red_auto_color_range_max=<value>
The maximum value of the red color range for auto coloring. Valid values are 0-255 (default 200).
red_auto_color_range_min=<value>
The minimum value of the red color range for auto coloring. Valid values are 0-255 (default 40).
reflector_show_view_cube=<value>
The visibility of the reflector's view cube.
0 - Never (default)
1 - On mouse over
2 - Always
retain_element_values=<value>
Keep/delete certain element values upon mesh edit or remesh.
0 - Delete (legacy behavior)
1 - Keep
retain_loads=<value>
Keep/delete loads when associated nodes/elements are deleted.
0 - Delete
1 - Keep
retain_segments=<value>
Retain segments upon mesh change.
0 - Off
1 - On
reverse_zoom_direction=<value>
Reverse scroll wheel direction.
Valid values are 1 and 0.
rmb_binding=<value>
Select action for right mouse button drag.
Valid values are Pan Rotate Zoom CircleZoom.
rotation_angle=<value>
The rotation angle used by various view commands.
rotation_center_mode=<value>
The rotation mode.
0 - Rotate about center of model
1 - Rotate about center of screen (legacy behavior)
rotation_center_off_screen=<value>
Defines if the rotation center is allowed to be off screen.
0 - The rotation center is reset to the screen center if a zoom, translation or fit operation causes it to be off the screen (legacy behavior)
1 - The rotation center is not reset to the screen center if a zoom, translation or fit operation causes it to be off the screen
rotator_show_view_cube=<value>
The visibility of the rotator's view cube.
0 - Never
1 - On mouse over (default)
2 - Always
rq_csv_separator=<value>
The separator character used in the CSV file exported by Results Query tool.
0 – Comma (default)
1 – Space
2 - Semicolon
3 – Forward slash
rq_export_idpool=<value>
Include the entity ID pool information in the CSV file exported by Results Query tool.
0 – Disable
1 – Enable
rq_numeric_format=<value>
The numeric format of the result values exported by the Results Query tool.
0 – Fixed (default)
1 – Scientific
rq_numeric_precision=<value>
An integer to define the number of decimal places in result values exported by Results Query tool.
rq_omegat=<value>
The omega*t value used by the complex filter in the Results Query tool.
rq_poissons_ratio=<value>
The Poisson’s ratio value used for the von Mises strain calculations in the Results Query tool.
rq_print_header=<value>
Controls the visibility of the header in the file exported by the Results Query tool.
0 – Off
1 – On
scale_color=<value>
The color of the modeling window model scale. Valid values are 1-64.
scale_height=<value>
The height of the modeling window model scale. Valid values are S (for small), M (for medium) and L (for large).
scale_position=<value>
The position of the modeling window model scale. Valid values are bottomleft, bottom, bottomright, centerleft, center, centerright, topleft, top, topright.
scale_width=<value>
The width of the modeling window model scale. Valid values are S (for small), M (for medium) and L (for large).
section_framewidth=<value>
Sets the width of the frame for the planar section cut as a real value in the range of 0.1 to 1.0 (default 0.2).
section_solidfill=<value>
Defines whether solids should be kept hollow or filled when cut by planar section cut. Valid values are:
  • 0 – Hollow
  • 1 – Filled
shift_lmb_rmb_binding=<value>
Select action for Shift key and left + right mouse button drag.
Valid values are Pan, Rotate, Zoom and CircleZoom.
shift_mmb_binding=<value>
Select action for Shift key and middle mouse button drag.
Valid values are Pan, Rotate, Zoom and CircleZoom.
shift_rmb_binding=<value>
Select action for Shift key and right mouse button drag.
Valid values are Pan, Rotate, Zoom and CircleZoom.
show_composite_layers=<value>
The composite layers visualization mode.
0 - Composite layers are not visualized.
1 - Composite layers are visualized when defined.
2 - Composite layers are visualized when defined, with overlaid ply orientation vectors.
3 - Composite layers are visualized when defined, showing only edges.
show_delete_associated_dialog=<value>
Show delete associated dialog before deleting.
0 - Do not show.
1 - Show delete associated dialog.
show_global_axes=<value>
The global axes visualization mode.
0 - Off
1 - On
show_line_dir=<value>
Displays symbols indicating geometry lines parametric direction.
0 - Turn off display of line direction symbols
1 - Turn on display of line direction symbols
show_model_title=<value>
Show the file path of the current model in the graphics area.
Valid values are 1 and 0.
show_newly_created_entities=<value>
If new entities are created/updated in a collector that is hidden:
0 - Do not turn the collector on
1 - Turn the collector on
show_plots=<value>
Show plots when loading the model.
Valid values are 1 and 0.
show_scale=<value>
The scale visualization mode.
0 - Off
1 - On
show_view_cube=<value>
The visibility of the view cube. Valid values are:
0 - Never (default)
1 - On mouse over
2 - Always
shrink_factor=<value>
The element shrink factor, between 0 and 1.
shrink_mode=<value>
The state of the element shrink mode.
0 - Off
1 - On
sketcher_constraint_display_size=<value>
The size of the constraint icons in the modeling window.
small
medium
large
sketcher_create_nested_holes
Realize the sketch entity as surfaces by creating nested holes for the inner closed regions in the sketch.
0 - Off
1 -On
sketcher_fillet_radius=<value>
The default fillet radius for sketch geometry.
sketcher_merge_adjacent_faces
Realize the sketch entity as surfaces by merging the adjacent closed regions in the sketch.
0 - Off
1 - On
sketcher_realize_mode
Mode with which the sketch entity can be realized.
0 - None
1 - Lines
2 - Surfaces
sketcher_shade_closed_regions=<value>
Shade the closed regions of the sketch profile.
0 – Off
1 – On (default)
sketcher_show_center_points
Show or hide center points of circles or arcs in sketch editing mode.
0 - Off
1 - On
sketcher_show_constraints
Show or hide constraints when in sketch editing mode.
0 - Off
1 - On
sketcher_show_construction_aides=<value>
The visibility of the coordinate displays when creating new sketch geometry.
0 – Hide coordinate displays
1 – Show coordinate displays
sketcher_show_construction_lines=<value>
The visibility of the automatically created construction lines in the sketcher.
0 – Hide construction lines
1 – Show construction lines
sketcher_show_construction_of_arcs=<value>
Show the construction lines when you hover over an arc or an open ellipse.
0 - Off
1 - On
sketcher_show_dimensions
Show or hide dimensions when in sketch editing mode.
0 - Off
1 - On
sketcher_show_grid
Show or hide grids when in sketch editing mode.
0 - Off
1 - On
sketcher_show_intersection_curves=<value>
The visibility of the intersection curves between parts and the sketch plane.
0 – Hide intersection curves
1 – Show intersection curves
sketcher_show_points
Show or hide points when in sketch editing mode.
0 - Off
1 - On
sketcher_show_variables_in_dims=<value>
Show the names of variables in dimensions.
0 - Off
1 - On
sketcher_update_in_inspire=<value>
Enables updating variables associated to sketch by connecting to Inspire application.
0 – Off
1 – On (default)
snap_circle_center=<value>
0 - Off
1 - On
snap_element_centroid=<value>
0 - Off
1 - On
snap_element_edge=<value>
0 - Off
1 - On
snap_element_mid_edge=<value>
0 - Off
1 - On
snap_feature_hole_center=<value>
0 - Off
1 - On
snap_global_xyz=<value>
0 - Off
1 - On
snap_line_end=<value>
0 - Off
1 - On
snap_line_line_intersect=<value>
0 - Off
1 - On
snap_line_middle=<value>
0 - Off
1 - On
snap_mesh_node=<value>
0 - Off
1 - On
snap_on=<value>
0 - Off
1 - On
snap_on_empty_space=<value>
0 - Off
1 - On
snap_on_tangent_extension=<value>
0 - Off
1 - On
snap_perp_from_line=<value>
0 - Off
1 - On
snap_perp_from_surf=<value>
0 - Off
1 - On
snap_perp_to_line=<value>
0 - Off
1 - On
snap_perp_to_surf=<value>
0 - Off
1 - On
snap_surf_center=<value>
0 - Off
1 - On
snap_surf_line_intersect=<value>
0 - Off
1 - On
snap_system_center=<value>
0 - Off
1 - On
snap_tangent_from_line=<value>
0 - Off
1 - On
snap_tangent_to_line=<value>
0 - Off
1 - On
solid_transparency=<value>
The solid geometry transparency value 0-10.
solid_edge_width=<value>
The solid geometry edge width 1.0-10.0. 2.5 is the legacy value.
solvermass_graphics=<value>
The display of solver mass graphical representation on referenced nodes.
0 - Off
1 - On
solvermass_handle=<value>
The display of solvermass handles.
0 - Off
1 - On
specular_intensity=<value>
The specular intensity value.
standard_view_cube=<value>
Facet cube arrangement standard. Valid values are:
0 – HyperWorks (default)
1 – Inspire
2 – CAD
stereo_display=<value>
The normal (2D) or stereo (3D) display mode.
0 - Normal display mode
1 - Stereo display mode
surface_edge_width=<value>
The solid geometry edge width 1.0-10.0. 1.0 is the legacy value.
surface_uv_lines=<value>
The number of uv lines to draw on surfaces for *settopologydisplaytype 3. Must be between 0 and 20.
sync_idle_with_browser_view=<value>
Change the idle selector to the respective browser entity type while switching between browsers.
0 - Off
1 - On
system_size_uniform=<value>
The size in model units in which systems will be drawn.
tag_display=<value>
The graphical display mode for tag entities.
0 - Show text only at tag locations
1 - Show text and graphics at tag locations
2 - Show graphics only at tag locations
tag_text_display_mode=<value>
The text display mode for tag entities. Valid values are:
0 - Show the label of the tag
1 - Show the body of the tag
2 - Show the name (label:body) of the tag
3 - Show the description of the tag. If no tag exists, the label will be shown.
thick_1d_lines=<value>
The state of 1D element line graphical thickness.
0 - Normal display mode
1 - Thick display mode
thick_mesh_lines=<value>
The state of mesh line graphical thickness.
0 - Normal display mode
1 - Thick display mode
thickness_legend_colors={<color1> <color2> ... <colorN>}
The colors for the thickness legend. A color can be specified for each row. Valid values are 1-64.
thickness_legend_rows=<value>
The number of rows for the thickness legend.
thickness_legend_values={<value1> <value2> ... <valueN>}
The values for the thickness legend. A value can be specified for each row. Values should be specified in order.
topoedgecolor=<value>
The FE topology and geometry topology edge colors:
2 - Topology
3 - 3D topology
4 - Feature
topoedgecolorauto=<value>
The automatic topology edge color.
0 - Off
1 - On
topofacecolor=<value>
The FE topology and geometry topology face colors:
2 - Assembly
3 - Parts
4 - Components
5 - Mixed
6 - Topology
7 - 3D Topology
8 - Mappable
9 - 2D element quality criteria
10 - Property
11 - Material
12 - Thickness
13 - Domain
14 - Configuration
15 - Dimension
16 - Body
22 - Element normal
24 - Include
28 - Feature
The element color mode value:
  • 9 - By 2D element quality criteria
  • 10 - By thickness difference
  • 20 - By 3D element quality criteria
  • 23 - By subsystem
topofacecolorauto=<value>
The automatic topology face color.
0 - Off
1 - On
topofacemode=<value>
The FE topology and geometry topology face mode:
1 - Wireframe
2 - Shaded
3 - Shaded with edges
4 - Transparent with edges
topology_display_mode=<value>
The geometry color mode.
0 - Automatic. The color switches between topology colors and component colors, based on specific panels.
1 - By component
2 - By topology
3 - By 2D topology. 3D geometry is colored using the "ignored (topo)" color.
4 - By 3D topology. 2D geometry is colored using the "ignored (topo)" color.
5 - Mixed. Geometry edges are colored using topology colors, while shaded surfaces use component colors.
6 - Mappable. Solids are colored using the mappable colors (ignored map, not mappable, 1 dir map and 3 dir map). 2D geometry is colored using the "ignored (topo)" color.
7 - By assembly
8 - By part
topology_edge_display_color-<type>=<value>
The color of topology edges, from 0-64.
The type modifier is required and specifies a specific edge type:
  • 0 - Free edges
  • 1 - Shared edges
  • 2 - Non-manifold edges
  • 3 - Suppressed edges
topology_edge_display_mode-<type>=<value>
The display state of topology edges.
0 - Off
1 - On
The type modifier is required and specifies a specific edge type:
  • 0 - Free edges
  • 1 - Shared edges
  • 2 - Non-manifold edges
  • 3 - Suppressed edges
topology_solid_display_mode-<type>=<value>
The display state of solid topology faces.
0 - Off
1 - On
The type modifier is required and specifies a specific face type:
  • 0 - Fin faces
  • 1 - Full partition faces
  • 2 - Bounding faces
topology_solid_edge_display_color-<type>=<value>
The color of solid topology edges, from 0-64.
The type modifier is required and specifies a specific edge type:
  • 0 - Free edges
  • 1 - Shared edges
  • 2 - Non-manifold edges
  • 3 - Suppressed edges
topology_solid_edge_display_mode-<type>=<value>
The display state of solid topology edges.
0 - Off
1 - On
The type modifier is required and specifies a specific edge type:
  • 0 - Free edges
  • 1 - Shared edges
  • 2 - Non-manifold edges
  • 3 - Suppressed edges
transparent_with_mesh_lines=<value>
The mesh line display when a component is transparent.
0 - If a component is transparent, do not show mesh lines
1 - If a component is transparent, show mesh lines
vector_auto_scale=<value>
The display of vector auto-scaling.
0 - Off
1 - On
vector_handle=<value>
The display of vector handles.
0 - Off
1 - On
vector_label=<value>
The display of vector labels.
0 - Off
1 - On
vector_size_magnitude=<value>
The vector display percentage when vector_size_type is 1.
vector_size_type=<value>
0 - Uniform display
1 - Magnitude display
vector_size_uniform=<value>
The vector display size in model units when vector_size_type is 0.
zoom_factor=<value>
The zoom in/out factor.

Examples

To set the rotation angle to 10 degrees:
*setoption rotation_angle=10
To set gradient background to the standard colors closest to (100, 200, 100) and (123, 0, 0):
*setoption background_colors-1={100 200 100}
*setoption background_colors-2={123 0 0}

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

14.0.130

2017.1 - Added new options anti_aliasing, edge_lod_threshold, edge_lod_width_auto, lighting_mode, specular_intensity and solidedge_width.

2019 - Added new options alt_lmb_rmb_binding, alt_mmb_binding, alt_rmb_binding, auto_cleanuptol, auto_elementsize, auto_nodetol, contact_surface_peak_factor, contact_surface_percent, ctrl_lmb_rmb_binding, ctrl_mmb_binding, ctrl_rmb_binding, delete_discrete_topology_mode, dynamic_center_of_rotation, element_connectivity, fe_display, geom_display, geom_point, hide_panels_automatically, legend_beyond_threshold, lmb_rmb_binding, load_max_size, load_min_size, load_new_scaling, load_scale_type, mmb_binding, mouse_append_mode, mouse_mapping, mouse_over_highlighting, node_size, number_remesh_layers, ply_link_color_and_orientation, pr_auto_preserve_connections, pr_box_approach_node_set, pr_check_log, pr_custom_bbox_for_equivalence, pr_delete_src_comp, pr_invoke_model_checker, pr_keep_src_comp_cardimage, pr_keep_src_comp_id, pr_keep_src_comp_name, pr_keep_src_ent_type, pr_keep_src_include, pr_keep_src_mat, pr_keep_src_prop, pr_merge_nodes, pr_retain_plotel_elem_nodeIds_from_src_comp, pr_show_component_pairing, reverse_zoom_direction, rmb_binding, shift_lmb_rmb_binding, shift_mmb_binding, shift_rmb_binding, show_model_title, show_plots, solid_edge_width, surface_edge_width, topoedgecolor, topofacecolor, topofacemodetopology_edge_display_color, topology_solid_edge_display_color and topology_solid_edge_display_mode. Added new delete_elements_mode value 4.

2019.1 - Added new options beam_lod_threshold, cadupdate_parameter_immediate, element_window_selection_mode, graphics_optimize_view_ctrl, legend_allow_background_transparency, method_xml_file, numeric_legend_force_ranged, numeric_legend_threshold, snap_circle_center, snap_circle_center, snap_global_xyz, snap_line_end, snap_line_line_intersect, snap_line_middle, snap_on, snap_on_empty_space, snap_on_tangent_extension, snap_perp_from_line, snap_perp_from_surf, snap_perp_to_line, snap_perp_to_surf, snap_surf_center, snap_surf_line_intersect, snap_system_center, snap_tangent_from_line and snap_tangent_to_line.

2020 - Added new options edge_density_visible, highlight, graph_plot, legeng_ranged_discrete_button, morph_color, nearby_output_entities, nearby_radius, nearby_search_method, nearby_selected_operation, nodelod, quick_topo_selection, realize_loads, retain_element_values, show_newly_created_entities and snap_mesh_node. Added new element_color_mode values 8, 17, 18, 19, 20, 21 and 23.

2020.1 - Added new options geometry_parasolid_boolean and pr_prefix_basename_suffix_based_name_pairing.

2021 - Added new options axis_drawn_view_cube , legend_colormap_divergent, locate_view_cube, numeric_precison, numeric_style, show_view_cube and solvermass_handle.

2021.1 - Added new options geometry_style_view_cube, reflector_show_view_cube, rotator_show_view_cube, topoedgecolorauto and topofacecolorauto. Removed value 1 for topoedgecolor and topofacecolor. Added new topoedgecolor value 4 and topofacecolor value 28.

2021.2 - Added new options CAD_topology_revision_edit_at_fe_mode, CAD_topology_revision_mesh_mode, CAD_topology_revision_remesh_tetra_mesh, CAD_topology_revision_transform_mode, CAD_topology_revision_transform_mode_rule, create_fe_topo_upon_element_copy, delete_assemblies_children, delete_connectors_realised_fe, delete_part_contents, delete_solids_with_elements, delete_solids_with_surface, delete_subsystem_contents, delete_surface_with_elements, delete_surface_with_solids, front_face_orientation_view_cube=<value>, g_ce_auto_load_control, g_ce_control_config, g_ce_control_file_path, g_ce_control_id, g_ce_control_keep, g_ce_control_name, graph_enable, rbody_label, retain_segments, section_framewidth, section_solidfill, show_delete_associated_dialog, sketcher_create_nested_holes, sketcher_merge_adjacent_faces, sketcher_realize_mode, sketcher_show_center_points, sketcher_show_constraints, sketcher_show_dimensions, sketcher_show_grid, sketcher_show_points, snap_element_centroid, snap_element_edge, and sync_idle_with_browser_view. Removed option graph_plot.

2022 - Added new options CAD_topology_revision_auto_remesh_layers, constraints_handle, constraints_node_limit, delete_attachments_realization, delete_line_with_elements, mb_ask_delete_table_on_exit, mb_color, mb_csv_separator, mb_display_expression, mb_numeric_format, mb_numeric_precision, mb_query_id_order, mb_show_subcase_simulation_in_col_header, mb_update_hm_on_table_cell_edit, mb_userdir_path, mb_visible_rows, rq_csv_separator, rq_export_idpool, rq_numeric_precision, rq_omegat, rq_poissons_ratio, sketcher_constraint_display_size, sketcher_fillet_radius, sketcher_show_construction_aides, sketcher_show_construction_lines, sketcher_show_intersection_curves, snap_element_mid_edge, snap_feature_hole_center, standard_view_cube, and solvermass_graphics.

2022.1 - Added new options beam_mesh_vis, g_ce_aspect_ratio_option, g_ce_aspect_ratio_value, g_ce_autocreate_attachments, g_ce_autocreate_parts, g_ce_bl_connection_angle, g_ce_consider_custom_metadata_mapping, g_ce_consider_link_for_review, g_ce_considerboltcolinearity, g_ce_consider_custom_metadata_mapping, g_ce_custom_metadata_file_path, g_ce_elem_org_comp_id, g_ce_elem_org_option, g_ce_equia_skew_option, g_ce_equia_skew_value, g_ce_jacobian_option, g_ce_jacobian_value, g_ce_line_vertex_angle, g_ce_linked_connector, g_ce_linked_entity, g_ce_long_weld_length, g_ce_lt_connection_angle, g_ce_realization_connector, g_ce_realization_link, g_ce_se_auto_register, g_ce_se_cleanup_delete, g_ce_se_cleanup_unrealize, g_ce_shell_thickness_off_for_solids, g_ce_short_weld_length, g_ce_subsystem_org_option, g_ce_warpage_option, g_ce_warpage_value, last_simulation_current, and partbrowser_with_components.

2022.2 - Added new options auto_bs_thickness, br_autofit_graphics, br_autoscroll, br_autosort, br_filter_mode, br_filter_nested, br_partbrowser_show_components, br_show_entities_all, br_show_treelines, bs_thickness, cadupdate_inspire_installation, elem_sphere_radius, intell_exact_match, intell_max_id, intell_max_name, left_justify_num_fields, sketcher_shade_closed_regions, and sketcher_update_in_inspire. Removed the option partbrowser_with_components.

2022.3 - Removed option domain_handle. Added new options delete_preserve_nodes, fe_geom_dupl, morph_1d_domain_method, morph_2d_domain_color, morph_3d_domain_color, morph_autofix_squashed_domains, morph_biasing_style, morph_check_neg_jacobians, morph_cluster_mode, morph_cluster_rotation, morph_cluster_stretch, morph_constraint_size, morph_constraint_size_mode, morph_edge_domain_color, morph_element_midnodes, morph_faces_color, morph_global_influence_method, morph_global_influence_solver, morph_handle_size, morph_handle_tolerance, morph_kriging_covariance, morph_kriging_drift, morph_kriging_finish, morph_kriging_global_domains, morph_kriging_local_domains, morph_kriging_mode, morph_kriging_morphvolumes, morph_kriging_nugget_option, morph_kriging_nugget_value, morph_kriging_resume, morph_kriging_start, morph_large_domain_mode, morph_large_domain_size, morph_large_domain_solve, morph_large_domain_unfold, morph_min_handle_influence, morph_min_step_size_angle, morph_min_step_size_dist, morph_morphing_system, morph_morphvolumes_color, morph_morphvolumes_connector_mode, morph_morphvolumes_connector_realize, morph_morphvolumes_edge_continuity_adjust, morph_morphvolumes_edge_continuity_morph, morph_morphvolumes_edge_method, morph_morphvolumes_edge_points, morph_morphvolumes_mode, morph_morphvolumes_skin_only, morph_morphvolumes_tolerance, morph_morphvolumes_transparency, morph_multithread, morph_other_domain_color, morph_partitioning_add_geometry, morph_partitioning_curve_tolerance, morph_partitioning_domain_angle, morph_partitioning_inside_3d, morph_partitioning_method_quads, morph_partitioning_method_trias, morph_partitioning_order, morph_partitioning_use_geometry, morph_quality_color_plotting, morph_quality_limit, morph_quality_mode, morph_remeshing_edge_mode, morph_remeshing_element_size, morph_remeshing_interval, morph_remeshing_mesh_type, morph_remeshing_mode, morph_remeshing_preserved_shapes, morph_remeshing_qa_fail_pct, morph_remeshing_remesh, morph_remeshing_remesh_3D, morph_remeshing_size_control, morph_remeshing_size_mode, morph_remeshing_skew_control, morph_remeshing_style, morph_remeshing_zone, morph_results_component, morph_results_datatype, morph_results_datatype_values, morph_results_info_titles, morph_results_max_option, morph_results_max_value, morph_results_mesh_color, morph_results_min_max_titles, morph_results_min_option, morph_results_min_value, morph_results_mode, morph_results_plot, morph_results_plot_style, morph_results_refresh, morph_results_simulation, morph_results_simulation_values, morph_results_solve, morph_results_solver_type, morph_results_stamping_direction_x, morph_results_stamping_direction_y, morph_results_stamping_direction_z, morph_save_morphs, morph_show_domain_icons, morph_small_domain_mode, morph_small_domain_properties, morph_small_domain_size, morph_small_domain_solve, morph_small_domain_solver, morph_smoothing_iterations, morph_smoothing_mode, morph_smoothing_type, morph_symmetry_color, morph_symmetry_size, morph_use_constraints, morph_use_symmetry_links, pdm_check_latest_partrev, pdm_check_latest_partrev_interval, rdata_memory_clean, rq_numeric_format, rq_print_header, sketcher_show_construction_of_arcs, and sketcher_show_variables_in_dims.

2023 - Removed options background_colors-1, background_colors-2, edge_density_visible, and hide_panels_automatically. Added new options blue_auto_color_range_max, blue_auto_color_range_min, display_associated_geometry_fe, g_ce_boltcylinderdisplaystatus, g_ce_boltcylinderdisplaytransparency, g_ce_colorby, g_ce_Cwelddisplaystatus, g_ce_size, g_ce_weld_database_file_path, green_auto_color_range_max, green_auto_color_range_min, red_auto_color_range_max, and red_auto_color_range_min.