CubitInterface Namespace Reference

A Software Developer Kit (SDK) is available, at no cost, for any interested user. Simply request the SDK from support and the download package will be placed into the user's account. The SDK includes more functions, including those for exporting meshes and managing materials. Access to the Cube-it application framework is available, enabling users to extend menus, command panels, commands, and so forth. Following is a quick reference for the most commonly used functions. The SDK includes many more functions and more detailed explanations and examples. In addition, the SDK is always current and shows current syntax.

This section of the documentation will be removed in the near future. Please refer to the SDK.

System Control and Data
void	set_progress_tool (ProgressTool *progress)
	Register a progress-bar callback handler with Cubit.
void	set_cubit_interrupt (bool interrupt)
	This sets the global flag in Cubit that stops all interruptible processes.
void	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.
bool	release_interface (CubitBaseInterface *instance)
	Release the interface with the given name.
void	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.
void	print_cmd_options ()
	Used to print the command line options.
bool	is_modified ()
	Get the modified status of the model.
void	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.
void	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.
void	journal_commands (bool state)
	Set the journaling flag in cubit.
bool	is_command_journaled ()
	Check the journaling flag in cubit.
void	override_journal_stream (JournalStreamBase *jnl_stream)
	Override the Journal Stream in CUBIT.
str	get_current_journal_file ()
	Gets the current journal file name.
[str]	get_cubfile_journal ()
bool	is_working_dir_set ()
	Create BCVizInterface for CompSimUI.
bool	cmd (const char *input_string)
	Pass a command string into Cubit.
bool	silent_cmd (const char *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 (const str &type, str int_list, bool include_sheet_bodies=false)
	Parse a Cubit style entity list into a list of integers.
void	print_raw_help (const char *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.
void	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.
void	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.
void	flush_graphics ()
	Flush the graphics.
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.
void	set_rendering_mode (int mode)
	Set the current rendering mode.
void	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.
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.
bool	exodus_sizing_function_file_exists ()
	return whether the exodus sizing funnction file exists
	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.
[float]	get_curve_mesh_scheme_pinpoint_locations (int curve_id)
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.
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.
[float]	get_surface_normal (int surface_id)
	Get the surface normal 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)
bool	get_undo_enabled ()
int	number_undo_commands ()
[str]	get_aprepro_vars ()
	Gets the current aprepro variable names.
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 geom_type, bool include_sheet_bodies=false)
	Get all geometry entities of a specified type.
[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, [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.
void	print_surface_summary_stats ()
	Print the surface summary stats to the console.
void	print_volume_summary_stats ()
	Print the volume summary stats to the console.
int	get_volume_count ()
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, 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 parser "exterior_angle" test. (draw curve with exterior_angle >90)
float	get_overlap_max_gap (void)
	Get the max gap setting for calculating surface overlaps.
void	set_overlap_max_gap (float max_gap)
	Set the max gap setting for calculating surface overlaps.
float	get_overlap_max_angle (void)
	Get the max angle setting for calculating surface overlaps.
void	set_overlap_max_angle (float max_angle)
	Set the max angle setting for calculating surface overlaps.
Geometry Repair Support
[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_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.
[int]	get_overlapping_volumes ([int] target_volume_ids)
	Get the list of overlapping volumes for 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.
[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
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.
str	get_exodus_entity_name (str entity_type, int entity_id)
	Get the current number of nodesets.
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.
[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.
[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.
[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.
void	delete_all_groups ()
	Delete all groups.
void	delete_group (int group_id)
	Delete a specific group.
void	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.
void	remove_entity_from_group (int group_id, int entity_id, str entity_type)
	Remove a specific entity from a specific group.
void	add_entity_to_group (int group_id, int entities, str entity_type)
	Add a specific entity to a specific group.
void	add_entities_to_group (int group_id, [int] entity_id, str entity_type)
	Add a list of entities to a specific group.
void	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
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 dimension 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 existence of a node.
bool	get_element_exists (int element_id)
	Check the existence 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.
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_valid_block_element_types (int block_id)
	Get a list of potential element types for a 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)
str	get_mesh_element_type (str entity_type, int entity_id)
	Get the mesh element type contained in the specified geometry.
[str]	get_mesh_error_solutions (int error_code)
	Get the paired list of mesh error solutions and help context cues.
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.
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 ()
void	set_label_type (str entity_type, int label_flag)
int	get_label_type (str entity_type)
[int]	get_coordinate_systems_id_list ()