Oasys.PRIMER.Options class

Class properties

class property Options.auto_confirm: boolean

If true then PRIMER will automatically confirm (i.e. press the OK button) on (most) message boxes that are mapped. If false (default) then the message boxes will be shown and wait for the user to press a button. This option may be useful to help automate an operation where PRIMER would normally show a message box and wait for the user to press a button

class property Options.browse_missing_include_file: boolean

If true (default) then PRIMER will popup a “BROWSE MISSING INCLUDE FILE” panel while reading the model. If false then it will throw an ‘missing include file error’ and continue reading the model

class property Options.copy_target_include: integer

This option sets the target include files for copied keywords. If it is set to Include.COPY_CURRENT (default) then copied keywords will go into the current layer. If it is set to Include.COPY_SOURCE, copied keywords will go into the include of the original element. An existing include file number can also be used if the copied keywords should go into a certain include

class property Options.dyna_version: string

The Ansys LS-DYNA version used to write keyword files. Can be “971R5”, “971R4”, “971R3”, “970v6763” etc (use Utils.GetLSDYNAVersions() to get a full list, or see the version popup in Model->Write ‘>>> Ansys LS-DYNA output options’). See also Model.Write and Include.Write

class property Options.edit_keep_on_top: boolean

If true edit panels created from the Edit() or Create() methods will be kept on top of other windows. If false (default) then they can be lowered

class property Options.exception_messages: boolean

If true (default) error messages will be printed to the dialogue box/stdout when an exception occurs in the API. If false they will not be printed. This option may be useful if you are using try/catch to manage exceptions and you do not want any error messages to be printed

class property Options.keyout_binary: boolean

If true then the output file will be written out in binary. If false (default) then an ascii file will be written

class property Options.keyout_compress_format: constant

This option can be used to specify the mode of compression. Can be Model.INDIVIDUAL_GZIP, Model.INDIVIDUAL_ZIP or Model.PACKAGED_ZIP

class property Options.keyout_compress_level: integer

Compression level for .gz and .zip files. Must be in the range 1 to 9 with 1 being the least compression (fastest speed) to 9 being the greatest compression (slowest speed)

class property Options.keyout_compress_switch: constant

Switch to set the compression during keyout. Can be Model.COMPRESS_KEEP (default), Model.COMPRESS_OFF or Model.COMPRESS_ON

class property Options.keyout_i10: boolean

If true then i10 format will be used to write the file. If false (default) then the normal Ansys LS-DYNA format will be used

class property Options.keyout_large: boolean

If true then large format will be used to write the file. If false (default) then the normal Ansys LS-DYNA format will be used. Note that large format is only available from version R7.1 and above

class property Options.keyout_method: constant

The method used to write include files. Can be Include.MASTER_ONLY, Include.MERGE, Include.SELECT, Include.NOT_WRITTEN, Include.SUBDIR (default) or Include.SAME_DIR

class property Options.keyout_parameter_values: boolean

This option can be used to specify how parameters are written. If true then the underlying values of any parameters will be written when they are used in data fields rather than ‘&name’. If false (default) then ‘&name’ will be written

class property Options.keyout_path_type: constant

The method used to write include paths. Can be Include.ABSOLUTE (default) or Include.RELATIVE

class property Options.keyout_separator: constant

The directory separator used when writing include files. Can be Include.NATIVE (default), Include.UNIX or Include.WINDOWS

class property Options.merge_set_collect: boolean

If true then when merging models PRIMER will merge *SET_COLLECT cards which have the same label. If false (default) then they will be renumbered. This is also used with Model.ImportInclude. The default for this can be set using the primer*merge_set_collect preference

class property Options.model_tabs_active: boolean

If true (default) then PRIMER will show model tabs in the object selection menu. If false then PRIMER will hide model tabs in object selection menu

class property Options.node_replace_asrg: boolean

If true nodes in *AIRBAG_SHELL_REFERENCE_GEOMETRY can be replaced by node merge/replace. If false they will not be considered

class property Options.pick_window_position: constant or Window

Position that the pick window will be shown on the screen. It can be any combination (bitwise OR) of Window.LEFT, Window.CENTRE, Window.RIGHT, Window.TOP, Window.MIDDLE and Window.BOTTOM or a Window object. If a window obect is used the pick window will be shown in the middle of that window. The default is Window.RIGHT|Window.TOP

class property Options.property_parameter_names: boolean

If true object properties which are parameters will be returned as parameter names. If false object properties which are parameters will be returned as parameter values

class property Options.reset_cwd: boolean

If true then the current working directory will not be changed after selecting a file. If false (default) then the current working directory will be changed after selecting a file. This option only applies to Windows machines

connections

class property Options.connection_angle_tol: float

The angle tolerance used for spotwelds in the connections algorithm

class property Options.connection_edge_dist: float

The edge distance used in the connections algorithm

class property Options.connection_file: string

The connection file to read/write

class property Options.connection_max_thickness: float

The maximum thickness used in the connections algorithm

class property Options.connection_model: integer

The model number selected to make connections in

class property Options.connection_part: integer

The part ID selected for connections

class property Options.connection_write_flag: integer

Flag that will be set on selected connections when writing. This can be used in the user JavaScript to write connections to find which are selected

class property Options.solid_spotweld_diameter: float

The default diameter of solid spotwelds

class property Options.spotweld_element_type: integer

The default type of spotweld to make. can be: Conx.SPOTWELD_BEAM, Conx.SPOTWELD_HEXA1, Conx.SPOTWELD_HEXA4, Conx.SPOTWELD_HEXA8, Conx.SPOTWELD_HEXA12 or Conx.SPOTWELD_HEXA16

graphics

class property Options.airbag_colour: integer

Airbag symbol colour

class property Options.background_colour: integer

Colour of the background

class property Options.contacts_colour: integer

Contact surface colour

class property Options.contour_text_pt_size: integer

Contour bar text size (in pts)

class property Options.edge_angle: float

Feature edge critical angle

class property Options.edges_ign_pt: integer

Option for choosing how to draw free edges (can be set to TRUE or FALSE)

class property Options.extra_nodes_colour: integer

Constrained extra nodes colour

class property Options.feature_line: integer

Switch ON/OFF feature line (can be set to TRUE or FALSE)

class property Options.for_mom_colour: integer

Nodal force/moment colour

class property Options.graticule_text_size: integer

Graticule text size

class property Options.label_colour: integer

Colour of the label

class property Options.label_pt_size: integer

Label size (in pts)

class property Options.node_colour: integer

Nodes colour

class property Options.nrb_colour: integer

Nodal rigid body colour

class property Options.overlay_colour: integer

Colour of the overlay

class property Options.overlay_edges: integer

Option for setting the overlay edges value (can be set to 0,1 or 2)

class property Options.rigid_bodies_colour: integer

Constrained rigid body colour

class property Options.rot_vels_colour: integer

Rotational velocity colour

class property Options.sketch_colour: integer

Colour of the sketch

class property Options.spotweldbeam_colour_from_panels: integer

Spotweld beam/solid colour

class property Options.spr_colour_from_node_sets: integer

Constrained SPR/SPR2/SPR3 colour

class property Options.text_colour: integer

Colour of the text

class property Options.timehist_blks_colour: integer

Time history block colour

class property Options.title_date_pt_size: integer

Size of title & date (clock) display (in pts)

class property Options.tracer_partl_colour: integer

Tracer particle colour

class property Options.trans_vels_colour: integer

Translational velocity colour

class property Options.x_sections_colour: integer

Cross-section colour

mass properties calculation

class property Options.mass_properties_centre_x: float

X-coordinate of user defined centre

class property Options.mass_properties_centre_y: float

Y-coordinate of user defined centre

class property Options.mass_properties_centre_z: float

Z-coordinate of user defined centre

class property Options.mass_properties_coordinate_system_type: integer

Coordinate system selection: Model.GLOBAL_AXES, Model.LOCAL_AXES, Model.PRINCIPAL_AXES

class property Options.mass_properties_include_attached_mass_deformable_elems: boolean

Option to include lumped mass attached to the nodes of deformable elements. Default is FALSE

class property Options.mass_properties_include_attached_mass_rigid_elems: boolean

Option to include lumped mass attached to the nodes of rigid elements. Default is FALSE

class property Options.mass_properties_include_timestep_mass: boolean

Option to switch on/off inclusion of timestep addded mass. Default is FALSE

class property Options.mass_properties_inertia_center: integer

Option to set the centre used in inertia properties calculation. By default Centre at CofG is used. Available options are: Model.CENTRE_AT_COFG, Model.USER_DEFINED_CENTRE

class property Options.mass_properties_local_axes: integer

CSYS ID when using local axes

class property Options.mass_properties_rigid_part_constrained_parts: boolean

Option to switch on/off mass of *CONSTRAINED_RIGID_BODIES associated with a rigid part. Default is FALSE

class property Options.mass_properties_rigid_part_extra_nodes: boolean

Option to switch on/off mass of *CONSTRAINED_EXTRA_NODES associated with a rigid part. Default is FALSE

nastran

class property Options.convert_rbe2_cnrb: boolean

Convert all RBE2s to *CONSTRAINED_NODAL_RIGID_BODY

class property Options.merge_rbe_nodes: boolean

Merge duplicate RBE dependent nodes

class property Options.retain_mid_nodes: boolean

Retain mid-side nodes for higher order elements

ssh

class property Options.ssh_buffer_size: integer

The size of the buffer used (in kiloBytes) when transferring data to/from the remote machine in the Ssh class. Depending on your network and the size of the files you are transferring, changing this value may make file transfers quicker. The default value is 64(kB) but any value in the range 1(kB) to 1024(kB) is allowed

widgets

class property Options.max_widgets: integer

The maximum number of Widgets that can be made for one Window. The default value is 1000

class property Options.max_window_lines: integer

The maximum number of lines that can be made for a Window.Error(), Window.Information(), Window.Message(), Window.Question() or Window.Warning() window. The default value is 25

Static methods

classmethod Options.OpenFileOptions()

Brings up a window to edit the settings for writing out *INCLUDE files. E.g. Absolute or Relative file paths

Returns:

No return value

Return type:

None

Example

To bring up the window

Oasys.PRIMER.Options.OpenFileOptions()