CubitInterface

The CubitInterface provides a Python/C++ interface into Cubit. It provides an object oriented structure that allows a developer to manipulate objects familiar to Cubit such as bodies, volumes, surfaces, etc. It also allows developers to create and manipulate as well as query geometry.
Functions
[ CFD_BC_Entity ]	get_all_cfd_bcs ()
[ AssemblyItem ]	get_assembly_items ()
{ AssemblyItem ]	get_top_level_assembly_items ()
[ AssemblyItem ]	get_assembly_children (int assembly_id)
[ int ]	get_volumes_for_node (str node_name, int node_instance)
[ MeshErrorFeedback * ]	get_mesh_errors ()
int	get_mesh_error_count ()
Class Member Functions
System Control and Data
	set_progress_tool (ProgressTool *progress)
	Register a progress-bar callback handler with Cubit.
	set_cubit_interrupt (Bool interrupt)
	This sets the global flag in Cubit that stops all interruptable processes.
	set_playback_paused_on_error (Bool pause)
	Sets whether or not playback is paused when an error occurs.
Bool	is_playback_paused_on_error ()
	Gets whether or not playback is paused when an error occurs.
Bool	developer_commands_are_enabled ()
	This checks to see whether developer commands are enabled.
	add_filename_to_recent_file_list (str &filename)
str	get_version ()
	Get the Cubit version.
str	get_revision_date ()
	Get the Cubit revision date.
str	get_build_number ()
	Get the Cubit build number.
str	get_acis_version ()
	Get the Acis version number.
int	get_acis_version_as_int ()
	Get the Acis version number as an int.
str	get_exodus_version ()
	Get the Exodus version number.
str	get_meshgems_version ()
	Get the MeshGems version number.
float	get_cubit_digits_setting ()
	Get the Cubit digits setting.
str	get_graphics_version ()
	Get the VTK version number.
	print_cmd_options ()
	Used to print the command line options.
Bool	is_modified ()
	Get the modified status of the model.
	set_modified ()
	Set the status of the model (is_modified() is now false). If you modify the model after you set this flag, it will register true.
Bool	is_undo_save_needed ()
	Get the status of the model relative to undo checkpointing.
	set_undo_saved ()
	Set the status of the model relative to undo checkpointin.
Bool	is_performing_undo ()
	Check if an undo command is currently being performed.
Bool	is_command_echoed ()
	Check the echo flag in cubit.
str	get_command_from_history (int command_number)
	Get a specific command from Cubit's command history buffer.
str	get_next_command_from_history ()
	Get 'next' command from history buffer.
str	get_previous_command_from_history ()
	Get 'previous' command from history buffer.
Bool	is_volume_meshable (int volume_id)
	Check if volume is meshable with current scheme.
	journal_commands (Bool state)
	Set the journaling flag in cubit.
Bool	is_command_journaled ()
	Check the journaling flag in cubit.
	override_journal_stream (JournalStreamBase *jnl_stream)
	Override the Journal Stream in CUBIT.
str	get_current_journal_file ()
	Gets the current journal file name.
Bool	is_working_dir_set ()
	Create BCVizInterface for CompSimUI.
Bool	cmd (str input_string)
	Pass a command string into Cubit.
Bool	silent_cmd (str input_string)
	Pass a command string into Cubit and have it executed without being verbose at the command prompt.
Bool	was_last_cmd_undoable ()
	Report whether the last executed command was undoable.
[ int ]	parse_cubit_list (str type, str int_list)
	Parse a Cubit style entity list into a list of integers.
	print_raw_help (str input_line, int order_dependent, int consecutive_dependent)
	Used to print out help when a ?, & or ! is pressed.
int	get_error_count ()
	Get the number of errors in the current Cubit session.
[ str ]	get_mesh_error_solutions (int error_code)
	Get the paired list of mesh error solutions and help context cues.
	complete_filename (str &line, int &num_chars, Bool &found_quote)
	Get the file completion inside a quote based on files in the current directory. This handles completion of directories as well as filtering on specific types (.jou, .g, .sat, etc.).
Graphics Manipulation and Data
float	get_view_distance ()
	Get the distance from the camera to the model (from - at).
[ float ]	get_view_at ()
	Get the camera 'at' point.
[ float ]	get_view_from ()
	Get the camera 'from' point.
[ float ]	get_view_up ()
	Get the camera 'up' direction.
	reset_camera ()
	reset the camera in all open windows this includes resetting the view, closing the histogram and color windows and clearing the scalar bar, highlight, and picked entities.
	flush_graphics ()
	Flush the graphics.
	clear_drawing_set (str set_name)
	Clear a named drawing set (this is for mesh preview).
	unselect_entity (str entity_type, int entity_id)
	Unselect an entity that is currently selected.
int	get_rubberband_shape ()
	Get the current rubberband select mode.
Bool	is_perspective_on ()
	Get the current perspective mode.
Bool	is_occlusion_on ()
	Get the current occlusion mode.
Bool	is_scale_visibility_on ()
	Get the current scale visibility setting.
Bool	is_mesh_visibility_on ()
	Get the current mesh visibility setting.
Bool	is_geometry_visibility_on ()
	Get the current geometry visibility setting.
Bool	is_select_partial_on ()
	Get the current select partial setting.
int	get_rendering_mode ()
	Get the current rendering mode.
	set_rendering_mode (int mode)
	Set the current rendering mode.
	clear_preview ()
	Clear preview graphics without affecting other display settings.
str	get_pick_type ()
	Get the current pick type.
[ int ]	get_selected_ids ()
	Get a list of the currently selected ids.
	highlight (str type, int id)
	Highlight the given entity.
Mesh Query Support
float	get_mesh_edge_length (int edge_id)
	Get the length of a mesh edge.
float	get_meshed_volume_or_area (str geom_type, [ int ] entity_ids)
	Get the total volume/area of a entity's mesh.
int	get_mesh_intervals (str geom_type, int entity_id)
	Get the interval count for a specified entity.
float	get_mesh_size (str geom_type, int entity_id)
	Get the mesh size for a specified entity.
float	get_requested_mesh_size (str geom_type, int id)
	Get the requested mesh size for a specified entity. This returns a size that has been set specifically on the entity and not averaged from parents.
int	has_valid_size (str geom_type, int entity_id)
	Get whether an entity has a size. All entities have a size unless the auto sizing is off. If the auto sizing is off, an entity has a size only if it has been set.
Bool	auto_size_needs_to_be_calculated ()
	Get whether the auto size needs to be calculated. Calculating the auto size may be expensive on complex models. The auto size may be outdated if the model has changed.
float	get_default_auto_size ()
	Get auto size needs for the current set of geometry.
int	get_requested_mesh_intervals (str geom_type, int entity_id)
	Get the interval count for a specified entity as set specifically on that entity.
float	get_auto_size (str geom_type, [ int ] entity_id_list, float size)
	Get the auto size for a given set of enitities. Note, this does not actually set the interval size on the volumes. It simply returns the size that would be set if an 'size auto factor n' command were issued.
int	get_element_budget (str element_type, [ int ] entity_id_list, int auto_factor)
	Get the element budget based on current size settings for a list of volumes.
str	get_exodus_sizing_function_variable_name ()
	Get the exodus sizing function variable name.
str	get_exodus_sizing_function_file_name ()
	Get the exodus sizing function file name.
str	get_sizing_function_name (str entity_type, int surface_id)
	Get the sizing function name for a surface or volume.
Bool	exodus_sizing_function_file_exists ()
	return whether the exodus sizing funnction file exists
Bool	get_vol_sphere_params ([ int ] sphere_id_list, int &rad_intervals, int &az_intervals, float &bias, float &fract, int &max_smooth_iterations)
	get the current sphere parameters for a sphere volume
str	get_curve_bias_type (int curve_id)
float	get_curve_bias_geometric_factor (int curve_id)
float	get_curve_bias_geometric_factor2 (int curve_id)
float	get_curve_bias_first_interval_length (int curve_id)
float	get_curve_bias_first_interval_fraction (int curve_id)
float	get_curve_bias_fine_size (int curve_id)
float	get_curve_bias_coarse_size (int curve_id)
float	get_curve_bias_first_last_ratio1 (int curve_id)
float	get_curve_bias_first_last_ratio2 (int curve_id)
float	get_curve_bias_last_first_ratio1 (int curve_id)
float	get_curve_bias_last_first_ratio2 (int curve_id)
Bool	get_curve_bias_from_start (int curve_id, Bool &value)
Bool	get_curve_bias_from_start_set (int curve_id)
int	get_curve_bias_start_vertex_id (int curve_id)
float	get_curve_mesh_scheme_curvature (int curve_id)
	Get the curvature mesh scheme value of a curve.
Bool	get_curve_mesh_scheme_stretch_values (int curve_id, float &first_size, float &factor, float &last_size, Bool &start, int &vertex_id)
[ float ]	get_curve_mesh_scheme_pinpoint_locations (int curve_id)
	get_quality_stats (str entity_type, [ int ] id_list, str metric_name, float single_threshold, Bool use_low_threshold, float low_threshold, float high_threshold, float &min_value, float &max_value, float &mean_value, float &std_value, int &min_element_id, int &max_element_id, [ int ] &mesh_list, str &element_type, int &bad_group_id, Bool make_group=false)
	Get the quality stats for a specified entity.
float	get_quality_value (str mesh_type, int mesh_id, str metric_name)
	Get the metric value for a specified mesh entity.
str	get_mesh_scheme (str geom_type, int entity_id)
	Get the mesh scheme for the specified entity.
str	get_mesh_scheme_firmness (str geom_type, int entity_id)
	Get the mesh scheme firmness for the specified entity.
str	get_mesh_interval_firmness (str geom_type, int entity_id)
	Get the mesh interval firmness for the specified entity. This may include influence from connected mesh intervals on connected geometry.
str	get_requested_mesh_interval_firmness (str geom_type, int entity_id)
	Get the mesh interval firmness for the specified entity as set specifically on the entity.
str	get_mesh_size_type (str geom_type, int entity_id)
	Get the mesh size setting type for the specified entity. This may include influence from attached geometry.
str	get_requested_mesh_size_type (str geom_type, int entity_id)
	Get the mesh size setting type for the specified entity as set specifically on the entity.
Bool	get_tetmesh_proximity_flag (int volume_id)
	Get the proximity flag for tet meshing.
int	get_tetmesh_proximity_layers (int volume_id)
	Get the number of proximity layers for tet meshing. This is the number of layers between close surfaces.
float	get_mesh_geometry_approximation_angle (str geom_type, int entity_id)
	Get the geometry approximation angle set for tri/tet meshing.
float	get_trimesh_surface_gradation ()
	Get the global surface mesh gradation set for meshing with MeshGems.
float	get_trimesh_volume_gradation ()
	Get the global volume mesh gradation set for meshing with MeshGems.
float	get_tetmesh_growth_factor (int volume_id)
	Get the tetmesh growth factor.
Bool	is_meshed (str geom_type, int entity_id)
	Determines whether a specified entity is meshed.
Bool	is_merged (str geom_type, int entity_id)
	Determines whether a specified entity is merged.
str	get_smooth_scheme (str geom_type, int entity_id)
	Get the smooth scheme for a specified entity.
int	get_hex_count ()
	Get the count of hexes in the model.
int	get_pyramid_count ()
	Get the count of pyramids in the model.
int	get_tet_count ()
	Get the count of tets in the model.
int	get_quad_count ()
	Get the count of quads in the model.
int	get_tri_count ()
	Get the count of tris in the model.
int	get_edge_count ()
	Get the count of edges in the model.
int	get_sphere_count ()
	Get the count of sphere elements in the model.
int	get_node_count ()
	Get the count of nodes in the model.
int	get_element_count ()
	Get the count of elements in the model.
int	get_volume_element_count (int volume_id)
	Get the count of elements in a volume.
int	get_surface_element_count (int surface_id)
	Get the count of elements in a surface.
Bool	volume_contains_tets (int volume_id)
	Determine whether a volume contains tets.
[ int ]	get_hex_sheet (int node_id_1, int node_id_2)
	Get the list of hex elements forming a hex sheet through the given two node ids. The nodes must be adjacent in the connectivity of the hex i.e. they form an edge of the hex.
str	get_default_element_type ()
	Get the current default setting for the element type that will be used when meshing.
Geometry Query Support
Bool	is_visible (str geom_type, int entity_id)
	Query visibility for a specific entity.
Bool	is_virtual (str geom_type, int entity_id)
	Query virtualality for a specific entity.
Bool	contains_virtual (str geom_type, int entity_id)
	Query virtualality of an entity's children.
[ int ]	get_source_surfaces (int volume_id)
	Get a list of a volume's sweep source surfaces.
[ int ]	get_target_surfaces (int volume_id)
	Get a list of a volume's sweep target surfaces.
int	get_common_curve_id (int surface_1_id, int surface_2_id)
	Given 2 surfaces, get the common curve id.
int	get_common_vertex_id (int curve_1_id, int curve_2_id)
	Given 2 curves, get the common vertex id.
[ [ float ] ]	project_unit_square ([ [ float ] ] pts, int surf_id, int quad_id, int node00_id, int node10_id)
	Given points in a unit square, map them to the given quad using the orientation info, then project them onto the given surface, and return their projected positions.
str	get_merge_setting (str geom_type, int entity_id)
	Get the merge setting for a specified entity.
str	get_curve_type (int curve_id)
	Get the curve type for a specified curve.
str	get_surface_type (int surface_id)
	Get the surface type for a specified surface.
	get_surface_normal (int surface_id, float &x, float &y, float &z)
	This function only works for C++*** Get the surface normal for a specified surface.
[ float ]	get_surface_normal (int surface_id)
	Get the surface normal for a specified surface.
	get_surface_centroid (int surface_id, float &x, float &y, float &z)
	This function only works from C++*** Get the surface centroid for a specified surface.
[ float ]	get_surface_centroid (int surface_id)
	Get the surface centroid for a specified surface.
str	get_surface_sense (int surface_id)
	Get the surface sense for a specified surface.
[ str ]	get_entity_modeler_engine (str geom_type, int entity_id)
	Get the modeler engine type for a specified entity.
str	get_default_geometry_engine ()
	Get the name of the default modeler engine.
[ float ]	get_bounding_box (str geom_type, int entity_id)
	Get the bounding box for a specified entity.
[ float ]	get_total_bounding_box (str geom_type, [ int ] entity_list)
	Get the bounding box for a list of entities.
[ float ]	get_tight_bounding_box (str geom_type, [ int ] entity_list)
	Get the tight bounding box for a list of entities.
float	get_total_volume ([ int ] volume_list)
	Get the total volume for a list of volume ids.
str	get_entity_name (str entity_type, int entity_id)
	Get the name of a specified entity.
Bool	set_entity_name (str entity_type, int entity_id, str new_name)
	Set the name of a specified entity.
int	get_entity_color_index (str entity_type, int entity_id)
	Get the color of a specified entity.
Bool	is_multi_volume (int body_id)
	Query whether a specified body is a multi volume body.
Bool	is_sheet_body (int volume_id)
	Query whether a specified volume is a sheet body.
Bool	is_interval_count_odd (int surface_id)
	Query whether a specified surface has an odd loop.
Bool	is_periodic (str geom_type, int entity_id)
	Query whether a specified surface or curve is periodic.
Bool	is_surface_planer (int surface_id)
	Query whether a specified surface is planer.
Bool	is_surface_planar (int surface_id)
	get_periodic_data (str geom_type, int entity_id, float &interval, str &firmness, int &lower_bound, str &upper_bound)
	Get the periodic data for a surface or curve.
Bool	get_undo_enabled ()
int	number_undo_commands ()
[ str ]	get_aprepro_vars ()
	Gets the current aprepro variable names.
str	get_aprepro_value_as_string (str var_name)
	Gets the string value of an aprepro variable.
Bool	get_aprepro_value (str var_name, int &var_type, float &dval, str &sval)
	Get the value of an aprepro variable.
float	get_aprepro_numeric_value (str var_name)
	get the value of the given aprepro variable
Bool	get_node_constraint ()
	Query current setting for node constraint (move nodes to geometry).
int	get_node_constraint_value ()
	Query current setting for node constraint (move nodes to geometry).
str	get_vertex_type (int surface_id, int vertex_id)
	Get the Vertex Types for a specified vertex on a specified surface. Vertex types include "side", "end", "reverse", "unknown".
[ int ]	get_relatives (str source_geom_type, int source_id, str target_geom_type)
	Get the relatives (parents/children) of a specified entity.
[ int ]	get_adjacent_surfaces (str geom_type, int entity_id)
	Get a list of adjacent surfaces to a specified entity.
[ int ]	get_adjacent_volumes (str geom_type, int entity_id)
	Get a list of adjacent volumes to a specified entity.
[ int ]	get_entities (str entity_type)
	Get all entities of a specified type (including geometry, mesh, etc...).
[ int ]	get_list_of_free_ref_entities (str geom_type)
	Get all free entities of a given geometry type.
int	get_owning_body (str geom_type, int entity_id)
	Get the owning body for a specified entity.
int	get_owning_volume (str geom_type, int entity_id)
	Get the owning volume for a specified entity.
int	get_owning_volume_by_name (str entity_name)
	Get the owning volume for a specified entity.
float	get_curve_length (int curve_id)
	Get the length of a specified curve.
float	get_arc_length (int curve_id)
	Get the arc length of a specified curve.
float	get_distance_from_curve_start (float x, float y, float z, int curve_id)
	Get the distance from a point on a curve to the curve's start point.
float	get_curve_radius (int curve_id)
	Get the radius of a specified arc.
[ float ]	get_curve_center (int curve_id)
	Get the center point of the arc.
float	get_surface_area (int surface_id)
	Get the area of a surface.
float	get_volume_area (int volume_id)
	Get the area of a volume.
float	get_hydraulic_radius_surface_area (int surface_id)
	Get the area of a hydraulic surface.
float	get_hydraulic_radius_volume_area (int volume_id)
	Get the area of a hydraulic volume.
[ float ]	get_center_point (str entity_type, int entity_id)
	Get the center point of a specified entity.
int	get_valence (int vertex_id)
	Get the valence for a specific vertex.
float	get_distance_between (int vertex_id_1, int vertex_id_2)
	Get the distance between two vertices.
int	is_point_contained (str geom_type, int id, const [ float ] &point)
	Determine if given point is inside, outside, on or unknown the given entity. note that this is typically used for volumes or sheet bodies.
	print_surface_summary_stats ()
	Print the surface summary stats to the console.
	print_volume_summary_stats ()
	Print the volume summary stats to the console.
	get_bc_info (BCEntity *sourceBC, str &bcType, int &bcID)
	Get the bc type and id given a piece of BCEntity.
	get_entity_info (RefEntity *source_entity, str &geom_type, int &entity_id)
	Get the geometry type and id given a ref entity.
int	get_block_count ()
	Get the current number of blocks.
int	get_sideset_count ()
	Get the current number of sidesets.
int	get_nodeset_count ()
	Get the current number of sidesets.
int	get_volume_count ()
	Get the current number of nodesets.
int	get_body_count ()
	Get the current number of bodies.
int	get_surface_count ()
	Get the current number of surfaces.
int	get_vertex_count ()
	Get the current number of vertices.
int	get_curve_count ()
	Get the current number of curves.
int	get_curve_count ([ int ] target_volume_ids)
	Get the current number of curves in the passed-in volumes.
Bool	is_catia_engine_available ()
	Determine whether catia engine is available.
Bool	is_acis_engine_available ()
Bool	is_opencascade_engine_available ()
[ int ]	evaluate_exterior_angle ([ int ] curve_list, const float test_angle)
	find all curves in the given list with an exterior angle (the angle between surfaces) less than the test angle. This is equivalent to the df parser "exterior_angle" test. (draw curve with exterior_angle ] 90)
float	get_overlap_max_gap ()
	Get the max gap setting for calculating surface overlaps.
	set_overlap_max_gap (const float max_gap)
	Set the max gap setting for calculating surface overlaps.
float	get_overlap_max_angle ()
	Get the max angle setting for calculating surface overlaps.
	set_overlap_max_angle (const float max_angle)
	Set the max angle setting for calculating surface overlaps.
Geometry Repair Support
	get_small_surfaces_hydraulic_radius ([ int ] target_volume_ids, float mesh_size, [ int ] &small_surfaces, [ float ] &small_radius)
	Get the list of small hydraulic radius surfaces for a list of volumes.
	get_small_volumes_hydraulic_radius ([ int ] target_volume_ids, float mesh_size, [ int ] &small_volumes, [ float ] &small_radius)
	Get the list of small hydraulic radius volumes for a list of volumes.
[ int ]	get_small_curves ([ int ] target_volume_ids, float mesh_size)
	Get the list of small curves for a list of volumes.
[ int ]	get_smallest_curves ([ int ] target_volume_ids, int num_to_return)
	Get a list of the smallest curves in the list of volumes. The number returned is specified by 'num_to_return'.
[ int ]	get_small_surfaces ([ int ] target_volume_ids, float mesh_size)
	Get the list of small surfaces for a list of volumes.
[ int ]	get_narrow_surfaces ([ int ] target_volume_ids, float mesh_size)
	Get the list of narrow surfaces for a list of volumes.
[ int ]	get_small_and_narrow_surfaces ([ int ] target_ids, float small_area, float small_curve_size)
	Get the list of small or narrow surfaces from a list of volumes.
[ int ]	get_closed_narrow_surfaces ([ int ] target_ids, float narrow_size)
	Get the list of closed, narrow surfaces from a list of volumes.
[ int ]	get_surfs_with_narrow_regions ([ int ] target_ids, float narrow_size)
	Get the list of surfaces with narrow regions.
[ int ]	get_narrow_regions ([ int ] target_ids, float narrow_size)
	Get the list of surfaces with narrow regions.
[ int ]	get_small_volumes ([ int ] target_volume_ids, float mesh_size)
	Get the list of small volumes from a list of volumes.
[ int ]	get_blend_surfaces ([ int ] target_volume_ids)
	Get the list of blend surfaces for a list of volumes.
[ int ]	get_small_loops ([ int ] target_volume_ids, float mesh_size)
	Get the list of close loops (surfaces) for a list of volumes.
[ int ]	get_tangential_intersections ([ int ] target_volume_ids, float upper_bound, float lower_bound)
	Get the list of bad tangential intersections for a list of volumes.
[ int ]	get_coincident_vertices ([ int ] target_volume_ids, float high_tolerance)
[ [ str ] ]	get_solutions_for_near_coincident_vertices (int vertex_id1, int vertex_id2)
	Get lists of display strings and command strings for near coincident vertices.
[ [ str ] ]	get_solutions_for_overlapping_volumes (int vol_id_1, int vol_id_2, float max_gap_tolerance, float max_gap_angle)
	Get lists of display strings and command strings for overlapping volumes.
[ [ str ] ]	get_volume_gap_solutions (int surface_id_1, int surface_id_2)
[ [ str ] ]	get_solutions_for_near_coincident_vertex_and_curve (int vertex_id, int curve_id)
	Get lists of display strings and command strings for near coincident vertices and curves.
[ [ str ] ]	get_solutions_for_near_coincident_vertex_and_surface (int vertex_id, int surface_id)
	Get lists of display strings and command strings for near coincident vertices and surfaces.
[ [ str ] ]	get_solutions_for_imprint_merge (int surface_id1, int surface_id2)
	Get lists of display strings and command strings for imprint/merge solutions.
[ [ str ] ]	get_solutions_for_forced_sweepability (int volume_id, [ int ] &source_surface_id_list, [ int ] &target_surface_id_list, float small_curve_size=-1.0)
	This function only works from C++*** Get lists of display strings and command strings for forced sweepability solutions.
[ [ str ] ]	get_solutions_for_small_surfaces (int surface_id, float small_curve_size, float mesh_size)
	Get lists of display, preview and command strings for small surface solutions.
[ [ str ] ]	get_solutions_for_small_curves (int curve_id, float small_curve_size, float mesh_size)
	Get lists of display, preview and command strings for small curve solutions.
[ [ str ] ]	get_solutions_for_surfaces_with_narrow_regions (int surface_id, float small_curve_size, float mesh_size)
	Get lists of display, preview and command strings for surfaces with narrow regions solutions.
Bool	get_solutions_for_source_target (int volume_id, [ [ int ] ] &feasible_source_surface_id_list, [ [ int ] ] &feasible_target_surface_id_list, [ [ int ] ] &infeasible_source_surface_id_list, [ [ int ] ] &infeasible_target_surface_id_list)
	Get a list of suggested sources and target surface ids given a specified volume.
	get_sharp_surface_angles ([ int ] target_volume_ids, [ int ] &large_surface_angles, [ int ] &small_surface_angles, [ float ] &large_angles, [ float ] &small_angles, float upper_bound, float lower_bound)
	Get the list of sharp surface angles for a list of volumes.
	get_sharp_curve_angles ([ int ] target_volume_ids, [ int ] &large_curve_angles, [ int ] &small_curve_angles, [ float ] &large_angles, [ float ] &small_angles, float upper_bound, float lower_bound)
	Get the list of sharp curve angles for a list of volumes.
	get_bad_geometry ([ int ] target_volume_ids, [ int ] &body_list, [ int ] &volume_list, [ int ] &surface_list, [ int ] &curve_list)
	This function only works from C++*** Get the list of bad geometry for a list of volumes.
	get_overlapping_surfaces_in_volumes ([ int ] target_volume_ids, [ int ] &surf_list_1, [ int ] &surf_list_2, [ float ] &distance_list, Bool filter_slivers=false, Bool filter_volume_overlaps=false)
	This function only works from C++*** Get the list of overlapping surfaces for a list of volumes.
	get_overlapping_surfaces ([ int ] target_surface_ids, [ int ] &surf_list_1, [ int ] &surf_list_2, [ float ] &distance_list, Bool filter_slivers=false, Bool filter_volume_overlaps=false)
	This function only works from C++*** Get the list of overlapping surfaces for a list of surfaces.
	get_volume_gaps ([ int ] target_volume_ids, [ int ] &surf_list_1, [ int ] &surf_list_2, [ float ] &distance_list, float max_gap_tolerance, float max_gap_angle)
	This function only works from C++*** Get the list of gaps for a list of volumes.
[ int ]	get_overlapping_volumes ([ int ] target_volume_ids)
	Get the list of overlapping volumes for a list of volumes.
	get_mergeable_entities ([ int ] target_volume_ids, [ [ int ] ] &surface_list, [ [ int ] ] &curve_list, [ [ int ] ] &vertex_list)
	This function only works from C++*** Get the list of mergeable entities from a list of volumes.
[ [ int ] ]	get_mergeable_vertices ([ int ] target_volume_ids)
	Get the list of mergeable vertices from a list of volumes/bodies.
[ [ int ] ]	get_mergeable_curves ([ int ] target_volume_ids)
	Get the list of mergeable curves from a list of volumes/bodies.
[ [ int ] ]	get_mergeable_surfaces ([ int ] target_volume_ids)
	Get the list of mergeable surfaces from a list of volumes/bodies.
	get_closest_vertex_curve_pairs ([ int ] target_ids, int &num_to_return, [ int ] &vert_ids, [ int ] &curve_ids, [ float ] &distances)
	Find the n closest vertex pairs in the model.
	get_smallest_features ([ int ] target_ids, int &num_to_return, [ int ] &type1_list, [ int ] &type2_list, [ int ] &id1_list, [ int ] &id2_list, [ float ] &distance_list)
	Finds all of the smallest features.
float	estimate_merge_tolerance ([ int ] target_volume_ids, Bool accurate_in=false, Bool report_in=false, float lo_val_in=-1.0, float hi_val_in=-1.0, int num_calculations_in=10, Bool return_calculations_in=false, [ float ] *merge_tols=NULL, [ int ] *num_proximities=NULL)
	Estimate a good merge tolerance for the passed-in volumes.
	find_floating_volumes ([ int ] target_volume_ids, [ int ] &floating_list)
	Get the list of volumes with no merged children.
	find_nonmanifold_curves ([ int ] target_volume_ids, [ int ] &curve_list)
	Get the list of nonmanifold curves in the volume list.
	find_nonmanifold_vertices ([ int ] target_volume_ids, [ int ] &vertex_list)
	Get the list of nonmanifold vertices in the volume list.
	get_coincident_entity_pairs ([ int ] target_volume_ids, [ int ] &v_v_vertex_list, [ int ] &v_c_vertex_list, [ int ] &v_c_curve_list, [ int ] &v_s_vertex_list, [ int ] &v_s_surf_list, [ float ] &vertex_distance_list, [ float ] &curve_distance_list, [ float ] &surf_distance_list, float low_value, float hi_value, Bool do_vertex_vertex=true, Bool do_vertex_curve=true, Bool do_vertex_surf=true, Bool filter_same_volume_cases=false)
	Get the list of coincident vertex-vertex, vertex-curve, and vertex-surface pairs and distances from a list of volumes.
	get_coincident_vertex_vertex_pairs ([ int ] target_volume_ids, [ int ] &vertex_pair_list, [ float ] &distance_list, float low_value, float threshold_value, Bool filter_same_volume_cases=false)
	Get the list of coincident vertex pairs and distances from a list of volumes.
	get_coincident_vertex_curve_pairs ([ int ] target_volume_ids, [ int ] &vertex_list, [ int ] &curve_list, [ float ] &distance_list, float low_value, float threshold_value, Bool filter_same_volume_cases=false)
	Get the list of coincident vertex/curve pairs and distances from a list of volumes.
	get_coincident_vertex_surface_pairs ([ int ] target_volume_ids, [ int ] &vertex_list, [ int ] &surface_list, [ float ] &distance_list, float low_value, float threshold_value, Bool filter_same_volume_cases=false)
	Get the list of coincident vertex/surface pairs and distances from a list of volumes.
[ str ]	get_solutions_for_decomposition ([ int ] volume_list, float exterior_angle, Bool do_imprint_merge, Bool tol_imprint)
	Get the list of possible decompositions.
[ [ str ] ]	get_solutions_for_blends (int surface_id)
	Get the solution list for a given blend surface.
[ [ int ] ]	get_blend_chains (int surface_id)
	Queries the blend chains for a surface.
float	get_merge_tolerance ()
	Get the current merge tolerance value.
Blocks, Sidesets, and Nodesets
str	get_exodus_entity_name (str entity_type, int entity_id)
	Get the name associated with an exodus entity.
str	get_exodus_entity_type (str entity_type, int entity_id)
	Get the type of an exodus entity.
str	get_exodus_entity_description (str entity_type, int entity_id)
	Get the description associated with an exodus entity.
[ float ]	get_all_exodus_times (str filename)
	Open an exodus file and get a vector of all stored time stamps.
[ str ]	get_all_exodus_variable_names (str filename, str type)
	Open an exodus file and get a list of all stored variable names.
int	get_block_id (str entity_type, int entity_id)
	Get the associated block id for a specific curve, surface, or volume.
[ int ]	get_block_ids (str mesh_geom_file_name)
	Get list of block ids from a mesh geometry file.
[ int ]	get_block_id_list ()
	Get a list of all blocks.
[ int ]	get_nodeset_id_list ()
	Get a list of all nodesets.
[ int ]	get_sideset_id_list ()
	Get a list of all sidesets.
[ int ]	get_bc_id_list (CI_BCTypes bc_type_in)
	Get a list of all bcs of a specified type.
str	get_bc_name (CI_BCTypes bc_type_in, int bc_id)
	Get the name for the specified bc.
[ int ]	get_nodeset_id_list_for_bc (CI_BCTypes bc_type_in, int bc_id)
	Get a list of all nodesets the specified bc is applied to.
[ int ]	get_sideset_id_list_for_bc (CI_BCTypes bc_type_in, int bc_id)
	Get a list of all sidesets the specified bc is applied to.
int	get_next_sideset_id ()
	Get a next available sideset id.
int	get_next_nodeset_id ()
	Get a next available nodeset id.
int	get_next_block_id ()
	Get a next available block id.
str	get_copy_nodeset_on_geometry_copy_setting ()
	Get the copy nodeset on geometry copy setting.
str	get_copy_sideset_on_geometry_copy_setting ()
	Get the copy nodeset on geometry copy setting.
str	get_copy_block_on_geometry_copy_setting ()
	Get the copy nodeset on geometry copy setting.
	get_block_children (int block_id, [ int ] &group_list, [ int ] &node_list, [ int ] &sphere_list, [ int ] &edge_list, [ int ] &tri_list, [ int ] &face_list, [ int ] &pyramid_list, [ int ] &tet_list, [ int ] &hex_list, [ int ] &wedge_list, [ int ] &volume_list, [ int ] &surface_list, [ int ] &curve_list, [ int ] &vertex_list)
	Get lists of any and all possible children of a block.
	get_nodeset_children (int nodeset_id, [ int ] &node_list, [ int ] &volume_list, [ int ] &surface_list, [ int ] &curve_list, [ int ] &vertex_list)
	get lists of any and all possible children of a nodeset
	get_sideset_children (int sideset_id, [ int ] &face_list, [ int ] &surface_list, [ int ] &curve_list)
	get lists of any and all possible children of a sideset
[ int ]	get_block_volumes (int block_id)
	Get a list of volume ids associated with a specific block.
[ int ]	get_block_surfaces (int block_id)
	Get a list of surface associated with a specific block.
[ int ]	get_block_curves (int block_id)
	Get a list of curve associated with a specific block.
[ int ]	get_block_vertices (int block_id)
	Get a list of vertices associated with a specific block.
Bool	get_block_elements_and_nodes (int block_id, [ int ] &node_list, [ int ] &sphere_list, [ int ] &edge_list, [ int ] &tri_list, [ int ] &face_list, [ int ] &pyramid_list, [ int ] &wedge_list, [ int ] &tet_list, [ int ] &hex_list)
	Get lists of the nodes and different element types associated with this block. This function is recursive, meaning that if the block was created pointing to a piece of geometry, it will traverse down and get the mesh entities associated to that geometry.
[ int ]	get_block_nodes (int block_id)
	Get a list of nodes associated with a specific block.
[ int ]	get_block_edges (int block_id)
	Get a list of edges associated with a specific block.
[ int ]	get_block_tris (int block_id)
	Get a list of tris associated with a specific block.
[ int ]	get_block_faces (int block_id)
	Get a list of faces associated with a specific block.
[ int ]	get_block_pyramids (int block_id)
	Get a list of pyramids associated with a specific block.
[ int ]	get_block_wedges (int block_id)
	Get a list of wedges associated with a specific block.
[ int ]	get_block_tets (int block_id)
	Get a list of tets associated with a specific block.
[ int ]	get_block_hexes (int block_id)
	Get a list of hexes associated with a specific block.
[ int ]	get_volume_hexes (int volume_id)
	get the list of any hex elements in a given volume
[ int ]	get_volume_tets (int volume_id)
	get the list of any tet elements in a given volume
[ int ]	get_nodeset_volumes (int nodeset_id)
	Get a list of volume ids associated with a specific nodeset.
[ int ]	get_nodeset_surfaces (int nodeset_id)
	Get a list of surface ids associated with a specific nodeset.
[ int ]	get_nodeset_curves (int nodeset_id)
	Get a list of curve ids associated with a specific nodeset.
[ int ]	get_nodeset_vertices (int nodeset_id)
	Get a list of vertex ids associated with a specific nodeset.
[ int ]	get_nodeset_nodes (int nodeset_id)
	Get a list of node ids associated with a specific nodeset. This only returns the nodes that were specifically assigned to this nodeset. If the nodeset was created as a piece of geometry, get_nodeset_nodes will not return the nodes on that geometry See also get_nodeset_nodes_inclusive.
[ int ]	get_nodeset_nodes_inclusive (int nodeset_id)
	Get a list of node ids associated with a specific nodeset. This includes all nodes specifically assigned to the nodeset, as well as nodes associated to a piece of geometry which was used to define the nodeset.
[ int ]	get_sideset_curves (int sideset_id)
	Get a list of curve ids associated with a specific sideset.
[ int ]	get_curve_edges (int curve_id)
	get the list of any edge elements on a given curve
[ int ]	get_sideset_surfaces (int sideset_id)
	Get a list of any surfaces in a sideset.
[ int ]	get_sideset_quads (int sideset_id)
	Get a list of any quads in a sideset.
[ int ]	get_surface_quads (int surface_id)
	get the list of any quad elements on a given surface
[ int ]	get_surface_tris (int surface_id)
	get the list of any tri elements on a given surface
str	get_entity_sense (str source_type, int source_id, int sideset_id)
	Get the sense of a sideset item.
str	get_wrt_entity (str source_type, int source_id, int sideset_id)
	Get the with-respect-to entity.
[ str ]	get_geometric_owner (str mesh_entity_type, str mesh_entity_list)
	Get a list of geometric owners given a list of mesh entities.
Geometry-Mesh Entity Support
[ int ]	get_volume_nodes (int vol_id)
	Get list of node ids owned by a volume. Excludes nodes owned by bounding surfs, curves and verts.
[ int ]	get_surface_nodes (int surf_id)
	Get list of node ids owned by a surface. Excludes nodes owned by bounding curves and verts.
[ int ]	get_curve_nodes (int curv_id)
	Get list of node ids owned by a curve. Excludes nodes owned by bounding vertices.
int	get_vertex_node (int vert_id)
	Get the node owned by a vertex.
Group Support
int	get_id_from_name (str name)
	Get id for a named entity.
	get_group_children (int group_id, [ int ] &group_list, [ int ] &body_list, [ int ] &volume_list, [ int ] &surface_list, [ int ] &curve_list, [ int ] &vertex_list, int &node_count, int &edge_count, int &hex_count, int &quad_count, int &tet_count, int &tri_count, int &wedge_count, int &pyramid_count, int &sphere_count)
	Get group children.
[ int ]	get_group_groups (int group_id)
	Get group groups (groups that are children of another group).
[ int ]	get_group_volumes (int group_id)
	Get group volumes (volumes that are children of a group).
[ int ]	get_group_bodies (int group_id)
	Get group bodies (bodies that are children of a group).
[ int ]	get_group_surfaces (int group_id)
	Get group surfaces (surfaces that are children of a group).
[ int ]	get_group_curves (int group_id)
	Get group curves (curves that are children of a group).
[ int ]	get_group_vertices (int group_id)
	Get group vertices (vertices that are children of a group).
[ int ]	get_group_nodes (int group_id)
	Get group nodes (nodes that are children of a group).
[ int ]	get_group_edges (int group_id)
	Get group edges (edges that are children of a group).
[ int ]	get_group_quads (int group_id)
	Get group quads (quads that are children of a group).
[ int ]	get_group_tris (int group_id)
	Get group tris (tris that are children of a group).
[ int ]	get_group_tets (int group_id)
	Get group tets (tets that are children of a group).
[ int ]	get_group_wedges (int group_id)
	Get group wedges (wedges that are children of a group).
[ int ]	get_group_pyramids (int group_id)
	Get group pyramids (pyramids that are children of a group).
[ int ]	get_group_spheres (int group_id)
[ int ]	get_group_hexes (int group_id)
int	get_next_group_id ()
	Get the next available group id from Cubit.
	delete_all_groups ()
	Delete all groups.
	delete_group (int group_id)
	Delete a specific group.
	set_max_group_id (int max_group_id)
	Reset Cubit's max group id This is really dangerous to use and exists only to overcome a limitation with Cubit. Cubit keeps track of the next group id to assign. But those ids just keep incrementing in Cubit. Some of the power tools in the Cubit GUI make groups 'under the covers' for various operations. The groups are immediately deleted. But, creating those groups will cause Cubit's group id to increase and downstream journal files may be messed up because those journal files are expecting a certain ID to be available.
int	create_new_group ()
	Create a new group.
	remove_entity_from_group (int group_id, int entity_id, str entity_type)
	Remove a specific entity from a specific group.
	add_entity_to_group (int group_id, int entities, str entity_type)
	Add a specific entity to a specific group.
	add_entities_to_group (int group_id, [ int ] entity_id, str entity_type)
	Add a list of entities to a specific group.
	group_list ([ str ] &name_list, [ int ] &id_list)
	Get the names and ids of all the groups (excluding the pick group) that are defined by the current cubit session.
[ int ]	get_mesh_group_parent_ids (str element_type, int element_id)
	Get the group ids which are parents to the indicated mesh element.
Bool	is_mesh_element_in_group (str element_type, int element_id)
	Indicates whether a mesh element is in a group.
General Purpose Utility
Bool	is_part_of_list (int target_id, [ int ] id_list)
	Routine to check for the presence of an id in a list of ids.
int	get_last_id (str entity_type)
	Get the id of the last created entity of the given type.
str	get_idless_signature (str type, int id)
	get the idless signature of a geometric or mesh entity
str	get_idless_signatures (str type, [ int ] idlist)
	get the idless signatures of a range of geometric or mesh entities
Metadata Support
str	get_assembly_classification_level ()
	Get Classification Level for metadata.
str	get_assembly_classification_category ()
	Get Classification Category for metadata.
str	get_assembly_weapons_category ()
	Get Weapons Category for metadata.
str	get_assembly_metadata (int volume_id, int data_type)
	Get metadata for a specified volume id.
Bool	is_assembly_metadata_attached (int volume_id)
	Determine whether metadata is attached to a specified volume.
str	get_assembly_name (int assembly_id)
	Get the stored name of an assembly node.
str	get_assembly_path (int assembly_id)
	Get the stored path of an assembly node.
str	get_assembly_type (int assembly_id)
	Get the stored type of an assembly node.
str	get_parent_assembly_path (int assembly_id)
	Get the stored path of an assembly node' parent.
int	get_assembly_level (int assembly_id)
	Get the stored level of an assembly node.
str	get_assembly_description (int assembly_id)
	Get the stored description of an assembly node.
int	get_assembly_instance (int assembly_id)
	Get the stored instance number of an assembly node.
int	get_parent_assembly_instance (int assembly_id)
	Get the stored instance number of an assembly node's instance.
str	get_assembly_file_format (int assembly_id)
	Get the stored file format of an assembly node.
str	get_assembly_units (int assembly_id)
	Get the stored units measure of an assembly node.
str	get_assembly_material_description (int assembly_id)
	Get the stored material description of an assembly part.
str	get_assembly_material_specification (int assembly_id)
	Get the stored material specification of an assembly part.
Mesh Element Queries
int	get_exodus_id (str entity_type, int entity_id)
	Get the exodus/genesis id for this element.
str	get_geometry_owner (str entity_type, int entity_id)
	Get the geometric owner of this mesh element.
[ int ]	get_connectivity (str entity_type, int entity_id)
	Get the list of node ids contained within a mesh entity.
[ int ]	get_expanded_connectivity (str entity_type, int entity_id)
	Get the list of node ids contained within a mesh entity, including interior nodes.
[ int ]	get_sub_elements (str entity_type, int entity_id, int dimension)
	Get the lower dimesion entities associated with a higher dimension entities. For example get the faces associated with a hex or the edges associated with a tri.
Bool	get_node_exists (int node_id)
	Check the existance of a node.
Bool	get_element_exists (int element_id)
	Check the existance of an element.
str	get_element_type (int element_id)
	return the type of a given element
int	get_element_type_id (int element_id)
	return the type id of a given element
int	get_element_block (int element_id)
	return the block that a given element is in.
int	get_global_element_id (str elem_type, int id)
	Given a hex, tet, etc. id, return the global element id.
int	get_hex_global_element_id (int hex_id)
	Given a hex id, return the global element id.
int	get_tet_global_element_id (int tet_id)
	Given a tet id, return the global element id.
int	get_wedge_global_element_id (int wedge_id)
	Given a wedge id, return the global element id.
int	get_pyramid_global_element_id (int pyramid_id)
	Given a pyramid id, return the global element id.
int	get_tri_global_element_id (int tri_id)
	Given a tri id, return the global element id.
int	get_quad_global_element_id (int quad_id)
	Given a quad id, return the global element id.
int	get_edge_global_element_id (int edge_id)
	Given a edge id, return the global element id.
int	get_sphere_global_element_id (int edge_id)
	Given a sphere id, return the global element id.
int	get_node_global_id (int node_id)
	Given a node id, return the global element id that is assigned when the mesh is exported.
int	get_closest_node (float x, float y, float z)
	Get the node closest to the given coordinates.
[ float ]	get_nodal_coordinates (int node_id)
	Get the nodal coordinates for a given node id.
[ int ]	get_node_faces (int node_id)
[ int ]	get_node_tris (int node_id)
Bool	get_node_position_fixed (int node_id)
	Query "fixedness" state of node. A fixed node is not affecting by smoothing.
[ int, int ]	get_submap_corner_types (int surface_id)
	Get a list of vertex ids and the corresponding corner vertex types if the surface were defined as submap surface. There are no side affects. This does not actually assign corner types or change the underlying mesh scheme of the surface.
str	get_sideset_element_type (int sideset_id)
	Get the element type of a sideset.
str	get_block_element_type (int block_id)
	Get the element type of a block.
int	get_exodus_element_count (int entity_id, str entity_type)
	Get the number of elements in a exodus entity.
int	get_block_attribute_count (int block_id)
	Get the number of attributes in a block.
int	get_block_element_attribute_count (int block_id)
float	get_block_attribute_value (int block_id, int index)
	Get a specific block attribute value.
str	get_block_attribute_name (int block_id, int index)
	Get a specific block attribute name.
[ str ]	get_block_element_attribute_names (int block_id)
[ str ]	get_valid_block_element_types (int block_id)
	Get a list of potential element types for a block.
int	get_exodus_variable_count (str entity_type, int id)
	Get the number of exodus variables in a nodeset, sideset, or block.
[ str ]	get_exodus_variable_names (str entity_type, int id)
	Get the names of exodus variables in a nodeset, sideset, or block.
int	get_nodeset_node_count (int nodeset_id)
	Get the number of nodes in a nodeset.
int	get_geometry_node_count (str entity_type, int entity_id)
	get_owning_volume_ids (str entity_type, [ int ] &entity_list, [ int ] &vol_ids)
	Gets the id's of the volumes that are owners of one of the specified entities.
str	get_mesh_element_type (str entity_type, int entity_id)
	Get the mesh element type contained in the specified geometry.
Boundary Condition Support
Bool	is_on_thin_shell (CI_BCTypes bc_type_in, int entity_id)
	Determine whether a BC is on a thin shell. Valid for temperature, convection and heatflux.
Bool	temperature_is_on_solid (CI_BCTypes bc_type_in, int entity_id)
	Determine whether a BC temperature is on a solid. Valid for convection and temperature.
Bool	convection_is_on_solid (int entity_id)
	Determine whether a BC convection is on a solid. Valid for convection.
Bool	convection_is_on_shell_area (int entity_id, CI_BCEntityTypes shell_area)
	Determine whether a BC convection is on a shell top or bottom. Valid for convection.
float	get_convection_coefficient (int entity_id, CI_BCEntityTypes cc_type)
	Get the convection coefficient.
float	get_bc_temperature (CI_BCTypes bc_type, int entity_id, CI_BCEntityTypes temp_type)
	Get the temperature. Valid for convection, temperature.
Bool	temperature_is_on_shell_area (CI_BCTypes bc_type, CI_BCEntityTypes bc_area, int entity_id)
	Determine whether a BC temperature is on a shell area. Valid for convection and temperature and on top, bottom, gradient, and middle.
Bool	heatflux_is_on_shell_area (CI_BCEntityTypes bc_area, int entity_id)
	Determine whether a BC heatflux is on a shell area.
float	get_heatflux_on_area (CI_BCEntityTypes bc_area, int entity_id)
	Get the heatflux on a specified area.
int	get_cfd_type (int entity_id)
	Get the cfd subtype for a specified cfd BC.
float	get_contact_pair_friction_value (int entity_id)
	Get the contact pair's friction value.
float	get_contact_pair_tolerance_value (int entity_id)
	Get the contact pair's upper bound tolerance value.
float	get_contact_pair_tol_lower_value (int entity_id)
	Get the contact pair's lower bound tolerance value.
Bool	get_contact_pair_tied_state (int entity_id)
	Get the contact pair's tied state.
Bool	get_contact_pair_general_state (int entity_id)
	Get the contact pair's general state.
Bool	get_contact_pair_exterior_state (int entity_id)
	Get the contact pair's exterior state.
int	get_displacement_coord_system (int entity_id)
	Get the displacement's coordinate system id.
const float *	get_displacement_dof_values (int entity_id)
	This function only available from C++*** Get the displacement's dof values.
const int *	get_displacement_dof_signs (int entity_id)
	This function only available from C++*** Get the displacement's dof signs.
const float *	get_velocity_dof_values (int entity_id)
	This function only available from C++*** Get the velocity's dof values.
const int *	get_velocity_dof_signs (int entity_id)
	This function only available from C++*** Get the velocity's dof signs.
str	get_velocity_combine_type (int entity_id)
	This function only available from C++*** Get the acceleration's dof values.
const float *	get_acceleration_dof_values (int entity_id)
	This function only available from C++*** Get the acceleration's dof values.
const int *	get_acceleration_dof_signs (int entity_id)
	This function only available from C++*** Get the acceleration's dof signs.
str	get_acceleration_combine_type (int entity_id)
	Get the acceleration's combine type which is "Overwrite", "Average", "SmallestCombine", or "LargestCombine".
str	get_displacement_combine_type (int entity_id)
	Get the displacement's combine type which is "Overwrite", "Average", "SmallestCombine", or "LargestCombine".
float	get_pressure_value (int entity_id)
	Get the pressure value.
str	get_pressure_function (int entity_id)
	Get the pressure function.
float	get_force_magnitude (int entity_id)
	Get the force magnitude from a force.
float	get_moment_magnitude (int entity_id)
	Get the moment magnitude from a force.
[ float ]	get_force_direction_vector (int entity_id)
	Get the direction vector from a force.
[ float ]	get_force_moment_vector (int entity_id)
	Get the moment vector from a force.
str	get_constraint_type (int constraint_id)
	Get the type of a specified constraint.
str	get_constraint_reference_point (int constraint_id)
	Get the reference point of a specified constraint.
str	get_constraint_dependent_entity_point (int constraint_id)
	Get the dependent entity of a specified constraint.
float	get_material_property (CI_MaterialProperty mp, int entity_id)
int	get_media_property (int entity_id)
[ str ]	get_material_name_list ()
[ str ]	get_media_name_list ()
float	calculate_timestep_estimate (str entity_type, [ int ] entity_ids)
float	calculate_timestep_estimate (str entity_type, [ int ] entity_ids, float density, float youngs_modulus, float poissons_ratio)
	set_label_type (str entity_type, int label_flag)
int	get_label_type (str entity_type)
[ int ]	get_coordinate_systems_id_list ()
	compare_geometry_and_mesh ([ int ] volume_ids, [ int ] block_ids, [ int ] hex_ids, [ int ] tet_ids, float tolerance, int &unmatched_volumes, int &unmatched_elements, [ int ] &full_matches_group_ids, [ int ] &partial_matches_group_ids, int &volume_curves_group_id)
float	get_dbl_sculpt_default (str variable)
int	get_int_sculpt_default (str variable)
Bool	get_Bool_sculpt_default (str variable)
str	get_string_sculpt_default (str variable)
Boundary Layer Support
int	get_next_boundary_layer_id ()
Bool	is_boundary_layer_id_available (int id)
str	get_boundary_layer_algorithm (int id)
Bool	get_boundary_layer_uniform_parameters (int id, float &first_row_height, float &growth_factor, int &number_rows)
Bool	get_boundary_layer_aspect_first_parameters (int id, float &first_row_aspect, float &growth_factor, int &number_rows)
Bool	get_boundary_layer_aspect_last_parameters (int id, float &first_row_height, int &number_rows, float &last_row_aspect)
Bool	get_boundary_layer_curve_surface_pairs (int id, [ int ] &curve_list, [ int ] &surface_list)
Bool	get_boundary_layer_surface_volume_pairs (int id, [ int ] &surface_list, [ int ] &volume_list)
Bool	get_boundary_layer_vertex_intersection_types ([ int ] &vertex_list, [ int ] &surface_list, [ str ] &types)
Bool	get_boundary_layer_curve_intersection_types ([ int ] &curve_list, [ int ] &volume_list, [ str ] &types)
Bool	get_boundary_layer_continuity (int id)
[ int ]	get_boundary_layer_id_list ()
CubitInterface Control - Not Generally Useful
const int	CI_ERROR = -1
	init (const [ str ] &argv)
	Use init to initialize Cubit. Using a blank list as the input parameter is acceptable.
	destroy ()
	Closes the current journal file.
	process_input_files ()
	C++ only***.
	set_exit_handler (ExternalExitHandler *hdlr)
	C++ only***.
	set_playback_handler (ExternalPlaybackHandler *hdlr)
	C++ only***.
ExternalPlaybackHandler *	get_playback_handler ()
	set_cubit_message_handler (CubitMessageHandler *hdlr)
	redirect the output from cubit. C++ only***
CubitMessageHandler *	get_cubit_message_handler ()
	get the default message handler C++ only***
	enable_signal_handling (Bool on)
	initialize/uninitialize signal handling C++ only***

---

Typedef Documentation

typedef CIObserve ObserverBase

ObserverBase is a typedef for the latest version of the CIObserve class. It is provided for convenience so that code does not need to be updated to use the new class name when additional functions are added to CIObserve.

---

Function Documentation

add_entities_to_group	(	int	group_id,
		[ int ]	entity_id,
		str	entity_type	)

Add a list of entities to a specific group.

 add_entities_to_group(3, list, "surface");

 cubit.add_entities_to_group(3, list, "surface")

Parameters:

	group_id	ID of group to which the entity will be added
	list	a vector of IDs of the entities to be added to the group
	entity_type	Type of the entity to be added to the group. Note that this function is valid only for geometric entities

add_entity_to_group	(	int	group_id,
		int	entities,
		str	entity_type	)

Add a specific entity to a specific group.

 add_entity_to_group(3, 22, "surface");

 cubit.add_entity_to_group(3, 22, "surface")

Parameters:

	group_id	ID of group to which the entity will be added
	entity_id	ID of the entity to be added to the group
	entity_type	Type of the entity to be added to the group. Note that this function is valid only for geometric entities

add_filename_to_recent_file_list

(

str &

filename

)

/brief Adds the filename to the recent file list. /param filename to be added to the recent file list.

Bool auto_size_needs_to_be_calculated

(

)

Get whether the auto size needs to be calculated. Calculating the auto size may be expensive on complex models. The auto size may be outdated if the model has changed.

float calculate_timestep_estimate	(	str	entity_type,
		[ int ]	entity_ids,
		float	density,
		float	youngs_modulus,
		float	poissons_ratio	)

/brief Calculate timestep estimate

/return timestep estimate (smallest time step)

float calculate_timestep_estimate	(	str	entity_type,
		[ int ]	entity_ids	)

/brief Calculate timestep estimate on elements in entity type: "Tet" or "Hex" or "Volume" or "Block" or "Group" The hexes or tets must belong to a single block and that block must have a material property assigned to it, where properties elastic_modulus, poisson_ratio, and density are defined. /return timestep estimate (smallest time step)

clear_drawing_set

(

str

set_name

)

Clear a named drawing set (this is for mesh preview).

clear_preview

(

)

Clear preview graphics without affecting other display settings.

Bool cmd

(

str

input_string

)

Pass a command string into Cubit.

Passing a command into Cubit using this method will result in an immediate execution of the command. The command is passed directly to Cubit without any validation or other checking.

 cmd("create brick x 10");

 cubit.cmd("brick x 10")

Parameters:

input_string

Pointer to a string containing a complete Cubit command

compare_geometry_and_mesh	(	[ int ]	volume_ids,
		[ int ]	block_ids,
		[ int ]	hex_ids,
		[ int ]	tet_ids,
		float	tolerance,
		int &	unmatched_volumes,
		int &	unmatched_elements,
		[ int ] &	full_matches_group_ids,
		[ int ] &	partial_matches_group_ids,
		int &	volume_curves_group_id	)

complete_filename	(	str &	line,
		int &	num_chars,
		Bool &	found_quote	)

Get the file completion inside a quote based on files in the current directory. This handles completion of directories as well as filtering on specific types (.jou, .g, .sat, etc.).

Parameters:

line

[in/out] the line to be completed and the completed line num_chars [out] the number of characters added to the input line. If 0 there are multiple completions found_quote [out] if the end of quote was found

Bool contains_virtual	(	str	geom_type,
		int	entity_id	)

Query virtualality of an entity's children.

 if (contains_virtual("surface", 134)) . . .

 if cubit.contains_virtual("surface", 134)):

Parameters:

	geom_type	Specifies the geometry type of the entity
	entity_id	Specifies the id of the entity

Bool convection_is_on_shell_area	(	int	entity_id,
		CI_BCEntityTypes	shell_area	)

Determine whether a BC convection is on a shell top or bottom. Valid for convection.

/param entity_id Id of the BC convection /param shell_area enum of BCEntityTypes. Use 7 to check if on top, 8 to check if on bottom /return true if convection is on the shell area, otherwise false

Bool convection_is_on_solid

(

int

entity_id

)

Determine whether a BC convection is on a solid. Valid for convection.

/param entity_id Id of the BC convection /return true if convection is on a solid, otherwise false

int create_new_group

(

)

Create a new group.

Returns:

group_id ID of new group

delete_all_groups

(

)

Delete all groups.

delete_group

(

int

group_id

)

Delete a specific group.

Parameters:

group_id

ID of group to delete

destroy

(

)

Closes the current journal file.

Bool developer_commands_are_enabled

(

)

This checks to see whether developer commands are enabled.

Returns:

True if developer commands are enabled, otherwise False

enable_signal_handling

(

Bool

on

)

initialize/uninitialize signal handling C++ only***

Parameters:

on

Set to true to initialize signal handling, false to uninitialize.

float estimate_merge_tolerance	(	[ int ]	target_volume_ids,
		Bool	accurate_in = false,
		Bool	report_in = false,
		float	lo_val_in = -1.0,
		float	hi_val_in = -1.0,
		int	num_calculations_in = 10,
		Bool	return_calculations_in = false,
		[ float ] *	merge_tols = NULL,
		[ int ] *	num_proximities = NULL	)

Estimate a good merge tolerance for the passed-in volumes.

Given a list of volumes try to estimate a good merge tolerance.

Parameters:

	target_volume_ids	List of volumes ids to examine.
	accurate_in	Flag specifying whether to do a lengthier, more accurate calculation.
	report_in	Flag specifying whether to report results to the command line.
	lo_val_in	Low value of range to search for merge tolerance.
	hi_val_in	High value of range to search for merge tolerance.
	num_calculations_in	Number of intervals to split search range up into.
	return_calculations_in	Flag specifying whether to return the number of proximities at each step.
	merge_tols	List containing merge tolerance at each step of calculation.
	num_proximities	List containing number of proximities at each step of calculation.

[ int ] evaluate_exterior_angle	(	[ int ]	curve_list,
		const float	test_angle	)

find all curves in the given list with an exterior angle (the angle between surfaces) less than the test angle. This is equivalent to the df parser "exterior_angle" test. (draw curve with exterior_angle ] 90)

Parameters:

	curve_list	a list of curve ids (integers)
	test_angle	the value (in degrees) that will be used in testing the exterior angle

Returns:

A list (python tuple) of curve ids that meet the angle test.

Bool exodus_sizing_function_file_exists

(

)

return whether the exodus sizing funnction file exists

Returns:

whether the exodus sizing function file exists

find_floating_volumes	(	[ int ]	target_volume_ids,
		[ int ] &	floating_list	)

Get the list of volumes with no merged children.

Given a list of volumes find all of the volumes that are not attached to any other entity through a merge.

Parameters:

	target_volume_ids	List of volumes ids to examine.
	volume_list	User specified list where the ids of floating volumes are returned

find_nonmanifold_curves	(	[ int ]	target_volume_ids,
		[ int ] &	curve_list	)

Get the list of nonmanifold curves in the volume list.

Given a list of volumes find all of the nonmanifold curves. This is found by seeing if there is at least one merged face attached to any merged curve. If there exist merged curves that don't belong to merged faces it represents a nonmanifold case.

Parameters:

	target_volume_ids	List of volumes ids to examine.
	curve_list	User specified list where the ids of nonmanifold curves are returned

find_nonmanifold_vertices	(	[ int ]	target_volume_ids,
		[ int ] &	vertex_list	)

Get the list of nonmanifold vertices in the volume list.

Given a list of volumes find all of the nonmanifold vertices. This is found by seeing if there is at least one merged curve attached to any merged vertex. If there exist merged vertices that don't belong to merged curves it represents a nonmanifold case.

Parameters:

	target_volume_ids	List of volumes ids to examine.
	vertex_list	User specified list where the ids of nonmanifold vertices are returned

flush_graphics

(

)

Flush the graphics.

str get_acceleration_combine_type

(

int

entity_id

)

Get the acceleration's combine type which is "Overwrite", "Average", "SmallestCombine", or "LargestCombine".

/param entity_id Id of the acceleration /return The combine type for the given acceleration

const int* get_acceleration_dof_signs

(

int

entity_id

)

This function only available from C++*** Get the acceleration's dof signs.

/param entity_id Id of the acceleration /return

const float* get_acceleration_dof_values

(

int

entity_id

)

str get_acis_version

(

)

Get the Acis version number.

Returns:

A string containing the Acis version number

int get_acis_version_as_int

(

)

Get the Acis version number as an int.

Returns:

An integer containing the Acis version number

[ int ] get_adjacent_surfaces	(	str	geom_type,
		int	entity_id	)

Get a list of adjacent surfaces to a specified entity.

For a specified entity, find all surfaces that own the entity and surfaces that touch the surface that owns this entity.

 [ int ]  surface_id_list;
 surface_id_list = get_adjacent_surfaces("curve", 22);

 surface_id_list = cubit.get_adjacent_surfaces("curve", 22)

Parameters:

	geom_type	Specifies the geometry type of the entity
	entity_id	Specifies the id of the entity

Returns:

A list (python tuple) of surfaces ids

[ int ] get_adjacent_volumes	(	str	geom_type,
		int	entity_id	)

Get a list of adjacent volumes to a specified entity.

For a specified entity, find all volumes that own the entity and volumes that touch the volume that owns this entity.

 [ int ]  volume_id_list;
 volume_id_list = get_adjacent_volumes("curve", 22);

 volume_id_list = cubit.get_adjacent_volumes("curve", 22)

Parameters:

	geom_type	Specifies the geometry type of the entity
	entity_id	Specifies the id of the entity

Returns:

A list (python tuple) of volume ids

[ CFD_BC_Entity ] get_all_cfd_bcs

(

)

[ float ] get_all_exodus_times

(

str

filename

)

Open an exodus file and get a vector of all stored time stamps.

Parameters:

filename

Fully qualified exodus file name

Returns:

List (python tuple) of time stamps in the exodus file

[ str ] get_all_exodus_variable_names	(	str	filename,
		str	type	)

Open an exodus file and get a list of all stored variable names.

Parameters:

	filename	Fully qualified exodus file name
	type	Variable type - 'g', 'n', or 'e'

Returns:

List (python tuple) of variable names in the exodus file

float get_aprepro_numeric_value

(

str

var_name

)

get the value of the given aprepro variable

Returns:

value as float on failure returns CUBIT_DBL_MAX

Bool get_aprepro_value	(	str	var_name,
		int &	var_type,
		float &	dval,
		str &	sval	)

Get the value of an aprepro variable.

Parameters:

	var_name	aprepro variable name
	var_type	return 0, 1 or 3 where 0=undefined 1=float/int 2=string
	dval	return integer or float value if var_type=1
	sval	return string if var_type=2

Returns:

1 = success, 0 = failure (no such variable name)

str get_aprepro_value_as_string

(

str

var_name

)

Gets the string value of an aprepro variable.

/param var_name aprepro variable name /return The string value of the aprepro variable name

[ str ] get_aprepro_vars

(

)

Gets the current aprepro variable names.

/return A list (python tuple) of the current aprepro variable names

float get_arc_length

(

int

curve_id

)

Get the arc length of a specified curve.

Parameters:

curve_id

ID of the curve

Returns:

Arc length of the curve

[ AssemblyItem ] get_assembly_children

(

int

assembly_id

)

str get_assembly_classification_category

(

)

Get Classification Category for metadata.

Returns:

Requested data

str get_assembly_classification_level

(

)

Get Classification Level for metadata.

Returns:

Requested data

str get_assembly_description

(

int

assembly_id

)

Get the stored description of an assembly node.

Parameters:

assembly_id

Id that identifies the assembly node

Returns:

Description of the assembly node

str get_assembly_file_format

(

int

assembly_id

)

Get the stored file format of an assembly node.

Parameters:

assembly_id

Id that identifies the assembly node

Returns:

File Format of the assembly node

int get_assembly_instance

(

int

assembly_id

)

Get the stored instance number of an assembly node.

Parameters:

assembly_id

Id that identifies the assembly node

Returns:

Instance of the assembly node

[ AssemblyItem ] get_assembly_items

(

)

int get_assembly_level

(

int

assembly_id

)

Get the stored level of an assembly node.

Parameters:

assembly_id

Id that identifies the assembly node

Returns:

Level of the assembly node - Level == 0 == Root

str get_assembly_material_description

(

int

assembly_id

)

Get the stored material description of an assembly part.

Parameters:

assembly_id

Id that identifies the assembly node

Returns:

Material Description of the assembly part

str get_assembly_material_specification

(

int

assembly_id

)

Get the stored material specification of an assembly part.

Parameters:

assembly_id

Id that identifies the assembly node

Returns:

Material Specification of the assembly part

str get_assembly_metadata	(	int	volume_id,
		int	data_type	)

Get metadata for a specified volume id.

Parameters:

	volume_id	ID of the volume
	data_type	Magic number representing the type of assembly information to return. 1 = Part Number, 2 = Description, 3 = Material Description 4 = Material Specification, 5 = Assembly Path, 6 = Original File

Returns:

Requested data

str get_assembly_name

(

int

assembly_id

)

Get the stored name of an assembly node.

Parameters:

assembly_id

Id that identifies the assembly node

Returns:

Name of the assembly node

str get_assembly_path

(

int

assembly_id

)

Get the stored path of an assembly node.

Parameters:

assembly_id

Id that identifies the assembly node

Returns:

Path of the assembly node

str get_assembly_type

(

int

assembly_id

)

Get the stored type of an assembly node.

Parameters:

assembly_id

Id that identifies the assembly node

Returns:

Type of the assembly node -- 'part' or 'assembly'

str get_assembly_units

(

int

assembly_id

)

Get the stored units measure of an assembly node.

Parameters:

assembly_id

Id that identifies the assembly node

Returns:

Units of the assembly node

str get_assembly_weapons_category

(

)

Get Weapons Category for metadata.

Returns:

Requested data

float get_auto_size	(	str	geom_type,
		[ int ]	entity_id_list,
		float	size	)

Get the auto size for a given set of enitities. Note, this does not actually set the interval size on the volumes. It simply returns the size that would be set if an 'size auto factor n' command were issued.

Parameters:

	entity_type	Specifies the geometry type of the entity
	enitty_id_list	List (vector) of entity ids
	size	The auto factor for the AutoSizeTool

Returns:

The interval size from the AutoSizeTool

get_bad_geometry	(	[ int ]	target_volume_ids,
		[ int ] &	body_list,
		[ int ] &	volume_list,
		[ int ] &	surface_list,
		[ int ] &	curve_list	)

This function only works from C++*** Get the list of bad geometry for a list of volumes.

Bad geometry can be any number of problems associated with poorly defined ACIS geometry.

Parameters:

	target_volume_ids	List of volume ids to examine.
	body_list	User specified list where ids of bad bodies will be returned
	volume_list	User specified list where ids of bad volumes will be returned
	surface_list	User specified list where ids of bad surfaces will be returned
	curve_list	User specified list where ids of bad curves will be returned

[ int ] get_bc_id_list

(

CI_BCTypes

bc_type_in

)

Get a list of all bcs of a specified type.

Parameters:

bc_type_in

as an enum defined by CI_BCTypes. 1-9 is FEA, 10-30 is CFD

Returns:

List (python tuple) of all active bc ids

get_bc_info	(	BCEntity *	sourceBC,
		str &	bcType,
		int &	bcID	)

Get the bc type and id given a piece of BCEntity.

Parameters:

	source_entity	Pointer to a BCEntity entity
	bcType	User specified variable where the bc type will be returned
	bcID	User specified variable where the bc id will be returned

str get_bc_name	(	CI_BCTypes	bc_type_in,
		int	bc_id	)

Get the name for the specified bc.

Parameters:

	bc_type_in	type of bc, as defined by enum CI_BCTypes. 1-9 is FEA, 10-30 is CFD
	bc_id	ID of the desired bc.

Returns:

The bc name

float get_bc_temperature	(	CI_BCTypes	bc_type,
		int	entity_id,
		CI_BCEntityTypes	temp_type	)

Get the temperature. Valid for convection, temperature.

/param bc_type enum of CI_BCTypes. temperature = 4, convection = 7 /param entity_id Id of the BC convection /param temp_type enum of CI_BCEntityTypes (normal, shell top, shell bottom). For convection, 2 if on solid, 7 if on top, 8 if on bottom. For temperature, 3 if on solid, 7 for top, 8 for bottom, 9 for gradient, 10 for middle /return The value of the specified BC temperature

[ [ int ] ] get_blend_chains

(

int

surface_id

)

Queries the blend chains for a surface.

Parameters:

surface_id

surface to retrieve the blend chains from

Returns:

A list of lists of id's in each blend chain. Note: If using python, lists will be python tuples.

[ int ] get_blend_surfaces

(

[ int ]

target_volume_ids

)

Get the list of blend surfaces for a list of volumes.

Parameters:

target_volume_ids

List of volume ids to examine. List (python tuple) of blend surface ids

int get_block_attribute_count

(

int

block_id

)

Get the number of attributes in a block.

Parameters:

block_id

The block id

Returns:

Number of attributes in the block

str get_block_attribute_name	(	int	block_id,
		int	index	)

Get a specific block attribute name.

Parameters:

	block_id	The block id
	index	The index of the attribute

Returns:

Attribute name as a str

float get_block_attribute_value	(	int	block_id,
		int	index	)

Get a specific block attribute value.

Parameters:

	block_id	The block id
	index	The index of the attribute

Returns:

List of attributes

get_block_children	(	int	block_id,
		[ int ] &	group_list,
		[ int ] &	node_list,
		[ int ] &	sphere_list,
		[ int ] &	edge_list,
		[ int ] &	tri_list,
		[ int ] &	face_list,
		[ int ] &	pyramid_list,
		[ int ] &	tet_list,
		[ int ] &	hex_list,
		[ int ] &	wedge_list,
		[ int ] &	volume_list,
		[ int ] &	surface_list,
		[ int ] &	curve_list,
		[ int ] &	vertex_list	)

Get lists of any and all possible children of a block.

A block can contain a variety of entity types. This routine will return all contents of a specified block.

Parameters:

	block_id	ID of block to examine
	group_list	User specified list where groups associated with this block are returned
	node_list	User specified list where nodes associated with this block are returned
	edge_list	User specified list where edges associated with this block are returned
	tri_list	User specified list where tris associated with this block are returned
	face_list	User specified list where faces associated with this block are returned
	pyramid_list	User specified list where pyramids associated with this block are returned
	tet_list	User specified list where tets associated with this block are returned
	hex_list	User specified list where hexes associated with this block are returned
	volume_list	User specified list where volumes associated with this block are returned
	surface_list	User specified list where surfaces associated with this block are returned
	curve_list	User specified list where curves associated with this block are returned
	vertex_list	User specified list where vertices associated with this block are returned

int get_block_count

(

)

Get the current number of blocks.

Returns:

The number of blocks in the current model, if any

[ int ] get_block_curves

(

int

block_id

)

Get a list of curve associated with a specific block.

Parameters:

block_id

User specified id of the desired block

Returns:

A list (python tuple) of curve ids contained in the block

[ int ] get_block_edges

(

int

block_id

)

Get a list of edges associated with a specific block.

Parameters:

block_id

User specified id of the desired block

Returns:

A list (python tuple) of edge ids contained in the block

int get_block_element_attribute_count

(

int

block_id

)

[ str ] get_block_element_attribute_names

(

int

block_id

)

str get_block_element_type

(

int

block_id

)

Get the element type of a block.

Parameters:

block_id

The block id

Returns:

Element type

Bool get_block_elements_and_nodes	(	int	block_id,
		[ int ] &	node_list,
		[ int ] &	sphere_list,
		[ int ] &	edge_list,
		[ int ] &	tri_list,
		[ int ] &	face_list,
		[ int ] &	pyramid_list,
		[ int ] &	wedge_list,
		[ int ] &	tet_list,
		[ int ] &	hex_list	)

Get lists of the nodes and different element types associated with this block. This function is recursive, meaning that if the block was created pointing to a piece of geometry, it will traverse down and get the mesh entities associated to that geometry.

Parameters:

block_id

User specified id of the desired block A list (python tuple) of node ids contained in the block A list (python tuple) of edge ids contained in the block A list (python tuple) of tri ids contained in the block A list (python tuple) of quad ids contained in the block A list (python tuple) of pyramid ids contained in the block A list (python tuple) of wedge ids contained in the block A list (python tuple) of tet ids contained in the block A list (python tuple) of hex ids contained in the block

Returns:

true for success, otherwise false

[ int ] get_block_faces

(

int

block_id

)

Get a list of faces associated with a specific block.

Parameters:

block_id

User specified id of the desired block

Returns:

A list (python tuple) of face ids contained in the block

[ int ] get_block_hexes

(

int

block_id

)

Get a list of hexes associated with a specific block.

Parameters:

block_id

User specified id of the desired block

Returns:

A list (python tuple) of hex ids contained in the block

int get_block_id	(	str	entity_type,
		int	entity_id	)

Get the associated block id for a specific curve, surface, or volume.

 int block_id = get_block_id("surface", 33);

 block_id = cubit.get_block_id("surface", 33)

Parameters:

	entity_type	Type of entity
	entity_id	Id of entity in question

Returns:

Block id associated with this entity or zero (0) if none

[ int ] get_block_id_list

(

)

Get a list of all blocks.

Returns:

List (python tuple) of all active block ids

[ int ] get_block_ids

(

str

mesh_geom_file_name

)

Get list of block ids from a mesh geometry file.

Parameters:

mesh_geom_file_name

Fully qualified name of a mesh geometry file

Returns:

List of block ids in the mesh geometry file

[ int ] get_block_nodes

(

int

block_id

)

Get a list of nodes associated with a specific block.

Parameters:

block_id

User specified id of the desired block

Returns:

A list (python tuple) of node ids contained in the block

[ int ] get_block_pyramids

(

int

block_id

)

Get a list of pyramids associated with a specific block.

Parameters:

block_id

User specified id of the desired block

Returns:

A list (python tuple) of pyramid ids contained in the block

[ int ] get_block_surfaces

(

int

block_id

)

Get a list of surface associated with a specific block.

Parameters:

block_id

User specified id of the desired block

Returns:

A list (python tuple) of surface ids contained in the block

[ int ] get_block_tets

(

int

block_id

)

Get a list of tets associated with a specific block.

Parameters:

block_id

User specified id of the desired block

Returns:

A list (python tuple) of tet ids contained in the block

[ int ] get_block_tris

(

int

block_id

)

Get a list of tris associated with a specific block.

Parameters:

block_id

User specified id of the desired block

Returns:

A list (python tuple) of tri ids contained in the block

[ int ] get_block_vertices

(

int

block_id

)

Get a list of vertices associated with a specific block.

Parameters:

block_id

User specified id of the desired block

Returns:

A list (python tuple) of vertex ids contained in the block

[ int ] get_block_volumes

(

int

block_id

)

Get a list of volume ids associated with a specific block.

Parameters:

block_id

User specified id of the desired block

Returns:

A list (python tuple) of volume ids contained in the block

[ int ] get_block_wedges

(

int

block_id

)

Get a list of wedges associated with a specific block.

Parameters:

block_id

User specified id of the desired block

Returns:

A list (python tuple) of wedges ids contained in the block

int get_body_count

(

)

Get the current number of bodies.

Returns:

The number of bodies in the current model, if any

Bool get_Bool_sculpt_default

(

str

variable

)

str get_boundary_layer_algorithm

(

int

id

)

Bool get_boundary_layer_aspect_first_parameters	(	int	id,
		float &	first_row_aspect,
		float &	growth_factor,
		int &	number_rows	)

Bool get_boundary_layer_aspect_last_parameters	(	int	id,
		float &	first_row_height,
		int &	number_rows,
		float &	last_row_aspect	)

Bool get_boundary_layer_continuity

(

int

id

)

Bool get_boundary_layer_curve_intersection_types	(	[ int ] &	curve_list,
		[ int ] &	volume_list,
		[ str ] &	types	)

Bool get_boundary_layer_curve_surface_pairs	(	int	id,
		[ int ] &	curve_list,
		[ int ] &	surface_list	)

[ int ] get_boundary_layer_id_list

(

)

Bool get_boundary_layer_surface_volume_pairs	(	int	id,
		[ int ] &	surface_list,
		[ int ] &	volume_list	)

Bool get_boundary_layer_uniform_parameters	(	int	id,
		float &	first_row_height,
		float &	growth_factor,
		int &	number_rows	)

Bool get_boundary_layer_vertex_intersection_types	(	[ int ] &	vertex_list,
		[ int ] &	surface_list,
		[ str ] &	types	)

[ float ] get_bounding_box	(	str	geom_type,
		int	entity_id	)

Get the bounding box for a specified entity.

 [ float ]  vector_list;
 vector_list = get_bounding_box("surface", 22);

 vector_list = cubit.get_bounding_box("surface", 22)

Parameters:

	geom_type	Specifies the geometry type of the entity
	entity_id	Specifies the id of the entity

Returns:

A vector (python tuple) of coordinates describing the entity's bounding box. Ten (10) values will be returned in axis-min, axis-max, and axis-range order, repeated for x-axis, y-axis, and z-axis and ending with the total diagonal measure.

str get_build_number

(

)

Get the Cubit build number.

Returns:

A string containing the current Cubit build number

[ float ] get_center_point	(	str	entity_type,
		int	entity_id	)

Get the center point of a specified entity.

 [ float ]  center_point;
 center_point = get_center_point("surface", 22);

 center_point = cubit.get_center_point("surface", 22)

Parameters:

	entity_type	Specifies the geometry type of the entity
	entity_id	Specifies the id of the entity

Returns:

Vector (python tuple) of floats representing x y z

int get_cfd_type

(

int

entity_id

)

Get the cfd subtype for a specified cfd BC.

Parameters:

entity_id

ID of the cfd BC

Returns:

Integer corresponding to the type of cfd, as defined by CI_BCTypes

[ int ] get_closed_narrow_surfaces	(	[ int ]	target_ids,
		float	narrow_size	)

Get the list of closed, narrow surfaces from a list of volumes.

Parameters:

	target_volume_ids	List of volume ids to examine.
	narrow_size	Indicate the narrow size threshold

Returns:

List (python tuple) of close, narrow surface ids

int get_closest_node	(	float	x,
		float	y,
		float	z	)

Get the node closest to the given coordinates.

Parameters:

	x	coordinate
	y	coordinate
	z	coordinate

Returns:

id of closest node, 0 if none found

get_closest_vertex_curve_pairs	(	[ int ]	target_ids,
		int &	num_to_return,
		[ int ] &	vert_ids,
		[ int ] &	curve_ids,
		[ float ] &	distances	)

Find the n closest vertex pairs in the model.

Given a list of volumes find the n closest vertex curve pairs. The checks will be done on a surface by surface basis so that only curve-vertex pairs within a given surface will be returned. This function is for finding the smallest features within the surfaces of the model.

Parameters:

	target_ids	List of volumes ids to examine.
	num_to_return	Number of vertex curve pairs to return.
	vert_ids	Ids of returned vertices.
	curve_ids	Ids of returned curves.
	distances	Vertex-curve pair distances.

get_coincident_entity_pairs	(	[ int ]	target_volume_ids,
		[ int ] &	v_v_vertex_list,
		[ int ] &	v_c_vertex_list,
		[ int ] &	v_c_curve_list,
		[ int ] &	v_s_vertex_list,
		[ int ] &	v_s_surf_list,
		[ float ] &	vertex_distance_list,
		[ float ] &	curve_distance_list,
		[ float ] &	surf_distance_list,
		float	low_value,
		float	hi_value,
		Bool	do_vertex_vertex = true,
		Bool	do_vertex_curve = true,
		Bool	do_vertex_surf = true,
		Bool	filter_same_volume_cases = false	)

Get the list of coincident vertex-vertex, vertex-curve, and vertex-surface pairs and distances from a list of volumes.

Given a list of volumes get lists of coincident vertex-vertex, vertex-curve, and vertex-surface pairs and their distances based on the passed-in thresholds. The returned lists will be exactly float the size of the distance lists. For each distance, 2 entities will be associated at the same relative place in the list.

Parameters:

	target_volume_ids	List of volumes ids to examine.
	do_vertex_vertex	Parameter specifying whether to do vertex-vertex check.
	do_vertex_curve	Parameter specifying whether to do vertex-curve check.
	do_vertex_surf	Parameter specifying whether to do vertex-surface check.
	v_v_vertex_list	User specified list where the ids of coincident vertex pairs are returned
	v_c_vertex_list	User specified list where the ids of the vertices of coincident vertex-curve pairs are returned
	v_c_curve_list	User specified list where the ids of the curves of coincident vertex-curve pairs are returned
	v_s_vertex_list	User specified list where the ids of the vertices of coincident vertex-surface pairs are returned
	v_s_surf_list	User specified list where the ids of the surfaces of coincident vertex-surface pairs are returned
	vertex_distance_list	User specified list where the vertex-vertex distance values will be returned
	curve_distance_list	User specified list where the vertex-curve distance values will be returned
	surf_distance_list	User specified list where the vertex-surface distance values will be returned
	low_value	User specified low threshold value
	hi_value	User specified high threshold value
	filter_same_volume_cases	Parameter specifying whether to weed out entity pairs that are in the same volume.

get_coincident_vertex_curve_pairs	(	[ int ]	target_volume_ids,
		[ int ] &	vertex_list,
		[ int ] &	curve_list,
		[ float ] &	distance_list,
		float	low_value,
		float	threshold_value,
		Bool	filter_same_volume_cases = false	)

Get the list of coincident vertex/curve pairs and distances from a list of volumes.

Given a list of volumes get a list of coincident vertex/curve pairs and their distances based on the current merge tolerance value and a threshold value. The returned lists will be of equal length and matched by order.

Parameters:

	target_volume_ids	List of vertices ids to examine.
	vertex_list	User specified list for the ids of coincident vertices
	curve_list	User specified list for the ids of coincident curves
	distance_list	User specified list where the distance values will be returned
	threshold_value	User specified threshold value

get_coincident_vertex_surface_pairs	(	[ int ]	target_volume_ids,
		[ int ] &	vertex_list,
		[ int ] &	surface_list,
		[ float ] &	distance_list,
		float	low_value,
		float	threshold_value,
		Bool	filter_same_volume_cases = false	)

Get the list of coincident vertex/surface pairs and distances from a list of volumes.

Given a list of volumes get a list of coincident vertex/pairs pairs and their distances based on the current merge tolerance value and a threshold value. The returned lists will be of equal length and matched by order.

Parameters:

	target_volume_ids	List of vertices ids to examine.
	vertex_list	User specified list for the ids of coincident vertices
	surface_list	User specified list for the ids of coincident surfaces
	distance_list	User specified list where the distance values will be returned
	threshold_value	User specified threshold value

get_coincident_vertex_vertex_pairs	(	[ int ]	target_volume_ids,
		[ int ] &	vertex_pair_list,
		[ float ] &	distance_list,
		float	low_value,
		float	threshold_value,
		Bool	filter_same_volume_cases = false	)

Get the list of coincident vertex pairs and distances from a list of volumes.

Given a list of volumes get a list of coincident vertex pairs and their distances based on the current merge tolerance value and a threshold. The returned vertex list will be exactly float the size of the distance list. For each distance, 2 vertices will be associated at the same relative place in the list.

Parameters:

	target_volume_ids	List of volumes ids to examine.
	vertex_pair_list	User specified list where the ids of coincident vertex pairs be returned
	distance_list	User specified list where the distance values will be returned
	threshold_value	User specified threshold value

[ int ] get_coincident_vertices	(	[ int ]	target_volume_ids,
		float	high_tolerance	)

Get the list of coincident vertex pairs

Parameters:

target_volume_list

List of volumes ids to examine.

Returns:

Paired list (python tuple) of vertex ids considered coincident

str get_command_from_history

(

int

command_number

)

Get a specific command from Cubit's command history buffer.

Returns:

A string which is the command at the given index

int get_common_curve_id	(	int	surface_1_id,
		int	surface_2_id	)

Given 2 surfaces, get the common curve id.

Parameters:

	surface_1_id	The id of one of the surfaces
	surface_2_id	The id of the other surface

Returns:

The id of the curve common to the two surfaces

int get_common_vertex_id	(	int	curve_1_id,
		int	curve_2_id	)

Given 2 curves, get the common vertex id.

Parameters:

	curve_1_id	The id of one of the curves
	curve_2_id	The id of the other curves

Returns:

The id of the vertex common to the two curves, 0 if there is none

[ int ] get_connectivity	(	str	entity_type,
		int	entity_id	)

Get the list of node ids contained within a mesh entity.

 [ int ]  node_id_list;
 node_id_list = get_connectivity("hex", 221);

 node_id_list = cubit.get_connectivity("hex", 221)

Parameters:

	entity_type	The mesh element type
	entity_id	The mesh element id

Returns:

List (python tuple) of node ids

str get_constraint_dependent_entity_point

(

int

constraint_id

)

Get the dependent entity of a specified constraint.

Parameters:

constraint_id

ID of the constraint

Returns:

A str indicating the dependent entity

str get_constraint_reference_point

(

int

constraint_id

)

Get the reference point of a specified constraint.

Parameters:

constraint_id

ID of the constraint

Returns:

A str indicating the reference point

str get_constraint_type

(

int

constraint_id

)

Get the type of a specified constraint.

Parameters:

constraint_id

ID of the constraint

Returns:

A str indicating the type -- Kinematic, Distributing, Rigidbody

Bool get_contact_pair_exterior_state

(

int

entity_id

)

Get the contact pair's exterior state.

/param entity_id Id of the contact pair /return The exterior state of the contact pair

float get_contact_pair_friction_value

(

int

entity_id

)

Get the contact pair's friction value.

/param entity_id Id of the contact pair /return The friction value of the contact pair

Bool get_contact_pair_general_state

(

int

entity_id

)

Get the contact pair's general state.

/param entity_id Id of the contact pair /return The general state of the contact pair

Bool get_contact_pair_tied_state

(

int

entity_id

)

Get the contact pair's tied state.

/param entity_id Id of the contact pair /return The tied state of the contact pair

float get_contact_pair_tol_lower_value

(

int

entity_id

)

Get the contact pair's lower bound tolerance value.

/param entity_id Id of the contact pair /return The tolerance value of the contact pair

float get_contact_pair_tolerance_value

(

int

entity_id

)

Get the contact pair's upper bound tolerance value.

/param entity_id Id of the contact pair /return The tolerance value of the contact pair

float get_convection_coefficient	(	int	entity_id,
		CI_BCEntityTypes	cc_type	)

Get the convection coefficient.

/param entity_id Id of the BC convection /param cc_type enum of CI_BCEntityTypes (1-normal, 5-shell top, 6-shell bottom) /return The value of the convection coefficient

[ int ] get_coordinate_systems_id_list

(

)

/brief get a list of coordinate system ids

/return List (python tuple) of ids

str get_copy_block_on_geometry_copy_setting

(

)

Get the copy nodeset on geometry copy setting.

Returns:

copy nodeset setting

str get_copy_nodeset_on_geometry_copy_setting

(

)

Get the copy nodeset on geometry copy setting.

Returns:

copy nodeset setting

str get_copy_sideset_on_geometry_copy_setting

(

)

Get the copy nodeset on geometry copy setting.

Returns:

copy nodeset setting

float get_cubit_digits_setting

(

)

Get the Cubit digits setting.

Returns:

A float containing the digits. -1 if no digits are set

CubitMessageHandler* get_cubit_message_handler

(

)

get the default message handler C++ only***

Parameters:

str get_current_journal_file

(

)

Gets the current journal file name.

Returns:

The current journal file name.

float get_curve_bias_coarse_size

(

int

curve_id

)

Get the bias coarse size of a curve

Parameters:

curve_id

Specifies the id of the curve

Returns:

The bias coarse size of the curve.

float get_curve_bias_fine_size

(

int

curve_id

)

Get the bias fine size of a curve

Parameters:

curve_id

Specifies the id of the curve

Returns:

The bias fine size of the curve.

float get_curve_bias_first_interval_fraction

(

int

curve_id

)

Get the bias first interval fraction of a curve

Parameters:

curve_id

Specifies the id of the curve

Returns:

The bias first interval fraction of the curve.

float get_curve_bias_first_interval_length

(

int

curve_id

)

Get the bias first interval length of a curve

Parameters:

curve_id

Specifies the id of the curve

Returns:

The bias first interval length of the curve.

float get_curve_bias_first_last_ratio1

(

int

curve_id

)

Get the bias first/last ratio at start of a curve

Parameters:

curve_id

Specifies the id of the curve

Returns:

The bias coarse size of the curve.

float get_curve_bias_first_last_ratio2

(

int

curve_id

)

Get the bias first/last ratio at end of a curve

Parameters:

curve_id

Specifies the id of the curve

Returns:

The bias coarse size of the curve.

Bool get_curve_bias_from_start	(	int	curve_id,
		Bool &	value	)

Get whether the bias is from the start of a curve

Parameters:

	curve_id	Specifies the id of the curve
	value	Returns whether the bias is from the start of the curve.

Returns:

True/False A curve with the curve_id exists.

Bool get_curve_bias_from_start_set

(

int

curve_id

)

Get whether the bias from the start of a curve settings has been set

Parameters:

	curve_id	Specifies the id of the curve
	value	Returns whether the bias from the start of the curve settings has been set.

Returns:

True/False A curve with the curve_id exists.

float get_curve_bias_geometric_factor

(

int

curve_id

)

Get the first bias geometric factor of a curve

Parameters:

curve_id

Specifies the id of the curve

Returns:

The bias geometric factor of the curve.

float get_curve_bias_geometric_factor2

(

int

curve_id

)

Get the second bias geometric factor of a curve

Parameters:

curve_id

Specifies the id of the curve

Returns:

The bias geometric factor of the curve.

float get_curve_bias_last_first_ratio1

(

int

curve_id

)

Get the bias last/first ratio at start of a curve

Parameters:

curve_id

Specifies the id of the curve

Returns:

The bias coarse size of the curve.

float get_curve_bias_last_first_ratio2

(

int

curve_id

)

Get the bias last/first ratio at end of a curve

Parameters:

curve_id

Specifies the id of the curve

Returns:

The bias coarse size of the curve.

int get_curve_bias_start_vertex_id

(

int

curve_id

)

Get the bias start vertex id of a curve

Parameters:

curve_id

Specifies the id of the curve

Returns:

The bias start vertex id of a curve.

str get_curve_bias_type

(

int

curve_id

)

Get the bias type of a curve

Parameters:

curve_id

Specifies the id of the curve

Returns:

The bias type of the curve.

[ float ] get_curve_center

(

int

curve_id

)

Get the center point of the arc.

Parameters:

curve_id

ID of the curve

Returns:

x, y, z center point of the curve in a vector (python tuple)

int get_curve_count

(

[ int ]

target_volume_ids

)

Get the current number of curves in the passed-in volumes.

Returns:

The number of curves in the volumes

int get_curve_count

(

)

Get the current number of curves.

Returns:

The number of curves in the current model, if any

[ int ] get_curve_edges

(

int

curve_id

)

get the list of any edge elements on a given curve

Parameters:

curve_id

User specified id of the desired curve

Returns:

A list (python tuple) of the edge element ids on the curve

float get_curve_length

(

int

curve_id

)

Get the length of a specified curve.

Parameters:

curve_id

ID of the curve

Returns:

Length of the curve

float get_curve_mesh_scheme_curvature

(

int

curve_id

)

Get the curvature mesh scheme value of a curve.

Parameters:

curve_id

Specifies the id of the curve

Returns:

The curvature mesh scheme value of a curve.

[ float ] get_curve_mesh_scheme_pinpoint_locations

(

int

curve_id

)

Get the pinpoint mesh scheme locations of a curve

Parameters:

curve_id

Specifies the id of the curve

Returns:

The pinpoint mesh scheme locations for a curve.

Bool get_curve_mesh_scheme_stretch_values	(	int	curve_id,
		float &	first_size,
		float &	factor,
		float &	last_size,
		Bool &	start,
		int &	vertex_id	)

Get the stretch mesh scheme values of a curve

Parameters:

	curve_id	Specifies the id of the curve
	first_size	Returns the first_size
	factor	Returns the factor
	last_size	Returns the last_size
	start	Returns whether the scheme is from the start of the curve.
	vertex_id	Returns the vertex id used for the start of the scheme.

Returns:

True/False A curve with the curve_id exists.

[ int ] get_curve_nodes

(

int

curv_id

)

Get list of node ids owned by a curve. Excludes nodes owned by bounding vertices.

 int curv_id = 12;
 vector int ]  curve_nodes = get_curve_nodes(curv_id);

Parameters:

curv_id

id of curve

Returns:

List (python tuple) of IDs of nodes owned by the curve

float get_curve_radius

(

int

curve_id

)

Get the radius of a specified arc.

Parameters:

curve_id

ID of the curve

Returns:

Radius of the curve

str get_curve_type

(

int

curve_id

)

Get the curve type for a specified curve.

Parameters:

curve_id

ID of the curve

Returns:

Type of curve

float get_dbl_sculpt_default

(

str

variable

)

/brief return sculpt default value

float get_default_auto_size

(

)

Get auto size needs for the current set of geometry.

str get_default_element_type

(

)

Get the current default setting for the element type that will be used when meshing.

Returns:

A string indicating the default mesh type:

• "tri" indicates a tri/tet mesh default
• "hex" indicates a quad/hex mesh default
• "none" indicates no default has been assigned

str get_default_geometry_engine

(

)

Get the name of the default modeler engine.

 str engine;
 engine = get_default_geometry_engine();

 engine = cubit.get_default_geometry_engine()

Returns:

The name of the default modeler engine in the form ACIS, CATIA, OCC, facet

str get_displacement_combine_type

(

int

entity_id

)

Get the displacement's combine type which is "Overwrite", "Average", "SmallestCombine", or "LargestCombine".

/param entity_id Id of the displacement /return The combine type for the given displacement

int get_displacement_coord_system

(

int

entity_id

)

Get the displacement's coordinate system id.

/param entity_id Id of the displacement /return The Id of the displacement's coordinate system

const int* get_displacement_dof_signs

(

int

entity_id

)

This function only available from C++*** Get the displacement's dof signs.

/param entity_id Id of the displacement /return

const float* get_displacement_dof_values

(

int

entity_id

)

This function only available from C++*** Get the displacement's dof values.

/param entity_id Id of the displacement /return

float get_distance_between	(	int	vertex_id_1,
		int	vertex_id_2	)

Get the distance between two vertices.

Parameters:

vertex_id_1

ID of vertex 1 vertex_id_2 ID of vertex 2

Returns:

distance

float get_distance_from_curve_start	(	float	x,
		float	y,
		float	z,
		int	curve_id	)

Get the distance from a point on a curve to the curve's start point.

Parameters:

	x	value of the point to measure
	y	value of the point to measure
	z	value of the point to measure
	curve_id	ID of the curve

Returns:

Distance from the xyz to the curve start

int get_edge_count

(

)

Get the count of edges in the model.

Returns:

The number of edges in the model

int get_edge_global_element_id

(

int

edge_id

)

Given a edge id, return the global element id.

 int gid = get_edge_global_element_id(22);

Parameters:

edge_id

Specifies the id of the edge

Returns:

The corresponding element id

int get_element_block

(

int

element_id

)

return the block that a given element is in.

Parameters:

element_id

The element id (i.e. the global element export id)

Returns:

block_id, the id of the containing block

int get_element_budget	(	str	element_type,
		[ int ]	entity_id_list,
		int	auto_factor	)

Get the element budget based on current size settings for a list of volumes.

Parameters:

	element_type	"hex" or "tet"
	entity_id_list	List (vector) of volume ids
	auto_factor	The current auto size factor value

Returns:

The approximate number of elements that will be generated

int get_element_count

(

)

Get the count of elements in the model.

Returns:

The number of quad, hex, tet, tri, wedge, edge, spheres, etc. which have been assigned to a block, given a global element id, and will be exported.

Bool get_element_exists

(

int

element_id

)

Check the existance of an element.

Parameters:

element_id

The element id (i.e. the global element export id)

Returns:

true or false

str get_element_type

(

int

element_id

)

return the type of a given element

Parameters:

element_id

The element id (i.e. the global element export id)

Returns:

The type

int get_element_type_id

(

int

element_id

)

return the type id of a given element

Parameters:

element_id

The element id (i.e. the global element export id)

Returns:

type_id The hex, tet, wedge, etc. id is returned.

[ int ] get_entities

(

str

entity_type

)

Get all entities of a specified type (including geometry, mesh, etc...).

 [ int ]  entity_id_list;
 entity_id_list = get_entities("volume");

 entity_id_list = cubit.get_entities("volume")

Parameters:

entity_type

Specifies the type of the entity

Returns:

A list (python tuple) of ids of the specified geometry type

int get_entity_color_index	(	str	entity_type,
		int	entity_id	)

Get the color of a specified entity.

 int color_index = get_entity_color_index("curve", 33);

 color_index = cubit.get_entity_color_index("curve", 33)

Parameters:

	entity_type	Specifies the type of the entity
	entity_id	Specifies the id of the entity

Returns:

The color of the entity

get_entity_info	(	RefEntity *	source_entity,
		str &	geom_type,
		int &	entity_id	)

Get the geometry type and id given a ref entity.

Parameters:

	source_entity	Pointer to a ref entity
	geom_type	User specified variable where the geometry type will be returned
	entity_id	User specified variable where the entity id will be returned

[ str ] get_entity_modeler_engine	(	str	geom_type,
		int	entity_id	)

Get the modeler engine type for a specified entity.

 [ str ]  engine_list;
 engine_list = get_entity_modeler_engine("surface", 47);

 engine_list = cubit.get_entity_modeler_engine("surface", 47)

Parameters:

	geom_type	Specifies the geometry type of the entity
	entity_id	Specifies the id of the entity

Returns:

A vector (python tuple) of modeler engines associated with this entity

str get_entity_name	(	str	entity_type,
		int	entity_id	)

Get the name of a specified entity.

Names returned are of two types: 1) user defined names which are actually stored in Cubit when the name is defined, and 2) 'default' names supplied by Cubit at run-time which are not stored in Cubit. The second variety of name cannot be used to query Cubit.

 str name = get_entity_name("vertex", 22);

 name = cubit.get_entity_name("vertex", 22)

Parameters:

	entity_type	Specifies the type of the entity
	entity_id	Specifies the id of the entity

Returns:

The name of the entity

str get_entity_sense	(	str	source_type,
		int	source_id,
		int	sideset_id	)

Get the sense of a sideset item.

 str sense;
 sense = get_entity_sense("face", 332, 2);

 sense = cubit.get_entity_sense("face", 332, 2)

Parameters:

	source_type	Item type - could be 'face', 'quad' or 'tri'
	source_id	ID of entity
	sideset_id	ID of the sideset

Returns:

Sense of the source_type/source_id in specified sideset

int get_error_count

(

)

Get the number of errors in the current Cubit session.

Returns:

The number of errors in the Cubit session.

int get_exodus_element_count	(	int	entity_id,
		str	entity_type	)

Get the number of elements in a exodus entity.

 int element_count = get_exodus_element_count(2, "sideset");

 element_count = cubit.get_exodus_element_count(2, "sideset")

Parameters:

	entity_id	The id of the entity
	entity_type	The type of the entity

Returns:

Number of Elements

str get_exodus_entity_description	(	str	entity_type,
		int	entity_id	)

Get the description associated with an exodus entity.

 str entity_description;
 entity_description = get_exodus_entity_description("sideset", 33);

 entity_description = cubit.get_exodus_entity_description("sideset", 33)

Parameters:

	entity_type	"block", "sideset", nodeset
	entity_id	Id of the entity in question

Returns:

Description of the entity or "" if none

str get_exodus_entity_name	(	str	entity_type,
		int	entity_id	)

Get the name associated with an exodus entity.

 str entity_name;
 entity_name = get_exodus_entity_name("sideset", 33);

 entity_name = cubit.get_exodus_entity_name("sideset", 33)

Parameters:

	entity_type	"block", "sideset", nodeset
	entity_id	Id of the entity in question

Returns:

Name of the entity or "" if none

str get_exodus_entity_type	(	str	entity_type,
		int	entity_id	)

Get the type of an exodus entity.

 str entity_description;
 entity_description = get_exodus_entity_description("sideset", 33);

 entity_description = cubit.get_exodus_entity_type("sideset", 33)

Parameters:

	entity_type	"block", "sideset", nodeset
	entity_id	Id of the entity in question

Returns:

Type of the entity or "" if none. Returns "lite" or ""

int get_exodus_id	(	str	entity_type,
		int	entity_id	)

Get the exodus/genesis id for this element.

 int exodus_id = get_exodus_id("hex", 221);

 exodus_id = cubit.get_exodus_id("hex", 221)

Parameters:

	entity_type	The mesh element type
	entity_id	The mesh element id

Returns:

Exodus id of the element if element has been written out, otherwise 0

str get_exodus_sizing_function_file_name

(

)

Get the exodus sizing function file name.

Returns:

The sizing function file name

str get_exodus_sizing_function_variable_name

(

)

Get the exodus sizing function variable name.

Returns:

The sizing function variable name

int get_exodus_variable_count	(	str	entity_type,
		int	id	)

Get the number of exodus variables in a nodeset, sideset, or block.

Parameters:

entity_type

: nodeset, sideset, or block block_id The block id

Returns:

Number of exodus variables

[ str ] get_exodus_variable_names	(	str	entity_type,
		int	id	)

Get the names of exodus variables in a nodeset, sideset, or block.

Parameters:

entity_type

: nodeset, sideset, or block block_id The block id

Returns:

Names of exodus variables

str get_exodus_version

(

)

Get the Exodus version number.

Returns:

A string containing the Exodus version number

[ int ] get_expanded_connectivity	(	str	entity_type,
		int	entity_id	)

Get the list of node ids contained within a mesh entity, including interior nodes.

 [ int ]  node_id_list;
 node_id_list = get__expanded_connectivity("hex", 221);

 node_id_list = cubit.get__expanded_connectivity("hex", 221)

Parameters:

	entity_type	The mesh element type
	entity_id	The mesh element id

Returns:

List (python tuple) of all node ids associated with the element, including interior nodes

[ float ] get_force_direction_vector

(

int

entity_id

)

Get the direction vector from a force.

/param entity_id Id of the force /return A vector (python tuple) [x,y,z] of the direction the given force is acting

float get_force_magnitude

(

int

entity_id

)

Get the force magnitude from a force.

/param entity_id Id of the force /return Magnitude of the given force

[ float ] get_force_moment_vector

(

int

entity_id

)

Get the moment vector from a force.

/param entity_id Id of the force /return A vector (python tuple) [x,y,z] of the direction of the moment for the given force

[ str ] get_geometric_owner	(	str	mesh_entity_type,
		str	mesh_entity_list	)

Get a list of geometric owners given a list of mesh entities.

 [ str ]  owner_list;
 owner_list = get_geometric_owner("quad", id_list);

 owner_list = cubit.get_geometric_owner("quad", id_list)

Parameters:

	mesh_entity_type	The type of mesh entity in the form: 'quad, 'face', 'tri', 'hex', 'tet', 'edge', 'node'
	mesh_entity_list	A string containing space delimited ids, Cubit command form (i.e. 'all', '1 to 8', '1 2 3', etc)

Returns:

A list (python tuple) of geometry owners in the form of 'surface x', 'curve y', etc.

int get_geometry_node_count	(	str	entity_type,
		int	entity_id	)

/brief Get the node count for a specific geometric entity

/param entity_type The geometry type ("surface", "curve", etc) /param entity_id The entity id /return Number of nodes in the geometry

str get_geometry_owner	(	str	entity_type,
		int	entity_id	)

Get the geometric owner of this mesh element.

 str geom_owner = get_geometry_owner("hex", 221);

 geom_owner = cubit.get_geometry_owner("hex", 221)

Parameters:

	entity_type	The mesh element type
	entity_id	The mesh element id

Returns:

Name of owner

int get_global_element_id	(	str	elem_type,
		int	id	)

Given a hex, tet, etc. id, return the global element id.

 int gid = get_global_element_id(22);

Parameters:

id

Specifies the id of the hex, tet, etc. elem_type the type of the entity

Returns:

The corresponding element id

str get_graphics_version

(

)

Get the VTK version number.

Returns:

A string containing the VTK version number

[ int ] get_group_bodies

(

int

group_id

)

Get group bodies (bodies that are children of a group).

This routine returns a list of bodies that are contained in a specified group.

Parameters:

group_id

ID of the group to examine return List (python tuple) of bodies ids contained in the specified group

get_group_children	(	int	group_id,
		[ int ] &	group_list,
		[ int ] &	body_list,
		[ int ] &	volume_list,
		[ int ] &	surface_list,
		[ int ] &	curve_list,
		[ int ] &	vertex_list,
		int &	node_count,
		int &	edge_count,
		int &	hex_count,
		int &	quad_count,
		int &	tet_count,
		int &	tri_count,
		int &	wedge_count,
		int &	pyramid_count,
		int &	sphere_count	)

Get group children.

This routine returns a list for each geometry entity type in the group. Since groups may contain both geometry and mesh entities, this routine also returns the count of any mesh entity contained in the group. For groups contained in the group, the group_list will only contain one generation. In other words, if this routine is examining Group ABC, and Group ABC contains Group XYZ and Group XYZ happens to contain other groups (which in turn may contain other groups) this routine will only return the id of Group XYZ.

Parameters:

	group_id	ID of the group to examine
	group_list	User specified list where group ids will be returned
	body_list	User specified list where body ids will be returned
	volume_list	User specified list where volume ids will be returned
	surface_list	User specified list where surface ids will be returned
	curve_list	User specified list where curve ids will be returned
	vertex_list	User specified list where vertex ids will be returned
	node_count	User specified variable where the number of nodes will be returned
	edge_count	User specified variable where the number of edges will be returned
	hex_count	User specified variable where the number of hexes will be returned
	quad_count	User specified variable where the number of quads will be returned
	tet_count	User specified variable where the number of tets will be returned
	tri_count	User specified variable where the number of tris will be returned

[ int ] get_group_curves

(

int

group_id

)

Get group curves (curves that are children of a group).

This routine returns a list of curves that are contained in a specified group.

Parameters:

group_id

ID of the group to examine return List (python tuple) of curve ids contained in the specified group

[ int ] get_group_edges

(

int

group_id

)

Get group edges (edges that are children of a group).

This routine returns a list of edges that are contained in a specified group.

Parameters:

group_id

ID of the group to examine return List (python tuple) of edge ids contained in the specified group

[ int ] get_group_groups

(

int

group_id

)

Get group groups (groups that are children of another group).

This routine returns a list a groups that are contained in a specified group.

Parameters:

group_id

ID of the group to examine return List (python tuple) of group ids contained in the specified group

[ int ] get_group_hexes

(

int

group_id

)

Get group hexes (hexes that are children of a group)

This routine returns a list of hexes that are contained in a specified group.

Parameters:

group_id

ID of the group to examine return List (python tuple) of hex ids contained in the specified group

[ int ] get_group_nodes

(

int

group_id

)

Get group nodes (nodes that are children of a group).

This routine returns a list of nodes that are contained in a specified group.

Parameters:

group_id

ID of the group to examine return List (python tuple) of node ids contained in the specified group

[ int ] get_group_pyramids

(

int

group_id

)

Get group pyramids (pyramids that are children of a group).

This routine returns a list of pyramids that are contained in a specified group.

Parameters:

group_id

ID of the group to examine return List (python tuple) of pyramid ids contained in the specified group

[ int ] get_group_quads

(

int

group_id

)

Get group quads (quads that are children of a group).

This routine returns a list of quads that are contained in a specified group.

Parameters:

group_id

ID of the group to examine return List (python tuple) of quad ids contained in the specified group

[ int ] get_group_spheres

(

int

group_id

)

Get group spheres (sphere elements that are children of a group)

This routine returns a list of spheres that are contained in a specified group.

Parameters:

group_id

ID of the group to examine return List (python tuple) of sphere ids contained in the specified group

[ int ] get_group_surfaces

(

int

group_id

)

Get group surfaces (surfaces that are children of a group).

This routine returns a list of surfaces that are contained in a specified group.

Parameters:

group_id

ID of the group to examine return List (python tuple) of surface ids contained in the specified group

[ int ] get_group_tets

(

int

group_id

)

Get group tets (tets that are children of a group).

This routine returns a list of tets that are contained in a specified group.

Parameters:

group_id

ID of the group to examine return List (python tuple) of tet ids contained in the specified group

[ int ] get_group_tris

(

int

group_id

)

Get group tris (tris that are children of a group).

This routine returns a list of tris that are contained in a specified group.

Parameters:

group_id

ID of the group to examine return List (python tuple) of tri ids contained in the specified group

[ int ] get_group_vertices

(

int

group_id

)

Get group vertices (vertices that are children of a group).

This routine returns a list of vertices that are contained in a specified group.

Parameters:

group_id

ID of the group to examine return List (python tuple) of vertex ids contained in the specified group

[ int ] get_group_volumes

(

int

group_id

)

Get group volumes (volumes that are children of a group).

This routine returns a list of volumes that are contained in a specified group.

Parameters:

group_id

ID of the group to examine return List (python tuple) of volume ids contained in the specified group

[ int ] get_group_wedges

(

int

group_id

)

Get group wedges (wedges that are children of a group).

This routine returns a list of wedges that are contained in a specified group.

Parameters:

group_id

ID of the group to examine return List (python tuple) of wedge ids contained in the specified group

float get_heatflux_on_area	(	CI_BCEntityTypes	bc_area,
		int	entity_id	)

Get the heatflux on a specified area.

/param bc_area enum of CI_BCEntityTypes. If on solid, use 4. If on thin shell, use 7 for top, 8 for bottom /param entity_id ID of the heatflux /return The value or magnitude of the specified heatflux

int get_hex_count

(

)

Get the count of hexes in the model.

Returns:

The number of hexes in the model

int get_hex_global_element_id

(

int

hex_id

)

Given a hex id, return the global element id.

 int gid = get_hex_global_element_id(22);

Parameters:

hex_id

Specifies the id of the hex

Returns:

The corresponding element id

[ int ] get_hex_sheet	(	int	node_id_1,
		int	node_id_2	)

Get the list of hex elements forming a hex sheet through the given two node ids. The nodes must be adjacent in the connectivity of the hex i.e. they form an edge of the hex.

Returns:

A list (python tuple) of hex ids in the hex sheet

float get_hydraulic_radius_surface_area

(

int

surface_id

)

Get the area of a hydraulic surface.

Parameters:

surface_id

ID of the surface

Returns:

Hydraulic area of the surface

float get_hydraulic_radius_volume_area

(

int

volume_id

)

Get the area of a hydraulic volume.

Parameters:

volume_id

ID of the volume

Returns:

Hydraulic area of the volume

int get_id_from_name

(

str

name

)

Get id for a named entity.

This routine returns an integer id for the entity whose name is passed in.

 int entity_id = get_id_from_name("member_2");

 entity_id = cubit.get_id_from_name("member_2")

Parameters:

name

Name of the entity to examine return Integer representing the entity

str get_idless_signature	(	str	type,
		int	id	)

get the idless signature of a geometric or mesh entity

Parameters:

	type	the type of the requested entity
	id	the id of the requested entity

Returns:

the idless signature i.e. curve at (1 1 0 ordinal 2)

str get_idless_signatures	(	str	type,
		[ int ]	idlist	)

get the idless signatures of a range of geometric or mesh entities

Parameters:

	type	the type of the requested entity
	idlist	a list of ids

Returns:

the idless signature i.e. curve at (1 1 0 ordinal 2) curve at (0 0 1 ordinal 1) ...

int get_int_sculpt_default

(

str

variable

)

int get_label_type

(

str

entity_type

)

/brief make calls to SVDrawTool::get_label_type

/return label type currently associated with entity_type

int get_last_id

(

str

entity_type

)

Get the id of the last created entity of the given type.

 int last_id = get_last_id("surface");

 last_id = cubit.get_last_id("surface")

Parameters:

entity_type

Type of the entity being queried

Returns:

Integer id of last created entity

[ int ] get_list_of_free_ref_entities

(

str

geom_type

)

Get all free entities of a given geometry type.

 [ int ]  free_curve_id_list;
 free_curve_id_list = get_list_of_free_ref_entities("curve");

 free_curve_id_list = cubit.get_list_of_free_ref_entities("curve")

Parameters:

geom_type

Specifies the geometry type of the free entity

Returns:

A list (python tuple) of ids of the specified geometry type

[ str ] get_material_name_list

(

)

/brief Get a list of all defined material names

/return List (python tuple) of all the material names.

float get_material_property	(	CI_MaterialProperty	mp,
		int	entity_id	)

/brief Get the specified material property value

/param mp enum of CI_MaterialProperty. 0-Elastic Modulus, 1-Shear Modulus, 2-Poisson Ratio, 3-Density, 4-Specific Heat, 5-Conductivity /param entity_id Id of the material /return Value of the specified property for that material

[ str ] get_media_name_list

(

)

/brief Get a list of all defined material names

/return List (python tuple) of all the material names.

int get_media_property

(

int

entity_id

)

/brief Get the media property value

/param entity_id Id of the media /return Value of the media property, 0 == FLUID, 1 == POROUS, 2 == SOLID

str get_merge_setting	(	str	geom_type,
		int	entity_id	)

Get the merge setting for a specified entity.

 str merge_setting = get_merge_setting("surface", 33);

 merge_setting = cubit.get_merge_setting("surface", 33)

Parameters:

	geom_type	Specifies the geometry type of the entity
	entity_id	Specifies the id of the entity

Returns:

A text string that indicates the merge setting for the entity

float get_merge_tolerance

(

)

Get the current merge tolerance value.

Returns:

The value of the current merge tolerance

[ [ int ] ] get_mergeable_curves

(

[ int ]

target_volume_ids

)

Get the list of mergeable curves from a list of volumes/bodies.

Given a list of volume ids, this will return a list of potentially mergeable curves. The returned lists include lists of the merge partners.

Parameters:

target_volume_ids

List of volume ids to examine.

Returns:

list of lists of mergeable curves (potentially more than a pair) Note: If using python, lists will be python tuples.

get_mergeable_entities	(	[ int ]	target_volume_ids,
		[ [ int ] ] &	surface_list,
		[ [ int ] ] &	curve_list,
		[ [ int ] ] &	vertex_list	)

This function only works from C++*** Get the list of mergeable entities from a list of volumes.

Given a list of volume ids, this will return 3 lists of potential merge candidates. The returned lists include lists of the merge partners.

Parameters:

	target_volume_ids	List of volume ids to examine.
	surface_list	User specified list where mergeable surfaces will be stored
	curve_list	User specified list where mergeable curves will be stored
	vertex_list	User specified list where mergeable vertices will be stored

[ [ int ] ] get_mergeable_surfaces

(

[ int ]

target_volume_ids

)

Get the list of mergeable surfaces from a list of volumes/bodies.

Given a list of volume ids, this will return a list of potentially mergeable surfaces. The returned lists include lists of the merge partners.

Parameters:

target_volume_ids

List of volume ids to examine.

Returns:

list of lists of mergeable surfaces (potentially more than a pair) Note: If using python, lists will be python tuples.

[ [ int ] ] get_mergeable_vertices

(

[ int ]

target_volume_ids

)

Get the list of mergeable vertices from a list of volumes/bodies.

Given a list of volume ids, this will return a list of potentially mergeable vertices. The returned lists include lists of the merge partners.

Parameters:

target_volume_ids

List of volume ids to examine.

Returns:

list of lists of mergeable vertices (potentially more than a pair) Note: If using python, lists will be python tuples.

float get_mesh_edge_length

(

int

edge_id

)

Get the length of a mesh edge.

Parameters:

edge_id

Specifies the id of the edge

Returns:

The length of the mesh edge

str get_mesh_element_type	(	str	entity_type,
		int	entity_id	)

Get the mesh element type contained in the specified geometry.

 str element_type = get_mesh_element_type("surface", 2);

 element_type = cubit.get_mesh_element_type("surface", 2)

Parameters:

	entity_type	The type of entity
	entity_id	The id of the entity

Returns:

Mesh element type for that entity

int get_mesh_error_count

(

)

[ str ] get_mesh_error_solutions

(

int

error_code

)

Get the paired list of mesh error solutions and help context cues.

Parameters:

error_code

The error code associated with the error solution

Returns:

List (python tuple) of 'married' strings. First string is solution text. Second string is help context cue. Third string is command_panel cue.

[ MeshErrorFeedback* ] get_mesh_errors

(

)

float get_mesh_geometry_approximation_angle	(	str	geom_type,
		int	entity_id	)

Get the geometry approximation angle set for tri/tet meshing.

Parameters:

	geom_type	either "surface" or "volume"
	entity_id	the entity id

Returns:

Boolean value as to whether or not the proximity flag is set

[ int ] get_mesh_group_parent_ids	(	str	element_type,
		int	element_id	)

Get the group ids which are parents to the indicated mesh element.

 [ int ]  parent_id_list;
 parent_id_list = get_mesh_group_parent_ids("tri", 332);

 parent_id_list = cubit.get_mesh_group_parent_ids("tri", 332)

Parameters:

	element_type	Mesh type of the element
	element_id	ID of the mesh element return List (python tuple) of group ids that contain this mesh element

str get_mesh_interval_firmness	(	str	geom_type,
		int	entity_id	)

Get the mesh interval firmness for the specified entity. This may include influence from connected mesh intervals on connected geometry.

 str firmness;
 get_mesh_interval_firmness("surface", 12);

 firmness = cubit.get_mesh_interval_firmness("surface", 12)

Parameters:

	geom_type	Specifies the geometry type of the entity
	entity_id	Specifies the id of the entity

Returns:

The entity's meshing firmness (HARD, SOFT, LIMP) HARD = set directly SOFT = computed LIMP = not set

int get_mesh_intervals	(	str	geom_type,
		int	entity_id	)

Get the interval count for a specified entity.

 int intervals = get_mesh_intervals("surface", 12);

 intervals = cubit.get_mesh_intervals("surface", 12)

Parameters:

	geom_type	Specifies the geometry type of the entity
	entity_id	Specifies the id of the entity

Returns:

The entity's interval count

str get_mesh_scheme	(	str	geom_type,
		int	entity_id	)

Get the mesh scheme for the specified entity.

 str scheme;
 get_mesh_scheme("surface", 12, scheme);

 scheme = cubit.get_mesh_scheme("surface", 12)

Parameters:

	geom_type	Specifies the geometry type of the entity
	entity_id	Specifies the id of the entity

Returns:

The entity's meshing scheme

str get_mesh_scheme_firmness	(	str	geom_type,
		int	entity_id	)

Get the mesh scheme firmness for the specified entity.

 str firmness;
 get_mesh_firmness("surface", 12);

 firmness = cubit.get_mesh_firmness("surface", 12)

Parameters:

	geom_type	Specifies the geometry type of the entity
	entity_id	Specifies the id of the entity

Returns:

The entity's meshing firmness (HARD, LIMP, SOFT)

float get_mesh_size	(	str	geom_type,
		int	entity_id	)

Get the mesh size for a specified entity.

 float mesh_size = get_mesh_size("volume", 2);

 mesh_size = cubit.get_mesh_size("volume", 2)

Parameters:

	geom_type	Specifies the geometry type of the entity
	entity_id	Specifies the id of the entity

Returns:

The entity's mesh size

str get_mesh_size_type	(	str	geom_type,
		int	entity_id	)

Get the mesh size setting type for the specified entity. This may include influence from attached geometry.

 str firmness;
 get_mesh_size_setting_type("surface", 12);

 firmness = cubit.get_mesh_size_setting_type("surface", 12)

Parameters:

	geom_type	Specifies the geometry type of the entity
	entity_id	Specifies the id of the entity

Returns:

The entity's mesh size type (USER_SET, CALCULATED, NOT_SET)

float get_meshed_volume_or_area	(	str	geom_type,
		[ int ]	entity_ids	)

Get the total volume/area of a entity's mesh.

 float area = get_meshed_volume_or_area("volume", 1);

 area = cubit.get_meshed_volume_or_area("volume", 1)

Parameters:

	geom_type	Specifies the type of entity - volume, surface, hex, tet, tri, quad
	entity_ids	A list of ids for the entity type

Returns:

The entity's meshed volume or area

str get_meshgems_version

(

)

Get the MeshGems version number.

Returns:

A string containing the MeshGems version number

float get_moment_magnitude

(

int

entity_id

)

Get the moment magnitude from a force.

/param entity_id Id of the force /return magnitude of the moment on the given force

[ int ] get_narrow_regions	(	[ int ]	target_ids,
		float	narrow_size	)

Get the list of surfaces with narrow regions.

Parameters:

	target_volume_ids	List of volume ids to examine.
	narrow_size	Indicate the size that defines 'narrowness'

Returns:

List (python tuple) of surface ids

[ int ] get_narrow_surfaces	(	[ int ]	target_volume_ids,
		float	mesh_size	)

Get the list of narrow surfaces for a list of volumes.

'Narrow' is a function of the mesh_size passed into the routine. The mesh_size parameter will act as the threshold for determining what 'narrow' is.

Parameters:

	target_volume_ids	List of volume ids to examine.
	mesh_size	Indicate the mesh size used as the threshold

Returns:

List (python tuple) of small surface ids

int get_next_block_id

(

)

Get a next available block id.

Returns:

Next available block id

int get_next_boundary_layer_id

(

)

str get_next_command_from_history

(

)

Get 'next' command from history buffer.

Returns:

A string which is the command

int get_next_group_id

(

)

Get the next available group id from Cubit.

int get_next_nodeset_id

(

)

Get a next available nodeset id.

Returns:

Next available nodeset id

int get_next_sideset_id

(

)

Get a next available sideset id.

Returns:

Next available sideset id

[ float ] get_nodal_coordinates

(

int

node_id

)

Get the nodal coordinates for a given node id.

Parameters:

node_id

The node id

Returns:

a triple (python tuple) containing the x, y, and z coordinates

Bool get_node_constraint

(

)

Query current setting for node constraint (move nodes to geometry).

Returns:

True if constrained, otherwise false

int get_node_constraint_value

(

)

Query current setting for node constraint (move nodes to geometry).

Returns:

Returns 0 (off), 1(on), 2(smart)

int get_node_count

(

)

Get the count of nodes in the model.

Returns:

The number of nodes in the model

Bool get_node_exists

(

int

node_id

)

Check the existance of a node.

Parameters:

node_id

The node id

Returns:

true or false

[ int ] get_node_faces

(

int

node_id

)

|brief Get the face/quad ids that share a node

Parameters:

node_id

The node id

Returns:

List (python tuple) of face/quad ids adjacent the node

int get_node_global_id

(

int

node_id

)

Given a node id, return the global element id that is assigned when the mesh is exported.

 int gid = get_node_global_id(22);

Parameters:

node_id

Specifies the id of the sphere

Returns:

The corresponding global node id

Bool get_node_position_fixed

(

int

node_id

)

Query "fixedness" state of node. A fixed node is not affecting by smoothing.

Parameters:

node_id

The node id

Returns:

True if constrained, otherwise false

[ int ] get_node_tris

(

int

node_id

)

|brief Get the tri ids that share a node

Parameters:

node_id

The node id

Returns:

List (python tuple) of tri ids adjacent the node

get_nodeset_children	(	int	nodeset_id,
		[ int ] &	node_list,
		[ int ] &	volume_list,
		[ int ] &	surface_list,
		[ int ] &	curve_list,
		[ int ] &	vertex_list	)

get lists of any and all possible children of a nodeset

A nodeset can contain a variety of entity types. This routine will return all contents of a specified nodeset.

Parameters:

	nodeset_id	User specified id of the desired nodeset
	node_list	User specified list where nodes associated with this nodeset are returned
	volume_list	User specified list where volumes associated with this nodeset are returned
	surface_list	User specified list where surfaces associated with this nodeset are returned
	curve_list	User specified list where curves associated with this nodeset are returned
	vertex_list	User specified list where vertices associated with this nodeset are returned

int get_nodeset_count

(

)

Get the current number of sidesets.

Returns:

The number of sidesets in the current model, if any

[ int ] get_nodeset_curves

(

int

nodeset_id

)

Get a list of curve ids associated with a specific nodeset.

Parameters:

nodeset_id

User specified id of the desired nodeset

Returns:

A list (python tuple) of curve ids contained in the nodeset

[ int ] get_nodeset_id_list

(

)

Get a list of all nodesets.

Returns:

List (python tuple) of all active nodeset ids

[ int ] get_nodeset_id_list_for_bc	(	CI_BCTypes	bc_type_in,
		int	bc_id	)

Get a list of all nodesets the specified bc is applied to.

Parameters:

	bc_type_in	Type of bc to query, as defined by enum CI_BCTypes. 1-9 is FEA, 10-30 is CFD
	bc_id	ID of the bc to query

Returns:

A list (python tuple) of nodeset ID's associated with that bc

int get_nodeset_node_count

(

int

nodeset_id

)

Get the number of nodes in a nodeset.

Parameters:

nodeset_id

The nodeset id

Returns:

Number of nodes in the nodeset

[ int ] get_nodeset_nodes

(

int

nodeset_id

)

Get a list of node ids associated with a specific nodeset. This only returns the nodes that were specifically assigned to this nodeset. If the nodeset was created as a piece of geometry, get_nodeset_nodes will not return the nodes on that geometry See also get_nodeset_nodes_inclusive.

Parameters:

nodeset_id

User specified id of the desired nodeset

Returns:

A list (python tuple) of node ids contained in the nodeset

[ int ] get_nodeset_nodes_inclusive

(

int

nodeset_id

)

Get a list of node ids associated with a specific nodeset. This includes all nodes specifically assigned to the nodeset, as well as nodes associated to a piece of geometry which was used to define the nodeset.

Parameters:

nodeset_id

User specified id of the desired nodeset

Returns:

A list (python tuple) of node ids contained in the nodeset

[ int ] get_nodeset_surfaces

(

int

nodeset_id

)

Get a list of surface ids associated with a specific nodeset.

Parameters:

nodeset_id

User specified id of the desired nodeset

Returns:

A list (python tuple) of surface ids contained in the nodeset

[ int ] get_nodeset_vertices

(

int

nodeset_id

)

Get a list of vertex ids associated with a specific nodeset.

Parameters:

nodeset_id

User specified id of the desired nodeset

Returns:

A list (python tuple) of vertex ids contained in the nodeset

[ int ] get_nodeset_volumes

(

int

nodeset_id

)

Get a list of volume ids associated with a specific nodeset.

Parameters:

nodeset_id

User specified id of the desired nodeset

Returns:

A list (python tuple) of volume ids contained in the nodeset

float get_overlap_max_angle

(

)

Get the max angle setting for calculating surface overlaps.

Returns:

The max angle setting

float get_overlap_max_gap

(

)

Get the max gap setting for calculating surface overlaps.

Returns:

The max gap setting

get_overlapping_surfaces	(	[ int ]	target_surface_ids,
		[ int ] &	surf_list_1,
		[ int ] &	surf_list_2,
		[ float ] &	distance_list,
		Bool	filter_slivers = false,
		Bool	filter_volume_overlaps = false	)

This function only works from C++*** Get the list of overlapping surfaces for a list of surfaces.

For every occurance of two overlapping surfaces, two surfaces ids are returned. Those ids are returned in the indicated lists and are aligned. In other words the first id in surf_list_1 overlaps with the first id in surf_list_2. The second id in surf_list_1 overlaps with the second id in surf_list-2, and so on.

Parameters:

	target_surface_ids	List of surface ids to examine.
	surf_list_1	User specified list where the ids of overlapping surfaces will be returned
	surf_list_2	User specified list where the ids of overlapping surfaces will be returned

get_overlapping_surfaces_in_volumes	(	[ int ]	target_volume_ids,
		[ int ] &	surf_list_1,
		[ int ] &	surf_list_2,
		[ float ] &	distance_list,
		Bool	filter_slivers = false,
		Bool	filter_volume_overlaps = false	)

This function only works from C++*** Get the list of overlapping surfaces for a list of volumes.

For every occurance of two overlapping surfaces, two surfaces ids are returned. Those ids are returned in the indicated lists and are aligned. In other words the first id in surf_list_1 overlaps with the first id in surf_list_2. The second id in surf_list_1 overlaps with the second id in surf_list-2, and so on.

Parameters:

	target_volume_ids	List of volume ids to examine.
	surf_list_1	User specified list where the ids of overlapping surfaces will be returned
	surf_list_2	User specified list where the ids of overlapping surfaces will be returned

[ int ] get_overlapping_volumes

(

[ int ]

target_volume_ids

)

Get the list of overlapping volumes for a list of volumes.

For every occurance of two overlapping volumes, two volume ids are returned in volume_list. Modulus 2 of the volume_list should always be 0 (the list should contain an even number of volume ids). The first volume id in the returned list overlaps with the second volume id. The third volume id overlaps with the fourth volume id, and so on.

Parameters:

target_volume_ids

List of volume ids to examine.

Returns:

List (python tuple) of overlapping volumes ids

int get_owning_body	(	str	geom_type,
		int	entity_id	)

Get the owning body for a specified entity.

 int body_id = get_owning_body("curve", 12);

 body_id = cubit.get_owning_body("curve", 12)

Parameters:

	geom_type	Specifies the geometry type of the entity
	entity_id	Specifies the id of the entity

Returns:

ID of the specified entity's owning body

int get_owning_volume	(	str	geom_type,
		int	entity_id	)

Get the owning volume for a specified entity.

 int volume_id = get_owning_volume("curve", 12);

 volume_id = cubit.get_owning_volume("curve", 12)

Parameters:

	geom_type	Specifies the geometry type of the entity
	entity_id	Specifies the id of the entity

Returns:

ID of the specified entity's owning volume

int get_owning_volume_by_name

(

str

entity_name

)

Get the owning volume for a specified entity.

 int volume_id = get_owning_volume_by_name("TipSurface");

 volume_id = cubit.get_owning_volume_by_name("TipSurface")

Parameters:

entity_name

Specifies the name (supplied by Cubit) of the entity

Returns:

ID of the specified entity's owning volume or 0 if name is unknown

get_owning_volume_ids	(	str	entity_type,
		[ int ] &	entity_list,
		[ int ] &	vol_ids	)

Gets the id's of the volumes that are owners of one of the specified entities.

Parameters:

	entity_type
	entity_list
	vol_ids

int get_parent_assembly_instance

(

int

assembly_id

)

Get the stored instance number of an assembly node's instance.

Parameters:

assembly_id

Id that identifies the assembly node

Returns:

Instance of the assembly node' instance

str get_parent_assembly_path

(

int

assembly_id

)

Get the stored path of an assembly node' parent.

Parameters:

assembly_id

Id that identifies the assembly node

Returns:

Path of the assembly node' parent

get_periodic_data	(	str	geom_type,
		int	entity_id,
		float &	interval,
		str &	firmness,
		int &	lower_bound,
		str &	upper_bound	)

Get the periodic data for a surface or curve.

Parameters:

	geom_type	Specifies the geometry type of the entity
	entity_id	Specifies the id of the entity
	interval	User specified variable where interval count for the specified entity is returned
	firmness	User specified variable where a firmness of 'hard', 'soft', or 'default' is returned
	lower_bound	User specified variable where the lower bound value is returned
	upper_bound	User specified variable where the upper bound value is returned

const char* get_pick_type

(

)

Get the current pick type.

Returns:

The current pick type of the graphics system

ExternalPlaybackHandler* get_playback_handler

(

)

str get_pressure_function

(

int

entity_id

)

Get the pressure function.

/param entity_id Id of the pressure /return The pressure function

float get_pressure_value

(

int

entity_id

)

Get the pressure value.

/param entity_id Id of the pressure /return The value or magnitude of the given pressure

str get_previous_command_from_history

(

)

Get 'previous' command from history buffer.

Returns:

A string which is the command

int get_pyramid_count

(

)

Get the count of pyramids in the model.

Returns:

The number of pyramids in the model

int get_pyramid_global_element_id

(

int

pyramid_id

)

Given a pyramid id, return the global element id.

 int gid = get_pyramid_global_element_id(22);

Parameters:

pyramid_id

Specifies the id of the pyramid

Returns:

The corresponding element id

int get_quad_count

(

)

Get the count of quads in the model.

Returns:

The number of quads in the model

int get_quad_global_element_id

(

int

quad_id

)

Given a quad id, return the global element id.

 int gid = get_quad_global_element_id(22);

Parameters:

quad_id

Specifies the id of the quad

Returns:

The corresponding element id

get_quality_stats	(	str	entity_type,
		[ int ]	id_list,
		str	metric_name,
		float	single_threshold,
		Bool	use_low_threshold,
		float	low_threshold,
		float	high_threshold,
		float &	min_value,
		float &	max_value,
		float &	mean_value,
		float &	std_value,
		int &	min_element_id,
		int &	max_element_id,
		[ int ] &	mesh_list,
		str &	element_type,
		int &	bad_group_id,
		Bool	make_group = false	)

Get the quality stats for a specified entity.

Parameters:

	entity_type	Specifies the geometry type of the entity
	id_list	Specifies a list of ids to work on
	metric_name	Specify the metric used to determine the quality
	single_threshold	Quality threshold value
	use_low_threshold	use threshold as lower or upper bound
	low_threshold	Quality threshold when using a lower and upper range
	high_threshold	Quality threshold when using a lower and upper range
	min_value	Quality value of the worst element
	max_value	Quality value of the best element
	mean_value	Average quality value of all elements
	std_value	Std deviationvalue of all elements
	min_element_id	ID of the worst element
	max_element_id	ID of the best element
	mesh_list	list of failed elements
	element_type	type of failed elements (does not support mixed element types)
	make_group	whether to create a group or not
	bad_group_id	ID of the created group
	min_value	User specified variable where the minimum quality value will be returned
	max_value	User specified variable where the maximum quality value will be returned
	mean_value	User specified variable where the mean quality value will be returned
	std_value	User specified variable where the standard deviation quality value will be returned

float get_quality_value	(	str	mesh_type,
		int	mesh_id,
		str	metric_name	)

Get the metric value for a specified mesh entity.

 get_quality_value("hex", 223, "skew");

Parameters:

	mesh_type	Specifies the mesh entity type (hex, tet, tri, quad)
	mesh_id	Specifies the id of the mesh entity
	metric_name	Specifies the name of the metric (skew, taper, jacobian, etc)

Returns:

The value of the quality metric

[ int ] get_relatives	(	str	source_geom_type,
		int	source_id,
		str	target_geom_type	)

Get the relatives (parents/children) of a specified entity.

This can be used to get either ancestors or predecessors for a specific entity. Only one specified entity type is returned with one use of the routine. For example, to get all surface parents associated with Curve 1, 'curve' is the source_geom_type, '1' is the source_id, and 'surface' is the target_geom_type.

 [ int ]  relative_list;
 curve_list = get_relatives("surface", 12, "curve");

 curve_list = cubit.get_relatives("surface", 12, "curve")

Parameters:

	source_geom_type	The entity type of the source entity
	source_id	The id of the source entity
	target_geom_type	The target geometry type

Returns:

A list (python tuple) of ids of the target geometry type

int get_rendering_mode

(

)

Get the current rendering mode.

Returns:

The current rendering mode of the graphics subsystem

str get_requested_mesh_interval_firmness	(	str	geom_type,
		int	entity_id	)

Get the mesh interval firmness for the specified entity as set specifically on the entity.

 str firmness;
 get_requested_mesh_interval_firmness("surface", 12);

 firmness = cubit.get_requested_mesh_interval_firmness("surface", 12)

Parameters:

	geom_type	Specifies the geometry type of the entity
	entity_id	Specifies the id of the entity

Returns:

The entity's meshing firmness (HARD, SOFT, LIMP) HARD = set directly SOFT = computed LIMP = not set

int get_requested_mesh_intervals	(	str	geom_type,
		int	entity_id	)

Get the interval count for a specified entity as set specifically on that entity.

 int intervals = get_meshed_intervals("surface", 12);

 intervals = cubit.get_meshed_intervals("surface", 12)

Parameters:

	geom_type	Specifies the geometry type of the entity
	entity_id	Specifies the id of the entity

Returns:

The entity's interval count

float get_requested_mesh_size	(	str	geom_type,
		int	id	)

Get the requested mesh size for a specified entity. This returns a size that has been set specifically on the entity and not averaged from parents.

 float mesh_size = get_requested_meshed_size("volume", 2);

 mesh_size = cubit.get_mesh_size("volume", 2)

Parameters:

	geom_type	Specifies the geometry type of the entity
	entity_id	Specifies the id of the entity

Returns:

The entity's requested mesh size

str get_requested_mesh_size_type	(	str	geom_type,
		int	entity_id	)

Get the mesh size setting type for the specified entity as set specifically on the entity.

 str firmness;
 get_requested_mesh_size_setting_type("surface", 12);

 firmness = cubit.get_requested_mesh_size_setting_type("surface", 12)

Parameters:

	geom_type	Specifies the geometry type of the entity
	entity_id	Specifies the id of the entity

Returns:

The entity's mesh size type (USER_SET, CALCULATED, NOT_SET)

str get_revision_date

(

)

Get the Cubit revision date.

Returns:

A string containing Cubit's last date of revision

int get_rubberband_shape

(

)

Get the current rubberband select mode.

Returns:

0 for box, 1, for polygon, 2 for circle

[ int ] get_selected_ids

(

)

Get a list of the currently selected ids.

Returns:

A list of the currently selected ids

get_sharp_curve_angles	(	[ int ]	target_volume_ids,
		[ int ] &	large_curve_angles,
		[ int ] &	small_curve_angles,
		[ float ] &	large_angles,
		[ float ] &	small_angles,
		float	upper_bound,
		float	lower_bound	)

Get the list of sharp curve angles for a list of volumes.

'Sharp' is a function of the upper_bound and lower_bound threshold parameters. The id of curves are returned when any angle associated with a curve is less than the lower_bound or greater than the upper_bound.

Parameters:

	target_volume_ids	List of volume ids to examine.
	large_curve_angles	User specified list where the ids of curves with curve angles will be returned
	small_curve_angles	User specified list where the ids of curves with small angles will be returned
	large_angles	User specified list where the angles associated with large_curve_angles will be returned. Angles returned are in the same order as the ids returned in large_curve_angles.
	small_angles	User specified list where the angles associated with small_curve_angles will be returned. Angles returned are in the same order as the ids returned in small_curve_angles.
	upper_bound	Upper threshold angle
	lower_bound	Lower threshold angle

get_sharp_surface_angles	(	[ int ]	target_volume_ids,
		[ int ] &	large_surface_angles,
		[ int ] &	small_surface_angles,
		[ float ] &	large_angles,
		[ float ] &	small_angles,
		float	upper_bound,
		float	lower_bound	)

Get the list of sharp surface angles for a list of volumes.

'Sharp' is a function of the upper_bound and lower_bound threshold parameters. The id of surfaces are returned when any angle associated with a surface is less than the lower_bound or greater than the upper_bound.

Parameters:

	target_volume_ids	List of volume ids to examine.
	large_surface_angles	User specified list where the ids of surfaces with large angles will be returned
	small_surface_angles	User specified list where the ids of surfaces with small angles will be returned
	large_angles	User specified list where the angles associated with large_surface_angles will be returned. Angles returned are in the same order as the ids returned in large_surface_angles.
	small_angles	User specified list where the angles associated with small_surface_angles will be returned. Angles returned are in the same order as the ids returned in small_surface_angles.
	upper_bound	Upper threshold angle
	lower_bound	Lower threshold angle

get_sideset_children	(	int	sideset_id,
		[ int ] &	face_list,
		[ int ] &	surface_list,
		[ int ] &	curve_list	)

get lists of any and all possible children of a sideset

A nodeset can contain a variety of entity types. This routine will return all contents of a specified sideset.

Parameters:

	sideset_id	User specified id of the desired sideset
	face_list	User specified list where faces associated with this sideset are returned
	surface_list	User specified list where surfaces associated with this sideset are returned
	curve_list	User specified list where curves associated with this sideset are returned

int get_sideset_count

(

)

Get the current number of sidesets.

Returns:

The number of sidesets in the current model, if any

[ int ] get_sideset_curves

(

int

sideset_id

)

Get a list of curve ids associated with a specific sideset.

Parameters:

sideset_id

User specified id of the desired sideset

Returns:

A list (python tuple) of curve ids contained in the sideset

str get_sideset_element_type

(

int

sideset_id

)

Get the element type of a sideset.

Parameters:

sideset_id

The id of the sideset to be queried

Returns:

Element type

[ int ] get_sideset_id_list

(

)

Get a list of all sidesets.

Returns:

List (python tuple) of all active sideset ids

[ int ] get_sideset_id_list_for_bc	(	CI_BCTypes	bc_type_in,
		int	bc_id	)

Get a list of all sidesets the specified bc is applied to.

Parameters:

	bc_type_in	Type of bc to query, as defined by enum CI_BCTypes. 1-9 is FEA, 10-30 is CFD
	bc_id	ID of the bc to query

Returns:

A list (python tuple) of sideset ID's associated with that bc

[ int ] get_sideset_quads

(

int

sideset_id

)

Get a list of any quads in a sideset.

A sideset can contain quadrilateral elements. This function will return those quad elements if they exist. An empty list will be returned if there are no quads in the sideset.

Parameters:

sideset_id

User specified id of the desired sideset

Returns:

A list (python tuple) of the quads in the sideset

[ int ] get_sideset_surfaces

(

int

sideset_id

)

Get a list of any surfaces in a sideset.

A sideset can contain surfaces. This function will return those surfaces if they exist. An empty list will be returned if there are no surfaces in the sideset.

Parameters:

sideset_id

User specified id of the desired sideset

Returns:

A list (python tuple) of the surfaces defining the sideset

str get_sizing_function_name	(	str	entity_type,
		int	surface_id	)

Get the sizing function name for a surface or volume.

Parameters:

	entity_type	Type (volume or surface)
	entity_id	Id of the entity

Returns:

The sizing function name (constant, curvature, interval, inverse, linear, super, test, exodus, none)

[ int ] get_small_and_narrow_surfaces	(	[ int ]	target_ids,
		float	small_area,
		float	small_curve_size	)

Get the list of small or narrow surfaces from a list of volumes.

Parameters:

	target_volume_ids	List of volume ids to examine.
	small_area	Indicate the area threshold
	small_curve_size	Indicate size for 'narrowness'

Returns:

List (python tuple) of small or narrow surface ids

[ int ] get_small_curves	(	[ int ]	target_volume_ids,
		float	mesh_size	)

Get the list of small curves for a list of volumes.

'Small' is a function of the mesh_size passed into the routine. The mesh_size parameter will act as the threshold for determining what 'small' is. A small entity is one that has an edge length smaller than mesh_size.

Parameters:

	target_volume_ids	List of volume ids to examine. in Cubit is valid as input here.
	mesh_size	Indicate the mesh size used as the threshold

Returns:

List (python tuple) of small curve ids

[ int ] get_small_loops	(	[ int ]	target_volume_ids,
		float	mesh_size	)

Get the list of close loops (surfaces) for a list of volumes.

'Small' or 'Close' is a function of the mesh_size passed into the routine. The mesh_size parameter will act as the threshold for determining what 'small' is. A small entity is one that has an edge length smaller than mesh_size.

Parameters:

	target_volume_ids	List of volume ids to examine.
	mesh_size	Indicate the mesh size used as the threshold

Returns:

List (python tuple) of close loop (surface) ids

[ int ] get_small_surfaces	(	[ int ]	target_volume_ids,
		float	mesh_size	)

Get the list of small surfaces for a list of volumes.

'Small' is a function of the mesh_size passed into the routine. The mesh_size parameter will act as the threshold for determining what 'small' is. A small entity is one that has an edge length smaller than mesh_size.

Parameters:

	target_volume_ids	List of volume ids to examine.
	mesh_size	Indicate the mesh size used as the threshold

Returns:

List (python tuple) of small surface ids

get_small_surfaces_hydraulic_radius	(	[ int ]	target_volume_ids,
		float	mesh_size,
		[ int ] &	small_surfaces,
		[ float ] &	small_radius	)

Get the list of small hydraulic radius surfaces for a list of volumes.

'Small' is a function of the mesh_size passed into the routine. The mesh_size parameter will act as the threshold for determining what 'small' is. A small entity is one that has an edge length smaller than mesh_size.

Parameters:

	target_volume_ids	List of volume ids to examine.
	mesh_size	Indicate the mesh size used as the threshold
	small_surfaces	User specified list where the ids of small surfaces will be returned
	small_radius	User specified list where the radius of each small surface will be returned. The order of the radius values is the same as the order of the returned ids.

[ int ] get_small_volumes	(	[ int ]	target_volume_ids,
		float	mesh_size	)

Get the list of small volumes from a list of volumes.

'Small' is a function of the mesh_size passed into the routine. The mesh_size parameter will act as the threshold for determining what 'small' is. A small entity is one that has an edge length smaller than mesh_size.

Parameters:

	target_volume_ids	List of volume ids to examine.
	mesh_size	Indicate the mesh size used as the threshold

Returns:

List (python tuple) of small volume ids

get_small_volumes_hydraulic_radius	(	[ int ]	target_volume_ids,
		float	mesh_size,
		[ int ] &	small_volumes,
		[ float ] &	small_radius	)

Get the list of small hydraulic radius volumes for a list of volumes.

'Small' is a function of the mesh_size passed into the routine. The mesh_size parameter will act as the threshold for determining what 'small' is. A small entity is one that has an edge length smaller than mesh_size.

Parameters:

	target_volume_ids	List of volume ids to examine.
	mesh_size	Indicate the mesh size used as the threshold
	small_volumes	User specified list where the ids of small volumes will be returned
	small_radius	User specified list where the radius of each small volume will be returned. The order of the radius values is the same as the order of the returned ids.

[ int ] get_smallest_curves	(	[ int ]	target_volume_ids,
		int	num_to_return	)

Get a list of the smallest curves in the list of volumes. The number returned is specified by 'num_to_return'.

Parameters:

	target_volume_ids	List of volume ids to examine. in Cubit is valid as input here.
	num_to_return	Indicate the number of curves to return

Returns:

List (python tuple) of smallest curve ids

get_smallest_features	(	[ int ]	target_ids,
		int &	num_to_return,
		[ int ] &	type1_list,
		[ int ] &	type2_list,
		[ int ] &	id1_list,
		[ int ] &	id2_list,
		[ float ] &	distance_list	)

Finds all of the smallest features.

Parameters:

	target_ids	The entities to query
	num_to_return	number of small features to return
	type1_list
	type2_list
	id1_list
	id2_list
	distance_list

str get_smooth_scheme	(	str	geom_type,
		int	entity_id	)

Get the smooth scheme for a specified entity.

 str smooth_scheme;
 get_smooth_scheme("curve", 122, smooth_scheme);

 smooth_scheme = cubit.get_smooth_scheme("curve", 122)

Parameters:

	geom_type	Specifies the geometry type of the entity
	entity_id	Specifies the id of the entity

Returns:

The smooth scheme associated with the entity

[ [ str ] ] get_solutions_for_blends

(

int

surface_id

)

Get the solution list for a given blend surface.

Parameters:

surface_id

the surface being queried

Returns:

Vector of three string vectors. Vector 1 will contain display strings to be shown to users. Vector 2 will contain Cubit command strings. Vector 3 will contain Cubit preview strings. Note: If using python, vectors will be python tuples.

[ str ] get_solutions_for_decomposition	(	[ int ]	volume_list,
		float	exterior_angle,
		Bool	do_imprint_merge,
		Bool	tol_imprint	)

Get the list of possible decompositions.

Parameters:

	volume_list	List of volumes to query
	exterior_angle	Threshold value for the exterior angle
	do_imprint_merge	Set to true (1) if you want the imprint and merge to be done
	tol_imprint	Set to true (1) if you want to do a tolerant imprint

[ [ str ] ] get_solutions_for_forced_sweepability	(	int	volume_id,
		[ int ] &	source_surface_id_list,
		[ int ] &	target_surface_id_list,
		float	small_curve_size = -1.0	)

This function only works from C++*** Get lists of display strings and command strings for forced sweepability solutions.

Parameters:

volume_id

id of volume source_surface_id_list list of source surface ids target_surface_id_list list of target surface ids small_curve_size optional paramtere to specify small curve size

Returns:

Vector of two string vectors. Vector 1 will contain display strings to be shown to users. Vector 2 will contain Cubit command strings. Vector 3 will contain Cubit preview strings. Note: If using this function in python, returned vectors will be python tuples.

[ [ str ] ] get_solutions_for_imprint_merge	(	int	surface_id1,
		int	surface_id2	)

Get lists of display strings and command strings for imprint/merge solutions.

Parameters:

surface_id1

overlapping surface 1 surface_id2 overlapping surface 2

Returns:

Vector of three string vectors. Vector 1 will contain display strings to be shown to users. Vector 2 will contain Cubit command strings. This second set of strings may contain concatenated strings delimited by '&&&'. In other words, one instance of command string may in fact contain multiple commands separated by the '&&&' sequence. Vector 3 will contain Cubit preview strings. Note: If using this function in python, returned vectors will be python tuples.

[ [ str ] ] get_solutions_for_near_coincident_vertex_and_curve	(	int	vertex_id,
		int	curve_id	)

Get lists of display strings and command strings for near coincident vertices and curves.

Parameters:

	vertex_id	ID of the vertex
	curve_id	ID of the curve

Returns:

Vector of three string vectors. Vector 1 will contain display strings to be shown to users. Vector 2 will contain Cubit command strings. This second set of strings may contain concatenated strings delimited by '&&&'. In other words, one instance of command string may in fact contain multiple commands separated by the '&&&' sequence. Vector 3 will contain Cubit preview strings. Note: If using this function in python, returned vectors will be python tuples.

[ [ str ] ] get_solutions_for_near_coincident_vertex_and_surface	(	int	vertex_id,
		int	surface_id	)

Get lists of display strings and command strings for near coincident vertices and surfaces.

Parameters:

	vertex_id	ID of the vertex
	surface_id	ID of the surface

Returns:

Vector of three string vectors. Vector 1 will contain display strings to be shown to users. Vector 2 will contain Cubit command strings. This second set of strings may contain concatenated strings delimited by '&&&'. In other words, one instance of command string may in fact contain multiple commands separated by the '&&&' sequence. Vector 3 will contain Cubit preview strings. Note: If using this function in python, returned vectors will be python tuples.

[ [ str ] ] get_solutions_for_near_coincident_vertices	(	int	vertex_id1,
		int	vertex_id2	)

Get lists of display strings and command strings for near coincident vertices.

Parameters:

	target_vertex_ids	Vertex list
	high_tolerance	The upper threshold tolerance value

Returns:

Vector of three string vectors. Vector 1 will contain display strings to be shown to users. Vector 2 will contain Cubit command strings. This second set of strings may contain concatenated strings delimited by '&&&'. In other words, one instance of command string may in fact contain multiple commands separated by the '&&&' sequence. Vector 3 will contain Cubit preview strings. Note: If using this function in python, returned vectors will be python tuples.

[ [ str ] ] get_solutions_for_overlapping_volumes	(	int	vol_id_1,
		int	vol_id_2,
		float	max_gap_tolerance,
		float	max_gap_angle	)

Get lists of display strings and command strings for overlapping volumes.

Parameters:

	id	of volume 1
	id	of volume 2

Returns:

Vector of three string vectors. Vector 1 will contain display strings to be shown to users. Vector 2 will contain Cubit command strings. This second set of strings may contain concatenated strings delimited by '&&&'. In other words, one instance of command string may in fact contain multiple commands separated by the '&&&' sequence. Vector 3 will contain Cubit preview strings. Note: If using this function in python, returned vectors will be python tuples.

[ [ str ] ] get_solutions_for_small_curves	(	int	curve_id,
		float	small_curve_size,
		float	mesh_size	)

Get lists of display, preview and command strings for small curve solutions.

Parameters:

	curve_id	Small curve
	small_curve_size	Threshold value used to determine what 'small' is
	mesh_size	Element size of the model

Returns:

Vector of three string vectors. Vector 1 will contain display strings to be shown to users. Vector 2 will contain Cubit command strings. Vector 3 will contain Cubit preview strings. Note: If using this function in python, returned vectors will be python tuples.

[ [ str ] ] get_solutions_for_small_surfaces	(	int	surface_id,
		float	small_curve_size,
		float	mesh_size	)

Get lists of display, preview and command strings for small surface solutions.

Parameters:

	surface_id	Small surface
	small_curve_size	Threshold value used to determine what 'small' is
	mesh_size	Element size of the model

Returns:

Vector of three string vectors. Vector 1 will contain display strings to be shown to users. Vector 2 will contain Cubit command strings. Vector 3 will contain Cubit preview strings. Note: If using this function in python, returned vectors will be python tuples.

Bool get_solutions_for_source_target	(	int	volume_id,
		[ [ int ] ] &	feasible_source_surface_id_list,
		[ [ int ] ] &	feasible_target_surface_id_list,
		[ [ int ] ] &	infeasible_source_surface_id_list,
		[ [ int ] ] &	infeasible_target_surface_id_list	)

Get a list of suggested sources and target surface ids given a specified volume.

[ [ str ] ] get_solutions_for_surfaces_with_narrow_regions	(	int	surface_id,
		float	small_curve_size,
		float	mesh_size	)

Get lists of display, preview and command strings for surfaces with narrow regions solutions.

Parameters:

	surface_id	Small surface
	small_curve_size	Threshold value used to determine what 'small' is
	mesh_size	Element size of the model

Returns:

Vector of three string vectors. Vector 1 will contain display strings to be shown to users. Vector 2 will contain Cubit command strings. Vector 3 will contain Cubit preview strings. Note: If using this function in python, returned vectors will be python tuples.

[ int ] get_source_surfaces

(

int

volume_id

)

Get a list of a volume's sweep source surfaces.

Parameters:

volume_id

Specifies the volume id

Returns:

List (python tuple) of surface ids

int get_sphere_count

(

)

Get the count of sphere elements in the model.

Returns:

The number of spheres in the model

int get_sphere_global_element_id

(

int

edge_id

)

Given a sphere id, return the global element id.

 int gid = get_sphere_global_element_id(22);

Parameters:

sphere_id

Specifies the id of the sphere

Returns:

The corresponding element id

str get_string_sculpt_default

(

str

variable

)

[ int ] get_sub_elements	(	str	entity_type,
		int	entity_id,
		int	dimension	)

Get the lower dimesion entities associated with a higher dimension entities. For example get the faces associated with a hex or the edges associated with a tri.

 [ int ]  face_id_list;
 face_id_list = get_sub_elements("hex", 221, 2);

 face_id_list = cubit.get_sub_elements("hex", 221, 2)

Parameters:

	entity_type	The mesh element type of the higher dimension entity
	entity_id	The mesh element id
	dimension	The dimension of the desired sub entities

Returns:

List (python tuple) of ids of the desired dimension

[ int, int ] get_submap_corner_types

(

int

surface_id

)

Get a list of vertex ids and the corresponding corner vertex types if the surface were defined as submap surface. There are no side affects. This does not actually assign corner types or change the underlying mesh scheme of the surface.

Parameters:

the

id of the surface

Returns:

a vector of pairs of [ id, corner_type ] The corner_types are defined as follows

UNSET_TYPE = -1, END_TYPE = 1, SIDE_TYPE, CORNER_TYPE, REVERSAL_TYPE, TRIANGLE_TYPE, NON_TRIANGLE_TYPE };

float get_surface_area

(

int

surface_id

)

Get the area of a surface.

Parameters:

surface_id

ID of the surface

Returns:

Area of the surface

[ float ] get_surface_centroid

(

int

surface_id

)

Get the surface centroid for a specified surface.

Parameters:

surface_id

ID of the surface

Returns:

surface centroid

get_surface_centroid	(	int	surface_id,
		float &	x,
		float &	y,
		float &	z	)

This function only works from C++*** Get the surface centroid for a specified surface.

Parameters:

	surface_id	ID of the surface
	x	User specified variable where the x coordinate will be returned
	y	User specified variable where the y coordinate will be returned
	z	User specified variable where the z coordinate will be returned

int get_surface_count

(

)

Get the current number of surfaces.

Returns:

The number of surfaces in the current model, if any

int get_surface_element_count

(

int

surface_id

)

Get the count of elements in a surface.

Returns:

The number of quads, and triangles in a surface. NOTE: This count does not distinguish between elements which have been put into a block or not.

[ int ] get_surface_nodes

(

int

surf_id

)

Get list of node ids owned by a surface. Excludes nodes owned by bounding curves and verts.

 int surf_id = 5;
 vector int ]  surface_nodes = get_surface_nodes(surf_id);

Parameters:

surf_id

id of surface

Returns:

List (python tuple) of IDs of nodes owned by the surface

[ float ] get_surface_normal

(

int

surface_id

)

Get the surface normal for a specified surface.

Parameters:

surface_id

ID of the surface

Returns:

surface normal at the center

get_surface_normal	(	int	surface_id,
		float &	x,
		float &	y,
		float &	z	)

This function only works for C++*** Get the surface normal for a specified surface.

Parameters:

	surface_id	ID of the surface
	x	User specified variable where the x coordinate will be returned
	y	User specified variable where the y coordinate will be returned
	z	User specified variable where the z coordinate will be returned

[ int ] get_surface_quads

(

int

surface_id

)

get the list of any quad elements on a given surface

Parameters:

surface_id

User specified id of the desired surface

Returns:

A list (python tuple) of the quad ids on the surface

str get_surface_sense

(

int

surface_id

)

Get the surface sense for a specified surface.

Parameters:

surface_id

ID of the surface

Returns:

surface sense as "Reversed" or "Forward" or "Both"

[ int ] get_surface_tris

(

int

surface_id

)

get the list of any tri elements on a given surface

Parameters:

surface_id

User specified id of the desired surface

Returns:

A list (python tuple) of the tri ids on the surface

str get_surface_type

(

int

surface_id

)

Get the surface type for a specified surface.

Parameters:

surface_id

ID of the surface

Returns:

Type of surface

[ int ] get_surfs_with_narrow_regions	(	[ int ]	target_ids,
		float	narrow_size	)

Get the list of surfaces with narrow regions.

Parameters:

	target_volume_ids	List of volume ids to examine.
	narrow_size	Indicate the size that defines 'narrowness'

Returns:

List (python tuple) of surface ids

[ int ] get_tangential_intersections	(	[ int ]	target_volume_ids,
		float	upper_bound,
		float	lower_bound	)

Get the list of bad tangential intersections for a list of volumes.

'Bad' is a function of the upper_bound and lower_bound threshold parameters. The id of surfaces are returned when any tangential angle associated with a surface is less than the lower_bound or greater than the upper_bound.

Parameters:

	target_volume_ids	List of volume ids to examine.
	upper_bound	Upper threshold angle
	lower_bound	Lower threshold angle

Returns:

List (python tuple) of surface ids associated with bad tangential angles

[ int ] get_target_surfaces

(

int

volume_id

)

Get a list of a volume's sweep target surfaces.

Parameters:

volume_id

Specifies the volume id

Returns:

List (python tuple) of surface ids

int get_tet_count

(

)

Get the count of tets in the model.

Returns:

The number of tets in the model

int get_tet_global_element_id

(

int

tet_id

)

Given a tet id, return the global element id.

 int gid = get_tet_global_element_id(22);

Parameters:

tet_id

Specifies the id of the tet

Returns:

The corresponding element id

float get_tetmesh_growth_factor

(

int

volume_id

)

Get the tetmesh growth factor.

Returns:

the volume gradation

Bool get_tetmesh_proximity_flag

(

int

volume_id

)

Get the proximity flag for tet meshing.

Parameters:

volume_id

the volume id

Returns:

Boolean value as to whether or not the proximity flag is set

int get_tetmesh_proximity_layers

(

int

volume_id

)

Get the number of proximity layers for tet meshing. This is the number of layers between close surfaces.

Parameters:

volume_id

the volume id

Returns:

Boolean value as to whether or not the proximity flag is set

[ float ] get_tight_bounding_box	(	str	geom_type,
		[ int ]	entity_list	)

Get the tight bounding box for a list of entities.

 [ float ]  vector_list;
 vector_list = get_tight_bounding_box("surface", entity_list);

 vector_list = cubit.get_tight_bounding_box("surface", entity_list)

Parameters:

	geom_type	Specifies the geometry type of the entity
	entity_list	List of ids associated with geom_type

Returns:

A vector (python tuple) of coordinates and axis (0-2) center (3-5, 6-8, 9-11) u, v, x normalized coordinate axis of the box (12-14) length in u, v, w

[ AssemblyItem ] get_top_level_assembly_items

(

)

[ float ] get_total_bounding_box	(	str	geom_type,
		[ int ]	entity_list	)

Get the bounding box for a list of entities.

 [ float ]  vector_list;
 vector_list = get_total_bounding_box("surface", entity_list);

 vector_list = cubit.get_total_bounding_box("surface", entity_list)

Parameters:

	geom_type	Specifies the geometry type of the entity
	entity_list	List of ids associated with geom_type

Returns:

A vector (python tuple) of coordinates for the entity's bounding box. Twelve (12) values will be returned in xyz set order repeated four (4) times per set.

float get_total_volume

(

[ int ]

volume_list

)

Get the total volume for a list of volume ids.

Parameters:

volume_list

List of volume ids

Returns:

The total volume of all volumes indicated in the id list

int get_tri_count

(

)

Get the count of tris in the model.

Returns:

The number of tris in the model

int get_tri_global_element_id

(

int

tri_id

)

Given a tri id, return the global element id.

 int gid = get_tri_global_element_id(22);

Parameters:

tri_id

Specifies the id of the tri

Returns:

The corresponding element id

float get_trimesh_surface_gradation

(

)

Get the global surface mesh gradation set for meshing with MeshGems.

Returns:

the surface gradation

float get_trimesh_volume_gradation

(

)

Get the global volume mesh gradation set for meshing with MeshGems.

Returns:

the volume gradation

Bool get_undo_enabled

(

)

/brief Query whether undo is currently enabled

/return True if undo is enabled, otherwise false

int get_valence

(

int

vertex_id

)

Get the valence for a specific vertex.

Parameters:

vertex_id

ID of vertex

[ str ] get_valid_block_element_types

(

int

block_id

)

Get a list of potential element types for a block.

Parameters:

block_id

The block id

Returns:

List (python tuple) of potential element types

str get_velocity_combine_type

(

int

entity_id

)

This function only available from C++*** Get the acceleration's dof values.

/param entity_id Id of the acceleration /return Get the velocity's combine type which is "Overwrite", "Average", "SmallestCombine", or "LargestCombine" /param entity_id Id of the velocity /return The combine type for the given velocity

const int* get_velocity_dof_signs

(

int

entity_id

)

This function only available from C++*** Get the velocity's dof signs.

/param entity_id Id of the velocity /return

const float* get_velocity_dof_values

(

int

entity_id

)

This function only available from C++*** Get the velocity's dof values.

/param entity_id Id of the velocity /return

str get_version

(

)

Get the Cubit version.

Returns:

A string containing the current version of Cubit

int get_vertex_count

(

)

Get the current number of vertices.

Returns:

The number of vertices in the current model, if any

int get_vertex_node

(

int

vert_id

)

Get the node owned by a vertex.

 int vert_id = 22;
 int node_id = get_vertex_node(vert_id);

Parameters:

vert_id

id of vertex

Returns:

ID of node owned by the vertex. returns -1 of doesn't exist

str get_vertex_type	(	int	surface_id,
		int	vertex_id	)

Get the Vertex Types for a specified vertex on a specified surface. Vertex types include "side", "end", "reverse", "unknown".

Parameters:

	surface_id	Id of the surface associated with the vertex
	vertex_id	Id of the vertex

Returns:

The type -- "side", "end", "reverse", or "unknown"

[ float ] get_view_at

(

)

Get the camera 'at' point.

Returns:

The xyz coordinates of the camera's current position

float get_view_distance

(

)

Get the distance from the camera to the model (from - at).

Returns:

Distance from the camera to the model

[ float ] get_view_from

(

)

Get the camera 'from' point.

Returns:

The xyz coordinates of the camera's from position

[ float ] get_view_up

(

)

Get the camera 'up' direction.

Returns:

The xyz coordinates of the camera's up direction

Bool get_vol_sphere_params	(	[ int ]	sphere_id_list,
		int &	rad_intervals,
		int &	az_intervals,
		float &	bias,
		float &	fract,
		int &	max_smooth_iterations	)

get the current sphere parameters for a sphere volume

Parameters:

	sphere_id_list	list of volume ids (should be spheres)
	rad_intervals	number of radial intervals (around circle)
	az_intervals	number of intervals from inner mapped box to surface
	bias	bias from inner mapped box to surface ( 1 increases size to boundary)
	fract	fraction of radius to use as size of interior mapped box
	max_smooth_iterations	max number of smooth iterations to perform after meshing

float get_volume_area

(

int

volume_id

)

Get the volume of a volume.

Parameters:

volume_id

ID of the volume

Returns:

Volume of the volume

int get_volume_count

(

)

Get the current number of nodesets.

Returns:

The number of nodesets in the current model, if any

int get_volume_element_count

(

int

volume_id

)

Get the count of elements in a volume.

Returns:

The number of hexes, tets, pyramids, and wedges in a volume. NOTE: This count does not distinguish between elements which have been put into a block or not.

[ [ str ] ] get_volume_gap_solutions	(	int	surface_id_1,
		int	surface_id_2	)

Get lists of display strings and command strings for gaps

Parameters:

	id	of surface 1
	id	of surface 2

Returns:

Vector of three string vectors. Vector 1 will contain display strings to be shown to users. Vector 2 will contain Cubit command strings. This second set of strings may contain concatenated strings delimited by '&&&'. In other words, one instance of command string may in fact contain multiple commands separated by the '&&&' sequence. Vector 3 will contain Cubit preview strings. Note: If using this function in python, returned vectors will be python tuples.

get_volume_gaps	(	[ int ]	target_volume_ids,
		[ int ] &	surf_list_1,
		[ int ] &	surf_list_2,
		[ float ] &	distance_list,
		float	max_gap_tolerance,
		float	max_gap_angle	)

This function only works from C++*** Get the list of gaps for a list of volumes.

For every occurance of a gap, two surfaces ids are returned. Those ids are returned in the indicated lists and are aligned. In other words the first id in surf_list_1 overlaps with the first id in surf_list_2. The second id in surf_list_1 overlaps with the second id in surf_list-2, and so on.

Parameters:

	target_volume_ids	List of volume ids to examine.
	surf_list_1	User specified list where the ids of the gap surfaces will be returned
	surf_list_2	User specified list where the ids of the gap surfaces will be returned
	distance_list	User specified list where the distance between the gap surface will be returned
	max_gap_tolerance	User specified tolerance used to find the gaps.

[ int ] get_volume_hexes

(

int

volume_id

)

get the list of any hex elements in a given volume

Parameters:

volume_id

User specified id of the desired volume

Returns:

A list (python tuple) of the hex ids in the volume

[ int ] get_volume_nodes

(

int

vol_id

)

Get list of node ids owned by a volume. Excludes nodes owned by bounding surfs, curves and verts.

 int vol_id = 1;
 vector int ]  volume_nodes = get_volume_nodes(vol_id);

Parameters:

vol_id

id of volume

Returns:

List (python tuple) of IDs of nodes owned by the volume

[ int ] get_volume_tets

(

int

volume_id

)

get the list of any tet elements in a given volume

Parameters:

volume_id

User specified id of the desired volume

Returns:

A list (python tuple) of the tet ids in the volume

[ int ] get_volumes_for_node	(	str	node_name,
		int	node_instance	)

int get_wedge_global_element_id

(

int

wedge_id

)

Given a wedge id, return the global element id.

 int gid = get_wedge_global_element_id(22);

Parameters:

wedge_id

Specifies the id of the wedge

Returns:

The corresponding element id

str get_wrt_entity	(	str	source_type,
		int	source_id,
		int	sideset_id	)

Get the with-respect-to entity.

 str wrt_entity;
 wrt_entity = get_wrt_entity("face", 332, 2);

 wrt_entity = cubit.get_wrt_entity("face", 332, 2)

Parameters:

	source_type	Item type - could be 'face', 'quad' or 'tri'
	source_id	ID of entity
	sideset_id	ID of the sideset

Returns:

'with-respect-to' entity of the source_type/source_id in specified sideset

group_list	(	[ str ] &	name_list,
		[ int ] &	id_list	)

Get the names and ids of all the groups (excluding the pick group) that are defined by the current cubit session.

Parameters:

	name_list	User specified list where the active group names will be returned
	id_list	User specified list where the ids of all active groups will be returned

int has_valid_size	(	str	geom_type,
		int	entity_id	)

Get whether an entity has a size. All entities have a size unless the auto sizing is off. If the auto sizing is off, an entity has a size only if it has been set.

Bool heatflux_is_on_shell_area	(	CI_BCEntityTypes	bc_area,
		int	entity_id	)

Determine whether a BC heatflux is on a shell area.

/param bc_area enum of CI_BCEntityTypes. Use 7 to check if on top, 8 to check if on bottom /param entity_id Id of the BC /return true if BC heatflux is on specified shell area, otherwise false

highlight	(	str	type,
		int	id	)

Highlight the given entity.

init

(

const [ str ] &

argv

)

Use init to initialize Cubit. Using a blank list as the input parameter is acceptable.

Parameters:

argv

List of start-up directives. A blank list such as [''] will suffice. See Cubit Help for details

Bool is_acis_engine_available

(

)

Bool is_assembly_metadata_attached

(

int

volume_id

)

Determine whether metadata is attached to a specified volume.

Parameters:

volume_id

ID of the volume

Returns:

True if metadata exists, otherwise false

Bool is_boundary_layer_id_available

(

int

id

)

Bool is_catia_engine_available

(

)

Determine whether catia engine is available.

Returns:

True if catia engine is available, otherwise false

Bool is_command_echoed

(

)

Check the echo flag in cubit.

Returns:

A Boolean indicating whether commands should be echoed in Cubit

Bool is_command_journaled

(

)

Check the journaling flag in cubit.

Returns:

A Boolean indicating whether commands are journaled by Cubit

Bool is_geometry_visibility_on

(

)

Get the current geometry visibility setting.

Returns:

True if scale is visible, otherwise false

Bool is_interval_count_odd

(

int

surface_id

)

Query whether a specified surface has an odd loop.

Parameters:

surface_id

Id of the surface

Returns:

True if surface is/contains an odd looop, otherwise false.

Bool is_merged	(	str	geom_type,
		int	entity_id	)

Determines whether a specified entity is merged.

 if (is_merged("surface", 137)) . . .

 if cubit.is_merged("surface", 137):

Parameters:

	geom_type	Specifies the geometry type of the entity
	entity_id	Specifies the id of the entity

Bool is_mesh_element_in_group	(	str	element_type,
		int	element_id	)

Indicates whether a mesh element is in a group.

 if (is_mesh_element_in_group("tet", 445)) ...

 if cubit.is_mesh_element_in_group("tet", 445):

Parameters:

	element_type	Mesh type of the element
	element_id	ID of the mesh element return True if in a group, otherwise false

Bool is_mesh_visibility_on

(

)

Get the current mesh visibility setting.

Returns:

True if scale is visible, otherwise false

Bool is_meshed	(	str	geom_type,
		int	entity_id	)

Determines whether a specified entity is meshed.

 if (is_meshed("surface", 137)) . . .

 if cubit.is_meshed("surface", 137):

Parameters:

	geom_type	Specifies the geometry type of the entity
	entity_id	Specifies the id of the entity

Bool is_modified

(

)

Get the modified status of the model.

Returns:

A Boolean indicating whether the model has been modified

Bool is_multi_volume

(

int

body_id

)

Query whether a specified body is a multi volume body.

Parameters:

body_id

Id of the body

Returns:

True if body contains multiple volumes, otherwise false.

Bool is_occlusion_on

(

)

Get the current occlusion mode.

Returns:

True if occlusion is on, otherwise false

Bool is_on_thin_shell	(	CI_BCTypes	bc_type_in,
		int	entity_id	)

Determine whether a BC is on a thin shell. Valid for temperature, convection and heatflux.

/param bc_type_in enum of CI_BCTypes. temperature = 4, convection = 7, heatflux = 8 /param entity_id Id of the BC /return true if BC is on thin shell element, otherwise false

Bool is_opencascade_engine_available

(

)

Bool is_part_of_list	(	int	target_id,
		[ int ]	id_list	)

Routine to check for the presence of an id in a list of ids.

Parameters:

	target_id	Target id
	id_list	List of ids

Returns:

True if target_id is member of id_list, otherwise false

Bool is_performing_undo

(

)

Check if an undo command is currently being performed.

Returns:

True or false.

Bool is_periodic	(	str	geom_type,
		int	entity_id	)

Query whether a specified surface or curve is periodic.

 if (is_periodic("surface", 22)) . . .

 if cubit.is_periodic("surface", 22):

Parameters:

	geom_type	Specifies the geometry type of the entity
	entity_id	Specifies the id of the entity

Returns:

True is entity is periodic, otherwise false

Bool is_perspective_on

(

)

Get the current perspective mode.

Returns:

True if perspective is on, otherwise false

Bool is_playback_paused_on_error

(

)

Gets whether or not playback is paused when an error occurs.

Returns:

True if playback should be paused when an error occurs.

int is_point_contained	(	str	geom_type,
		int	id,
		const [ float ] &	point	)

Determine if given point is inside, outside, on or unknown the given entity. note that this is typically used for volumes or sheet bodies.

Parameters:

geom_type

string defining geometry type (volume or body) id ID of the geometric entity point xyz triplet defining the point (note that it must be [ float ] (3)

Returns:

-1 failure, 0 outside, 1, inside, 2 on

Bool is_scale_visibility_on

(

)

Get the current scale visibility setting.

Returns:

True if scale is visible, otherwise false

Bool is_select_partial_on

(

)

Get the current select partial setting.

Returns:

True if partial select is on, otherwise false

Bool is_sheet_body

(

int

volume_id

)

Query whether a specified volume is a sheet body.

Parameters:

volume_id

Id of the volume

Returns:

True if volume is a sheet body, otherwise false

Bool is_surface_planar

(

int

surface_id

)

Bool is_surface_planer

(

int

surface_id

)

Query whether a specified surface is planer.

 if (is_surface_planar(22)) . . .

 if cubit.is_surface_planar(22):

Parameters:

surface_id

Specifies the id of the surface

Returns:

True is surface is planer, otherwise false

Bool is_undo_save_needed

(

)

Get the status of the model relative to undo checkpointing.

Returns:

A Boolean indicating whether the model has been modified

Bool is_virtual	(	str	geom_type,
		int	entity_id	)

Query virtualality for a specific entity.

 if (is_virtual("surface", 134)) . . .

 if cubit.is_virtual("surface", 134)):

Parameters:

	geom_type	Specifies the geometry type of the entity
	entity_id	Specifies the id of the entity

Bool is_visible	(	str	geom_type,
		int	entity_id	)

Query visibility for a specific entity.

 if (is_visible("volume", 4)) . . .

 if cubit.is_visible("volume", 4)):

Parameters:

	geom_type	Specifies the geometry type of the entity
	entity_id	Specifies the id of the entity

Bool is_volume_meshable

(

int

volume_id

)

Check if volume is meshable with current scheme.

Returns:

A Boolean indicating whether volume is meshable with current scheme

Bool is_working_dir_set

(

)

Create BCVizInterface for CompSimUI.

Returns:

was the -workingdir passed in from the command line

Boolean value indicating whether -working dir was set

journal_commands

(

Bool

state

)

Set the journaling flag in cubit.

Parameters:

state

A Boolean that turns journaling on (1) and off (0)

int number_undo_commands

(

)

/brief Query whether there are any undo commands to execute

/return The number of commands in the undo stack

override_journal_stream

(

JournalStreamBase *

jnl_stream

)

Override the Journal Stream in CUBIT.

Returns:

[ int ] parse_cubit_list	(	str	type,
		str	int_list	)

Parse a Cubit style entity list into a list of integers.

Users are allowed to input many variations of entities and IDs for any given command. This routine parses the input and returns a regular list of valid IDs for the specified entity type. For example: parse_cubit_list('surface', '1 to 12') parse_cubit_list('surface', 'with name "myname*"') parse_cubit_list('surface', 'in volume 5 to 23')

Parameters:

	type	The specific entity type represented by the list of entities
	int_list	The string that contains the entity list

Returns:

A vector (python tuple) of validated integers

print_cmd_options

(

)

Used to print the command line options.

print_raw_help	(	str	input_line,
		int	order_dependent,
		int	consecutive_dependent	)

Used to print out help when a ?, & or ! is pressed.

Parameters:

	input_line	The current command line being typed by the user
	order_dependent	Is set to '1' if the key pressed is not &, otherwise '0'
	consecutive_dependent	Is set to '1' if the pressed is '?', otherwise '0'

print_surface_summary_stats

(

)

Print the surface summary stats to the console.

print_volume_summary_stats

(

)

Print the volume summary stats to the console.

process_input_files

(

)

C++ only***.

[ [ float ] ] project_unit_square	(	[ [ float ] ]	pts,
		int	surf_id,
		int	quad_id,
		int	node00_id,
		int	node10_id	)

Given points in a unit square, map them to the given quad using the orientation info, then project them onto the given surface, and return their projected positions.

Parameters:

	pts	The x,y (abstract u,v) coordinates of the input points. Should be in [0,1].
	surf_id	The surface.
	quad_id	The quad.
	node00_id	The id of the node of the quad corresponding to an input point with coordinates (0,0)
	node10_id	The id of the node of the quad corresponding to an input point with coordinates (1,0)

Returns:

Return the position on the surface of each input node, in the same order as the input was given

Bool release_interface

(

CubitBaseInterface *

instance

)

Release the interface with the given name.

Parameters:

interface_name

the name of interface

remove_entity_from_group	(	int	group_id,
		int	entity_id,
		str	entity_type	)

Remove a specific entity from a specific group.

 remove_entity_from_group(3, 22, "surface");

 cubit.remove_entity_from_group(3, 22, "surface")

Parameters:

	group_id	ID of group from which the entity will be removed
	entity_id	ID of the entity to be removed from the group
	entity_type	Type of the entity to be removed from the group. Note that only geometric entities can be removed

reset_camera

(

)

reset the camera in all open windows this includes resetting the view, closing the histogram and color windows and clearing the scalar bar, highlight, and picked entities.

set_cubit_interrupt

(

Bool

interrupt

)

This sets the global flag in Cubit that stops all interruptable processes.

Parameters:

interrupt

Boolean set to TRUE if process is to be stopped

set_cubit_message_handler

(

CubitMessageHandler *

hdlr

)

redirect the output from cubit. C++ only***

Parameters:

Bool set_entity_name	(	str	entity_type,
		int	entity_id,
		str	new_name	)

Set the name of a specified entity.

 set_entity_name("vertex", 22, "new_name");

Parameters:

	entity_type	Specifies the type of the entity
	entity_id	Specifies the id of the entity
	new_name	Specifies what the name of the entity should be changed to

Returns:

true if entity was found and rename, otherwise false.

set_exit_handler

(

ExternalExitHandler *

hdlr

)

C++ only***.

Parameters:

set_label_type	(	str	entity_type,
		int	label_flag	)

/brief make calls to SVDrawTool::set_label_type

/return none.

set_max_group_id

(

int

max_group_id

)

Reset Cubit's max group id This is really dangerous to use and exists only to overcome a limitation with Cubit. Cubit keeps track of the next group id to assign. But those ids just keep incrementing in Cubit. Some of the power tools in the Cubit GUI make groups 'under the covers' for various operations. The groups are immediately deleted. But, creating those groups will cause Cubit's group id to increase and downstream journal files may be messed up because those journal files are expecting a certain ID to be available.

When using this call the user must ensure the group max_group_id is under their control. Typically, a user will create a group, use it, then immediately delete it. This call will only work if the max_group_id is the same as Cubit's max group id. If it is Cubit's max id will be reset. If not, nothing will happen.

Parameters:

max_id

ID of group to make 'max'

set_modified

(

)

Set the status of the model (is_modified() is now false). If you modify the model after you set this flag, it will register true.

set_overlap_max_angle

(

const float

max_angle

)

Set the max angle setting for calculating surface overlaps.

Parameters:

max

angle

Returns:

set_overlap_max_gap

(

const float

max_gap

)

Set the max gap setting for calculating surface overlaps.

Parameters:

max

gap

Returns:

set_playback_handler

(

ExternalPlaybackHandler *

hdlr

)

C++ only***.

Parameters:

set_playback_paused_on_error

(

Bool

pause

)

Sets whether or not playback is paused when an error occurs.

Parameters:

pause

True if playback should be paused when an error occurs.

set_progress_tool

(

ProgressTool *

progress

)

Register a progress-bar callback handler with Cubit.

Parameters:

progress

A pointer to a ProgressTool instance

set_rendering_mode

(

int

mode

)

Set the current rendering mode.

Parameters:

mode

Integer associated with the rendering mode. Options are 1,7,2,8, or 5

set_undo_saved

(

)

Set the status of the model relative to undo checkpointin.

Bool silent_cmd

(

str

input_string

)

Pass a command string into Cubit and have it executed without being verbose at the command prompt.

Passing a command into Cubit using this method will result in an immediate execution of the command. The command is passed directly to Cubit without any validation or other checking.

 silent_cmd("display");

 cubit.silent_cmd("display")

Parameters:

input_string

Pointer to a string containing a complete Cubit command

Bool temperature_is_on_shell_area	(	CI_BCTypes	bc_type,
		CI_BCEntityTypes	bc_area,
		int	entity_id	)

Determine whether a BC temperature is on a shell area. Valid for convection and temperature and on top, bottom, gradient, and middle.

/param bc_type enum of CI_BCTypes. temperature = 4, convection = 7 /param bc_area enum of CI_BCEntityTypes. Use 7 for top, 8 for bottom, 9 for gradient, 10 for middle /param entity_id Id of the BC /return true if BC temperature is on the shell area, otherwise false

Bool temperature_is_on_solid	(	CI_BCTypes	bc_type_in,
		int	entity_id	)

Determine whether a BC temperature is on a solid. Valid for convection and temperature.

/param bc_type_in enum of CI_BCTypes. temperature = 4, convection = 7 /param entity_id Id of the BC /return true if BC temperature is on a solid, otherwise false

unselect_entity	(	str	entity_type,
		int	entity_id	)

Unselect an entity that is currently selected.

Unselecting an entity will unhighlight it in the graphics window and remove it from the global pick list.

 unselect_entity("curve", 221);

 cubit.unselect_entity("curve", 221)

Parameters:

	entity_type	The type of the entity to be unselected
	entity_id	The ID of the entity to be unselected

Bool volume_contains_tets

(

int

volume_id

)

Determine whether a volume contains tets.

Returns:

Bool

Bool was_last_cmd_undoable

(

)

Report whether the last executed command was undoable.

Returns:

true if the last executed command was undoable

---

Variable Documentation

const int CI_ERROR = -1