Classes | |
class | CIObserve |
Classes that need geometry update events need to derive from this class then implement the virtual functions required. More... | |
class | AssemblyItem |
Class to implement assembly tree interface. More... | |
CubitInterface Control - Not Generally Useful | |
CUBIEXPORT void | init (const std::vector< std::string > &argv) |
CUBIEXPORT void | destroy () |
CUBIEXPORT void | process_input_files () |
CUBIEXPORT bool | prepare_next_script_line () |
CUBIEXPORT void | copy_next_script_line (std::string &buffer) |
CUBIEXPORT void | process_next_script_line () |
CUBIEXPORT void | set_exit_handler (ExternalExitHandler *hdlr) |
CUBIEXPORT void | set_playback_handler (ExternalPlaybackHandler *hdlr) |
CUBIEXPORT void | set_cubit_message_handler (CubitMessageHandler *hdlr) |
CUBIEXPORT void | set_progress_tool (ProgressTool *progress) |
const int | CI_ERROR = -1 |
System Control and Data | |
CUBIEXPORT void | set_cubit_interrupt (bool interrupt) |
This sets the global flag in Cubit that stops all interruptable processes. | |
CUBIEXPORT std::string | get_version () |
Get the Cubit version. | |
CUBIEXPORT std::string | get_revision_date () |
Get the Cubit revision date. | |
CUBIEXPORT std::string | get_build_number () |
Get the Cubit build number. | |
CUBIEXPORT std::string | get_acis_version () |
Get the Acis version number. | |
CUBIEXPORT std::string | get_exodus_version () |
Get the Exodus version number. | |
CUBIEXPORT std::string | get_graphics_version () |
Get the VTK version number. | |
CUBIEXPORT void | print_cmd_options () |
Used to print the command line options. | |
CUBIEXPORT bool | is_modified () |
Get the modified status of the model. | |
CUBIEXPORT void | set_modified (bool modified) |
Set the status of the model. | |
CUBIEXPORT bool | is_undo_save_needed () |
Get the status of the model relative to undo checkpointing. | |
CUBIEXPORT void | set_undo_saved () |
Set the status of the model relative to undo checkpointin. | |
CUBIEXPORT bool | is_command_echoed () |
Check the echo flag in cubit. | |
CUBIEXPORT bool | is_command_journaled () |
Check the journaling flag in cubit. | |
CUBIEXPORT void | cmd (const char *input_string) |
Pass a command string into Cubit. | |
CUBIEXPORT void | silent_cmd (const char *input_string) |
Pass a command string into Cubit and have it executed without being verbose at the command prompt. | |
CUBIEXPORT std::vector< int > | parse_cubit_list (const std::string &type, std::string int_list, bool include_sheet_bodies=false) |
Parse a Cubit style list of IDs (1,2,4 to 19 by 3 or all) into a list of integers. | |
CUBIEXPORT void | print_raw_help (char *input_line, int order_dependent, int consecutive_dependent) |
Used to print out help when a ?, & or ! is pressed. | |
CUBIEXPORT int | get_error_count () |
Get the number of errors in the current Cubit session. | |
Graphics Manipulation and Data | |
CUBIEXPORT double | get_view_distance () |
Get the distance from the camera to the model (from - at). | |
CUBIEXPORT std::vector< double > | get_view_at () |
Get the camera 'at' point. | |
CUBIEXPORT std::vector< double > | get_view_from () |
Get the camera 'from' point. | |
CUBIEXPORT void | unselect_entity (const std::string &entity_type, int entity_id) |
Unselect an entity and removed if from the picked list. | |
CUBIEXPORT bool | is_perspective_on () |
Get the current perspective mode. | |
CUBIEXPORT bool | is_scale_visibility_on () |
Get the current scale visibility setting. | |
CUBIEXPORT int | get_rendering_mode () |
Get the current rendering mode. | |
CUBIEXPORT int | get_pick_type () |
Get the current pick type. | |
Mesh Query Support | |
CUBIEXPORT double | get_meshed_volume_or_area (const std::string &geom_type, int entity_id) |
Get the total volume of a volume's mesh. | |
CUBIEXPORT int | get_mesh_intervals (const std::string &geom_type, int entity_id) |
Get the interval count for a specified entity. | |
CUBIEXPORT double | get_mesh_size (const std::string &geom_type, int entity_id) |
Get the mesh size for a specified entity. | |
CUBIEXPORT void | get_quality_stats (const std::string &entity_type, std::vector< int > id_list, const std::string &metric_name, double threshold, bool use_low_threshold, double &min_value, double &max_value, double &mean_value, double &std_value, std::vector< int > &mesh_list, std::string element_type, int &bad_group_id, bool make_group=false) |
Get the quality stats for a specified entity. | |
CUBIEXPORT std::string | get_mesh_scheme (const std::string &geom_type, int entity_id) |
Get the mesh scheme for the specified entity. | |
CUBIEXPORT bool | is_meshed (const std::string &geom_type, int entity_id) |
Determines whether a specified entity is meshed. | |
CUBIEXPORT bool | is_merged (const std::string &geom_type, int entity_id) |
Determines whether a specified entity is merged. | |
CUBIEXPORT std::string | get_smooth_scheme (const std::string &geom_type, int entity_id) |
Get the smooth scheme for a specified entity. | |
CUBIEXPORT int | get_hex_count () |
Get the count of hexes in the model. | |
CUBIEXPORT int | get_pyramid_count () |
Get the count of pyramids in the model. | |
CUBIEXPORT int | get_tet_count () |
Get the count of tets in the model. | |
CUBIEXPORT int | get_quad_count () |
Get the count of quads in the model. | |
CUBIEXPORT int | get_tri_count () |
Get the count of tris in the model. | |
CUBIEXPORT int | get_edge_count () |
Get the count of edges in the model. | |
CUBIEXPORT int | get_node_count () |
Get the count of nodes in the model. | |
CUBIEXPORT int | get_volume_element_count (int volume_id) |
Get the count of elements in a volume. | |
CUBIEXPORT int | get_surface_element_count (int surface_id) |
Get the count of elements in a surface. | |
CUBIEXPORT std::vector< 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. | |
Geometry Query Support | |
CUBIEXPORT bool | is_visible (const std::string &geom_type, int entity_id) |
Query visibility for a specific entity. | |
CUBIEXPORT bool | is_virtual (const std::string &geom_type, int entity_id) |
Query virtualality for a specific entity. | |
CUBIEXPORT std::vector< int > | get_source_surfaces (int volume_id) |
Get a list of a volume's sweep source surfaces. | |
CUBIEXPORT std::vector< int > | get_target_surfaces (int volume_id) |
Get a list of a volume's sweep target surfaces. | |
CUBIEXPORT int | get_common_curve_id (int surface_1_id, int surface_2_id) |
Given 2 surfaces, get the common curve id. | |
CUBIEXPORT int | get_common_vertex_id (int curve_1_id, int curve_2_id) |
Given 2 curves, get the common vertex id. | |
CUBIEXPORT std::string | get_merge_setting (const std::string &geom_type, int entity_id) |
Get the merge setting for a specified entity. | |
CUBIEXPORT std::string | get_curve_type (int curve_id) |
Get the curve type for a specified curve. | |
CUBIEXPORT std::string | get_surface_type (int surface_id) |
Get the surface type for a specified surface. | |
CUBIEXPORT void | get_surface_normal (int surface_id, double &x, double &y, double &z) |
Get the surface normal for a specified surface. | |
CUBIEXPORT void | get_surface_centroid (int surface_id, double &x, double &y, double &z) |
Get the surface centroid for a specified surface. | |
CUBIEXPORT std::vector< std::string > | get_entity_modeler_engine (const std::string &geom_type, int entity_id) |
Get the modeler engine type for a specified entity. | |
CUBIEXPORT std::vector< double > | get_bounding_box (const std::string &geom_type, int entity_id) |
Get the bounding box for a specified entity. | |
CUBIEXPORT std::vector< double > | get_total_bounding_box (const std::string &geom_type, std::vector< int > entity_list) |
Get the bounding box for a list of entities. | |
CUBIEXPORT double | get_total_volume (std::vector< int > volume_list) |
Get the total volume for a list of volume ids. | |
CUBIEXPORT std::string | get_entity_name (const std::string &geom_type, int entity_id) |
Get the name of a specified entity. | |
CUBIEXPORT int | get_entity_color_index (const std::string &entity_type, int entity_id) |
Get the color of a specified entity. | |
CUBIEXPORT bool | is_multi_volume (int body_id) |
Query whether a specified body is a multi volume body. | |
CUBIEXPORT bool | is_interval_count_odd (int surface_id) |
Query whether a specified surface has an odd loop. | |
CUBIEXPORT bool | is_periodic (const std::string &geom_type, int entity_id) |
Query whether a specified surface or curve is periodic. | |
CUBIEXPORT void | get_periodic_data (const std::string &geom_type, int entity_id, double &interval, std::string &firmness, int &lower_bound, std::string &upper_bound) |
Get the periodic data for a surface or curve. | |
CUBIEXPORT bool | get_node_constraint () |
Query current setting for node constraint (move nodes to geometry). | |
CUBIEXPORT std::vector< int > | get_relatives (const std::string &source_geom_type, int source_id, const std::string &target_geom_type) |
Get the relatives (parents/children) of a specified entity. | |
CUBIEXPORT std::vector< int > | get_adjacent_surfaces (const std::string &geom_type, int entity_id) |
Get a list of adjacent surfaces to a specified entity. | |
CUBIEXPORT std::vector< int > | get_adjacent_volumes (const std::string &geom_type, int entity_id) |
Get a list of adjacent volumes to a specified entity. | |
CUBIEXPORT std::vector< int > | get_entities (const std::string &geom_type, bool include_sheet_bodies=false) |
Get all geometry entities of a specified type. | |
CUBIEXPORT std::vector< int > | get_list_of_free_ref_entities (const std::string &geom_type) |
Get all free entities of a given geometry type. | |
CUBIEXPORT int | get_owning_body (const std::string &geom_type, int entity_id) |
Get the owning body for a specified entity. | |
CUBIEXPORT int | get_owning_volume (const std::string &geom_type, int entity_id) |
Get the owning volume for a specified entity. | |
CUBIEXPORT int | get_owning_volume_by_name (const std::string &entity_name) |
Get the owning volume for a specified entity. | |
CUBIEXPORT double | get_curve_length (int curve_id) |
Get the length of a specified curve. | |
CUBIEXPORT double | get_arc_length (int curve_id) |
Get the arc length of a specified curve. | |
CUBIEXPORT double | get_distance_from_curve_start (double x, double y, double z, int curve_id) |
Get the distance from a point on a curve to the curve's start point. | |
CUBIEXPORT double | get_curve_radius (int curve_id) |
Get the radiuis of a specified curve. | |
CUBIEXPORT double | get_surface_area (int surface_id) |
Get the area of a surface. | |
CUBIEXPORT double | get_volume_area (int volume_id) |
Get the area of a volume. | |
CUBIEXPORT double | get_hydraulic_radius_surface_area (int surface_id) |
Get the area of a hydraulic surface. | |
CUBIEXPORT double | get_hydraulic_radius_volume_area (int volume_id) |
Get the area of a hydraulic volume. | |
CUBIEXPORT std::vector< double > | get_center_point (const std::string &entity_type, int entity_id) |
Get the center point of a specified entity. | |
CUBIEXPORT int | get_valence (int vertex_id) |
Get the valence for a specific vertex. | |
CUBIEXPORT void | print_surface_summary_stats () |
Print the surface summary stats to the console. | |
CUBIEXPORT void | print_volume_summary_stats () |
Print the volume summary stats to the console. | |
CUBIEXPORT void | get_entity_info (RefEntity *source_entity, std::string &geom_type, int &entity_id) |
Get the geometry type and id given a ref entity. | |
CUBIEXPORT int | get_volume_count () |
Get the current number of volumes. | |
CUBIEXPORT int | get_surface_count () |
Get the current number of surfaces. | |
CUBIEXPORT int | get_vertex_count () |
Get the current number of vertices. | |
CUBIEXPORT int | get_curve_count () |
Get the current number of curves. | |
CUBIEXPORT bool | is_granite_engine_available () |
Determine whether pro-e/granite engine is available. | |
Geometry Repair Support | |
CUBIEXPORT void | get_small_surfaces_hydraulic_radius (std::vector< int > target_volume_ids, double mesh_size, std::vector< int > &small_surfaces, std::vector< double > &small_radius) |
Get the list of small hydraulic radius surfaces for a list of volumes. | |
CUBIEXPORT void | get_small_volumes_hydraulic_radius (std::vector< int > target_volume_ids, double mesh_size, std::vector< int > &small_volumes, std::vector< double > &small_radius) |
Get the list of small hydraulic radius volumes for a list of volumes. | |
CUBIEXPORT std::vector< int > | get_small_curves (std::vector< int > target_volume_ids, double mesh_size) |
Get the list of small curves for a list of volumes. | |
CUBIEXPORT std::vector< int > | get_small_surfaces (std::vector< int > target_volume_ids, double mesh_size) |
Get the list of small surfaces for a list of volumes. | |
CUBIEXPORT std::vector< int > | get_small_volumes (std::vector< int > target_volume_ids, double mesh_size) |
Get the list of small volumes from a list of volumes. | |
CUBIEXPORT std::vector< int > | get_blend_surfaces (std::vector< int > target_volume_ids) |
Get the list of blend surfaces for a list of volumes. | |
CUBIEXPORT std::vector< int > | get_small_loops (std::vector< int > target_volume_ids, double mesh_size) |
Get the list of close loops (surfaces) for a list of volumes. | |
CUBIEXPORT std::vector< int > | get_tangential_intersections (std::vector< int > target_volume_ids, double upper_bound, double lower_bound) |
Get the list of bad tangential intersections for a list of volumes. | |
CUBIEXPORT void | get_sharp_surface_angles (std::vector< int > target_volume_ids, std::vector< int > &large_surface_angles, std::vector< int > &small_surface_angles, std::vector< double > &large_angles, std::vector< double > &small_angles, double upper_bound, double lower_bound) |
Get the list of sharp surface angles for a list of volumes. | |
CUBIEXPORT void | get_sharp_curve_angles (std::vector< int > target_volume_ids, std::vector< int > &large_curve_angles, std::vector< int > &small_curve_angles, std::vector< double > &large_angles, std::vector< double > &small_angles, double upper_bound, double lower_bound) |
Get the list of sharp curve angles for a list of volumes. | |
CUBIEXPORT void | get_bad_geometry (std::vector< int > target_volume_ids, std::vector< int > &body_list, std::vector< int > &volume_list, std::vector< int > &surface_list, std::vector< int > &curve_list) |
Get the list of bad geometry for a list of volumes. | |
CUBIEXPORT void | get_overlapping_surfaces (std::vector< int > target_volume_ids, std::vector< int > &surf_list_1, std::vector< int > &surf_list_2) |
Get the list of overlapping surfaces for a list of volumes. | |
CUBIEXPORT void | get_overlapping_volumes (std::vector< int > target_volume_ids, std::vector< int > &volume_list) |
Get the list of overlapping volumes for a list of volumes. | |
CUBIEXPORT void | get_mergeable_entities (std::vector< int > target_volume_ids, std::vector< std::vector< int > > &surface_list, std::vector< std::vector< int > > &curve_list, std::vector< std::vector< int > > &vertex_list) |
Get the list of mergeable entities from a list of volumes. | |
Blocks, Sidesets, and Nodesets | |
CUBIEXPORT std::string | get_exodus_entity_name (std::string entity_type, int entity_id) |
Get the name associated with an exodus entity. | |
CUBIEXPORT std::string | get_exodus_entity_description (std::string entity_type, int entity_id) |
Get the description associated with an exodus entity. | |
CUBIEXPORT std::vector< double > | get_all_exodus_times (const std::string &filename) |
Open an exodus file and get a vector of all stored time stamps. | |
CUBIEXPORT int | get_block_id (std::string entity_type, int entity_id) |
Get the associated block id for a specific curve, surface, or volume. | |
CUBIEXPORT std::vector< int > | get_block_ids (const std::string &mesh_geom_file_name) |
Get list of block ids from a mesh geometry file. | |
CUBIEXPORT std::vector< int > | get_block_id_list () |
Get a list of all blocks. | |
CUBIEXPORT std::vector< int > | get_nodeset_id_list () |
Get a list of all nodesets. | |
CUBIEXPORT std::vector< int > | get_sideset_id_list () |
Get a list of all sidesets. | |
CUBIEXPORT int | get_next_sideset_id () |
Get a next available sideset id. | |
CUBIEXPORT int | get_next_nodeset_id () |
Get a next available nodeset id. | |
CUBIEXPORT int | get_next_block_id () |
Get a next available block id. | |
CUBIEXPORT void | get_block_children (int block_id, std::vector< int > &group_list, std::vector< int > &node_list, std::vector< int > &edge_list, std::vector< int > &tri_list, std::vector< int > &face_list, std::vector< int > &pyramid_list, std::vector< int > &tet_list, std::vector< int > &hex_list, std::vector< int > &volume_list, std::vector< int > &surface_list, std::vector< int > &curve_list, std::vector< int > &vertex_list) |
Get lists of any and all possible children of a block. | |
CUBIEXPORT void | get_nodeset_children (int nodeset_id, std::vector< int > &node_list, std::vector< int > &volume_list, std::vector< int > &surface_list, std::vector< int > &curve_list, std::vector< int > &vertex_list) |
get lists of any and all possible children of a nodeset | |
CUBIEXPORT void | get_sideset_children (int sideset_id, std::vector< int > &face_list, std::vector< int > &surface_list, std::vector< int > &curve_list) |
get lists of any and all possible children of a sideset | |
CUBIEXPORT std::vector< int > | get_block_groups (int block_id) |
Get a list of group ids associated with a specific block. | |
CUBIEXPORT std::vector< int > | get_block_volumes (int block_id) |
Get a list of volume ids associated with a specific block. | |
CUBIEXPORT std::vector< int > | get_block_surfaces (int block_id) |
Get a list of surface associated with a specific block. | |
CUBIEXPORT std::vector< int > | get_block_curves (int block_id) |
Get a list of curve associated with a specific block. | |
CUBIEXPORT std::vector< int > | get_block_vertices (int block_id) |
Get a list of vertices associated with a specific block. | |
CUBIEXPORT std::vector< int > | get_block_nodes (int block_id) |
Get a list of nodes associated with a specific block. | |
CUBIEXPORT std::vector< int > | get_block_edges (int block_id) |
Get a list of edges associated with a specific block. | |
CUBIEXPORT std::vector< int > | get_block_tris (int block_id) |
Get a list of tris associated with a specific block. | |
CUBIEXPORT std::vector< int > | get_block_faces (int block_id) |
Get a list of faces associated with a specific block. | |
CUBIEXPORT std::vector< int > | get_block_pyramids (int block_id) |
Get a list of pyramids associated with a specific block. | |
CUBIEXPORT std::vector< int > | get_block_tets (int block_id) |
Get a list of tets associated with a specific block. | |
CUBIEXPORT std::vector< int > | get_block_hexes (int block_id) |
Get a list of hexes associated with a specific block. | |
CUBIEXPORT std::vector< int > | get_nodeset_volumes (int nodeset_id) |
Get a list of volume ids associated with a specific nodeset. | |
CUBIEXPORT std::vector< int > | get_nodeset_surfaces (int nodeset_id) |
Get a list of surface ids associated with a specific nodeset. | |
CUBIEXPORT std::vector< int > | get_nodeset_curves (int nodeset_id) |
Get a list of curve ids associated with a specific nodeset. | |
CUBIEXPORT std::vector< int > | get_nodeset_vertices (int nodeset_id) |
Get a list of vertex ids associated with a specific nodeset. | |
CUBIEXPORT std::vector< int > | get_nodeset_nodes (int nodeset_id) |
Get a list of node ids associated with a specific nodeset. | |
CUBIEXPORT std::vector< int > | get_sideset_curves (int sideset_id) |
Get a list of curve ids associated with a specific sideset. | |
CUBIEXPORT std::vector< int > | get_sideset_surfaces (int sideset_id) |
Get a list of any surfaces in a sideset. | |
CUBIEXPORT std::vector< int > | get_sideset_quads (int sideset_id) |
Get a list of any quads in a sideset. | |
CUBIEXPORT std::vector< int > | get_surface_quads (int surface_id) |
get the list of any quad elements on a given surface | |
CUBIEXPORT std::string | get_entity_sense (std::string source_type, int source_id, int sideset_id) |
Get the sense of a sideset item. | |
CUBIEXPORT std::string | get_wrt_entity (std::string source_type, int source_id, int sideset_id) |
Get the with-respect-to entity. | |
CUBIEXPORT bool | is_using_shells (int sideset_id) |
Get the shell use for a sideset. | |
CUBIEXPORT std::vector< std::string > | get_geometric_owner (std::string mesh_entity_type, std::string mesh_entity_list) |
Get a list of geometric owners given a list of mesh entities. | |
Group Support | |
CUBIEXPORT int | get_id_from_name (const std::string &name) |
Get id for a named entity. | |
CUBIEXPORT void | get_group_children (int group_id, std::vector< int > &group_list, std::vector< int > &body_list, std::vector< int > &volume_list, std::vector< int > &surface_list, std::vector< int > &curve_list, std::vector< int > &vertex_list, int &node_count, int &edge_count, int &hex_count, int &quad_count, int &tet_count, int &tri_count) |
Get group children. | |
CUBIEXPORT std::vector< int > | get_group_groups (int group_id) |
Get group groups (groups that are children of another group). | |
CUBIEXPORT std::vector< int > | get_group_volumes (int group_id) |
Get group volumes (volumes that are children of a group). | |
CUBIEXPORT std::vector< int > | get_group_surfaces (int group_id) |
Get group surfaces (surfaces that are children of a group). | |
CUBIEXPORT std::vector< int > | get_group_curves (int group_id) |
Get group curves (curves that are children of a group). | |
CUBIEXPORT std::vector< int > | get_group_vertices (int group_id) |
Get group vertices (vertices that are children of a group). | |
CUBIEXPORT std::vector< int > | get_group_nodes (int group_id) |
Get group nodes (nodes that are children of a group). | |
CUBIEXPORT std::vector< int > | get_group_edges (int group_id) |
Get group edges (edges that are children of a group). | |
CUBIEXPORT std::vector< int > | get_group_quads (int group_id) |
Get group quads (quads that are children of a group). | |
CUBIEXPORT std::vector< int > | get_group_tris (int group_id) |
Get group tris (tris that are children of a group). | |
CUBIEXPORT std::vector< int > | get_group_tets (int group_id) |
Get group tets (tets that are children of a group). | |
CUBIEXPORT std::vector< int > | get_group_hexes (int group_id) |
Get group hexes (hexes that are children of a group). | |
CUBIEXPORT void | delete_all_groups () |
Delete all groups. | |
CUBIEXPORT void | delete_group (int group_id) |
Delete a specific group. | |
CUBIEXPORT void | remove_entity_from_group (int group_id, int entity_id, const std::string &entity_type) |
Remove a specific entity from a specific group. | |
CUBIEXPORT void | group_list (std::vector< std::string > &name_list, std::vector< int > &id_list) |
Get the names and ids of all the groups (excluding the pick group) that are defined by the current cubit session. | |
CUBIEXPORT std::vector< int > | get_mesh_group_parent_ids (const std::string &element_type, int element_id) |
Get the group ids which are parents to the indicated mesh element. | |
CUBIEXPORT bool | is_mesh_element_in_group (const std::string &element_type, int element_id) |
Indicates whether a mesh element is in a group. | |
General Purpose Utility | |
CUBIEXPORT bool | is_part_of_list (int target_id, std::vector< int > id_list) |
Routine to check for the presence of an id in a list of ids. | |
CUBIEXPORT int | get_last_id (const std::string &entity_type) |
Get the id of the last created entity of the given type. | |
Metadata Support | |
CUBIEXPORT std::string | get_assembly_metadata (int volume_id, int data_type) |
Get metadata for a specified volume id. | |
CUBIEXPORT bool | is_assembly_metadata_attached (int volume_id) |
Determine whether metadata is attached to a specified volume. | |
CUBIEXPORT std::string | get_assembly_name (const std::string assembly_path) |
Get the stored name of an assembly node. | |
CUBIEXPORT std::string | get_assembly_description (const std::string assembly_path) |
Get the stored description of an assembly node. | |
CUBIEXPORT int | get_assembly_instance (const std::string assembly_path) |
Get the stored instance number of an assembly node. | |
CUBIEXPORT std::string | get_assembly_file_format (const std::string assembly_path) |
Get the stored file format of an assembly node. | |
CUBIEXPORT std::string | get_assembly_units (const std::string assembly_path) |
Get the stored units measure of an assembly node. | |
CUBIEXPORT std::string | get_assembly_material_description (const std::string assembly_path) |
Get the stored material description of an assembly part. | |
CUBIEXPORT std::string | get_assembly_material_specification (const std::string assembly_path) |
Get the stored material specification of an assembly part. | |
Mesh Element Queries | |
CUBIEXPORT int | get_exodus_id (const std::string &entity_type, int entity_id) |
Get the exodus/genesis id for this element. | |
CUBIEXPORT std::string | get_geometry_owner (const std::string &entity_type, int entity_id) |
Get the geometric owner of this mesh element. | |
CUBIEXPORT std::vector< int > | get_connectivity (const std::string &entity_type, int entity_id) |
Get the list of node ids contained within a mesh entity. | |
CUBIEXPORT std::vector< int > | get_sub_elements (const std::string &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. | |
CUBIEXPORT std::vector< double > | get_nodal_coordinates (int node_id) |
Get the nodal coordinates for a given node id. | |
CUBIEXPORT std::string | get_block_element_type (int block_id) |
Get the element type of a block. | |
CUBIEXPORT int | get_exodus_element_count (int entity_id, std::string entity_type) |
Get the number of elements in a exodus entity. | |
CUBIEXPORT int | get_block_attribute_count (int block_id) |
Get the number of attributes in a block. | |
CUBIEXPORT double | get_block_attribute_value (int block_id, int index) |
Get a specific block attribute value. | |
CUBIEXPORT std::vector< std::string > | get_valid_block_element_types (int block_id) |
Get a list of potential element types for a block. | |
CUBIEXPORT int | get_nodeset_node_count (int nodeset_id) |
Get the number of nodes in a nodeset. | |
Functions | |
CUBIEXPORT std::vector< AssemblyItem * > | get_assembly_items () |
CUBIEXPORT std::vector< int > | get_volumes_for_node (std::string node_name, int node_instance) |
The purpose of CubitInterface is to provide developers with a query interface into Cubit. With very few exceptions, the functions in CubitInterface will not change Cubit's state. The function, "set_cubit_interrupt" will set a global flag indicating to Cubit that interruptable processes may be halted. Also, the functions "cmd" and "silent_cmd" take actual Cubit command-line directives as input. All other functions provide query access into Cubit.
Most function prototypes are easy to understand. A few are more ambiguous and for those some examples are provided. Note that input parameters that require entity types, such as "volume", "quad", "curve", and so forth, expect lower case spellings of those entity types.
Examples are provided for C++ and python developers.
|
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.
|
|
|
|
Delete all groups.
|
|
Delete a specific group.
|
|
|
|
Get the Acis version number.
|
|
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.
|
|
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.
|
|
Open an exodus file and get a vector of all stored time stamps.
|
|
Get the arc length of a specified curve.
|
|
Get the stored description of an assembly node.
|
|
Get the stored file format of an assembly node.
|
|
Get the stored instance number of an assembly node.
|
|
|
|
Get the stored material description of an assembly part.
|
|
Get the stored material specification of an assembly part.
|
|
Get metadata for a specified volume id.
|
|
Get the stored name of an assembly node.
|
|
Get the stored units measure of an assembly node.
|
|
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.
|
|
Get the list of blend surfaces for a list of volumes.
|
|
Get the number of attributes in a block.
|
|
Get a specific block attribute value.
|
|
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.
|
|
Get a list of curve associated with a specific block.
|
|
Get a list of edges associated with a specific block.
|
|
Get the element type of a block.
|
|
Get a list of faces associated with a specific block.
|
|
Get a list of group ids associated with a specific block.
|
|
Get a list of hexes associated with a specific block.
|
|
Get the associated block id for a specific curve, surface, or volume.
|
|
Get a list of all blocks.
|
|
Get list of block ids from a mesh geometry file.
|
|
Get a list of nodes associated with a specific block.
|
|
Get a list of pyramids associated with a specific block.
|
|
Get a list of surface associated with a specific block.
|
|
Get a list of tets associated with a specific block.
|
|
Get a list of tris associated with a specific block.
|
|
Get a list of vertices associated with a specific block.
|
|
Get a list of volume ids associated with a specific block.
|
|
Get the bounding box for a specified entity.
|
|
Get the Cubit build number.
|
|
Get the center point of a specified entity.
|
|
Given 2 surfaces, get the common curve id.
|
|
Given 2 curves, get the common vertex id.
|
|
Get the list of node ids contained within a mesh entity.
|
|
Get the current number of curves.
|
|
Get the length of a specified curve.
|
|
Get the radiuis of a specified curve.
|
|
Get the curve type for a specified curve.
|
|
Get the distance from a point on a curve to the curve's start point.
|
|
Get the count of edges in the model.
|
|
Get all geometry entities of a specified type.
|
|
Get the color of a specified entity.
|
|
Get the geometry type and id given a ref entity.
|
|
Get the modeler engine type for a specified entity.
|
|
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.
|
|
Get the sense of a sideset item.
|
|
Get the number of errors in the current Cubit session.
|
|
Get the number of elements in a exodus entity.
|
|
Get the description associated with an exodus entity.
|
|
Get the name associated with an exodus entity.
|
|
Get the exodus/genesis id for this element.
|
|
Get the Exodus version number.
|
|
Get a list of geometric owners given a list of mesh entities.
|
|
Get the geometric owner of this mesh element.
|
|
Get the VTK version number.
|
|
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.
|
|
Get group curves (curves that are children of a group). This routine returns a list of curves that are contained in a specified group.
|
|
Get group edges (edges that are children of a group). This routine returns a list of edges that are contained in a specified group.
|
|
Get group groups (groups that are children of another group). This routine returns a list a groups that are contained in a specified group.
|
|
Get group hexes (hexes that are children of a group). This routine returns a list of hexes that are contained in a specified group.
|
|
Get group nodes (nodes that are children of a group). This routine returns a list of nodes that are contained in a specified group.
|
|
Get group quads (quads that are children of a group). This routine returns a list of quads that are contained in a specified group.
|
|
Get group surfaces (surfaces that are children of a group). This routine returns a list of surfaces that are contained in a specified group.
|
|
Get group tets (tets that are children of a group). This routine returns a list of tets that are contained in a specified group.
|
|
Get group tris (tris that are children of a group). This routine returns a list of tris that are contained in a specified group.
|
|
Get group vertices (vertices that are children of a group). This routine returns a list of vertices that are contained in a specified group.
|
|
Get group volumes (volumes that are children of a group). This routine returns a list of volumes that are contained in a specified group.
|
|
Get the count of hexes in the model.
|
|
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.
|
|
Get the area of a hydraulic surface.
|
|
Get the area of a hydraulic volume.
|
|
Get id for a named entity. This routine returns an integer id for the group whose name is passed in.
|
|
Get the id of the last created entity of the given type.
|
|
Get all free entities of a given geometry type.
|
|
Get the merge setting for a specified entity.
|
|
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.
|
|
Get the group ids which are parents to the indicated mesh element.
|
|
Get the interval count for a specified entity.
|
|
Get the mesh scheme for the specified entity.
|
|
Get the mesh size for a specified entity.
|
|
Get the total volume of a volume's mesh.
|
|
Get a next available block id.
|
|
Get a next available nodeset id.
|
|
Get a next available sideset id.
|
|
Get the nodal coordinates for a given node id.
|
|
Query current setting for node constraint (move nodes to geometry).
|
|
Get the count of nodes in the model.
|
|
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.
|
|
Get a list of curve ids associated with a specific nodeset.
|
|
Get a list of all nodesets.
|
|
Get the number of nodes in a nodeset.
|
|
Get a list of node ids associated with a specific nodeset.
|
|
Get a list of surface ids associated with a specific nodeset.
|
|
Get a list of vertex ids associated with a specific nodeset.
|
|
Get a list of volume ids associated with a specific nodeset.
|
|
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.
|
|
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.
|
|
Get the owning body for a specified entity.
|
|
Get the owning volume for a specified entity.
|
|
Get the owning volume for a specified entity.
|
|
Get the periodic data for a surface or curve.
|
|
Get the current pick type.
|
|
Get the count of pyramids in the model.
|
|
Get the count of quads in the model.
|
|
Get the quality stats for a specified entity.
|
|
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.
|
|
Get the current rendering mode.
|
|
Get the Cubit revision date.
|
|
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.
|
|
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.
|
|
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.
|
|
Get a list of curve ids associated with a specific sideset.
|
|
Get a list of all sidesets.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
Get the smooth scheme for a specified entity.
|
|
Get a list of a volume's sweep source surfaces.
|
|
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.
|
|
Get the area of a surface.
|
|
Get the surface centroid for a specified surface.
|
|
Get the current number of surfaces.
|
|
Get the count of elements in a surface.
|
|
Get the surface normal for a specified surface.
|
|
get the list of any quad elements on a given surface
|
|
Get the surface type for a specified surface.
|
|
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.
|
|
Get a list of a volume's sweep target surfaces.
|
|
Get the count of tets in the model.
|
|
Get the bounding box for a list of entities.
|
|
Get the total volume for a list of volume ids.
|
|
Get the count of tris in the model.
|
|
Get the valence for a specific vertex.
|
|
Get a list of potential element types for a block.
|
|
Get the Cubit version.
|
|
Get the current number of vertices.
|
|
Get the camera 'at' point.
|
|
Get the distance from the camera to the model (from - at).
|
|
Get the camera 'from' point.
|
|
Get the area of a volume.
|
|
Get the current number of volumes.
|
|
Get the count of elements in a volume.
|
|
|
|
Get the with-respect-to entity.
|
|
Get the names and ids of all the groups (excluding the pick group) that are defined by the current cubit session.
|
|
|
|
Determine whether metadata is attached to a specified volume.
|
|
Check the echo flag in cubit.
|
|
Check the journaling flag in cubit.
|
|
Determine whether pro-e/granite engine is available.
|
|
Query whether a specified surface has an odd loop.
|
|
Determines whether a specified entity is merged.
|
|
Indicates whether a mesh element is in a group.
|
|
Determines whether a specified entity is meshed.
|
|
Get the modified status of the model.
|
|
Query whether a specified body is a multi volume body.
|
|
Routine to check for the presence of an id in a list of ids.
|
|
Query whether a specified surface or curve is periodic.
|
|
Get the current perspective mode.
|
|
Get the current scale visibility setting.
|
|
Get the status of the model relative to undo checkpointing.
|
|
Get the shell use for a sideset.
|
|
Query virtualality for a specific entity.
|
|
Query visibility for a specific entity.
|
|
Parse a Cubit style list of IDs (1,2,4 to 19 by 3 or all) into a list of integers. Cubit 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.
|
|
|
|
Used to print the command line options.
|
|
Used to print out help when a ?, & or ! is pressed.
|
|
Print the surface summary stats to the console.
|
|
Print the volume summary stats to the console.
|
|
|
|
|
|
Remove a specific entity from a specific group.
|
|
This sets the global flag in Cubit that stops all interruptable processes.
|
|
|
|
|
|
Set the status of the model.
|
|
|
|
|
|
Set the status of the model relative to undo checkpointin.
|
|
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.
|
|
Unselect an entity and removed if from the picked list. Unselecting an entity will unhighlight it in the graphics window and remove it from the global pick list.
|
|
|