CubitInterface Namespace Reference
The CubitInterface provides a Python/C++ interface into Cubit. More...
Classes
Functions
System Control and Data
Graphics Manipulation and Data
Mesh Query Support
Geometry Query Support
Geometry Repair Support
Machine Learning Support
Blocks, Sidesets, and Nodesets
Geometry-Mesh Entity Support
Excludes nodes owned by bounding surfs, curves and verts.
Excludes nodes owned by bounding curves and verts.
Excludes nodes owned by bounding vertices.
Group Support
General Purpose Utility
Metadata Support
Mesh Element Queries
Boundary Condition Support
Boundary Layer Support
Geometry from ids
Geometry Creation Functions
Geometry Manipulation Functions
Variables
CubitInterface Control
Detailed Description
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.
Function Documentation
- int group_id,
- const std::vector< int > & entity_id,
- const std::string & entity_type)
- group_idID of group to which the entity will be added
- lista vector of IDs of the entities to be added to the group
- entity_typeType of the entity to be added to the group. Note that this function is valid only for geometric entities
- int group_id,
- int entity_id,
- const std::string & entity_type)
- group_idID of group to which the entity will be added
- entity_idID of the entity to be added to the group
- entity_typeType of the entity to be added to the group. Note that this function is valid only for geometric entities
- std::string & filename)
/brief Adds the filename to the recent file list. /param filename to be added to the recent file list.
- std::vector< int > surface_ids)
- surface_idIDs of surfaces to query
- id_inThe ID of the body
- [in] widthThe width of the brick being created
- [in] depthThe depth of the brick being created
- [in] heightThe height of the brick being created
- std::string entity_type,
- std::vector< int > entity_ids)
/brief Calculates time step estimate on elements of/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 assigned to it. That material must have elastic_modulus, poisson_ratio, and density defined.
- entity_typeSpecifies the entity type (hex, tet, volume, block, group)
- idsSpecifies the ids of the entity type
- std::string entity_type,
- std::vector< int > entity_id_list,
- double density,
- double youngs_modulus,
- double poissons_ratio)
/brief Calculates time step estimate on elements of/in entity type: "Tet" or "Hex" or "Volume" or "Block" or "Group"
- entity_typeSpecifies the entity type (hex, tet, volume, block, group)
- idsSpecifies the ids of the entity type
- densitySpecifies the density
- youngs_modulusSpecifies the Young's modulus
- poissons_ratioSpecifies the Poisson's ratio
- const char * input_string)
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.
- input_stringPointer to a string containing a complete Cubit command
- std::vector< int > edge_ids)
/brief Collapses specified mesh edges. Calls the command 'meshedit collapse edge <id> [no_compress_ids]'. Extra processing is done to make sure that that collapsing an edge does not cause neighboring triangles to have an aspect ratio smaller than any adjacent triangle before. If so, the collapse is not done on that edge.
- std::vector< int > volume_ids,
- std::vector< int > block_ids,
- std::vector< int > hex_ids,
- std::vector< int > tet_ids,
- double tolerance,
- int & returned_unmatched_volumes_count,
- int & returned_unmatched_elements_count,
- std::vector< int > & returned_full_matches_group_ids_list,
- std::vector< int > & returned_partial_matches_group_ids_list,
- int & returned_volume_curves_group_id)
/brief Compare the geometry and mesh
- std::string & line,
- int & num_chars,
- bool & found_quote)
- 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
- const std::string & geometry_type,
- int entity_id)
- geom_typeSpecifies the geometry type of the entity
- entity_idSpecifies the id of the entity
/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
- int entity_id)
/param entity_id Id of the BC convection /return true if convection is on a solid, otherwise false
- [in] v0The start vertex
- [in] v1The end vertex
- [in] intermediate_pointintermideate coord
- [in] v0The start vertex
- [in] v1The end vertex
- [in] coordinatesof points on the spline, in order
- [in] idof the surface on which to create the spline
- [in] xThe x location of the vertex (default to 0)
- [in] yThe y location of the vertex (default to 0)
- [in] zThe z location of the vertex (default to 0)
- id_inThe ID of the curve
- [in] hithe height of the cylinder
- [in] r1radius in the x direction
- [in] r2radius in the y direction
- [in] r3used to adjust the top. If set to 0, will produce a cone. If set to the larger of r1 or r2 it will create a straight cylinder.
- int group_id)
- group_idID of group to delete
- bool on)
- onSet to true to initialize signal handling, false to uninitialize.
- const std::string & entity_type,
- int id)
- entity_typeType of the entity being queried
- idID of entity
- int curve_id,
- double percent_capture)
- curve_idThe Curve to estimate mesh size percent_capture The requested percentage of capture for a curve
- const std::string & geometry_type,
- const std::vector< int > & geom_id,
- double percent_capture)
- geometry_typeThe type of geometry entity to esitmate mesh size geom_id The Id of the geometry entity to estimate mesh size percent_capture The requested percentage of capture for a curve
- std::vector< int > target_volume_ids,
- bool accurate_in,
- bool report_in,
- double low_value_in,
- double high_value_in,
- int number_calculations_in,
- bool return_calculations_in,
- std::vector< double > * merge_tolerance_list,
- std::vector< int > * number_of_proximities_list)
Given a list of volumes try to estimate a good merge tolerance.
- target_volume_idsList of volumes ids to examine.
- accurate_inFlag specifying whether to do a lengthier, more accurate calculation.
- report_inFlag specifying whether to report results to the command line.
- lo_val_inLow value of range to search for merge tolerance.
- hi_val_inHigh value of range to search for merge tolerance.
- num_calculations_inNumber of intervals to split search range up into.
- return_calculations_inFlag specifying whether to return the number of proximities at each step.
- merge_tolsList containing merge tolerance at each step of calculation.
- num_proximitiesList containing number of proximities at each step of calculation.
- const std::vector< int > & volume_ids,
- double size)
- volume_idsThe Id of the volumes that will be meshed with morph size The overlay grid size
- const std::vector< int > & volume_ids,
- double size,
- bool keep_void)
- volume_idsThe Id of the volumes to estimate element count size The overlay grid size keep_void Mesh the void space (e.g. air, enclosures, etc.)
- const std::vector< int > & curve_list,
- const double test_angle)
- curve_lista list of curve ids (integers)
- test_anglethe value (in degrees) that will be used in testing the exterior angle
- int curve_id,
- int volume_id)
- curveid (integer) volume id (integer)
- int surf_id,
- int vert_id)
- surfid (integer) vert id (integer)
- std::vector< int > target_volume_ids,
- std::vector< int > & returned_floating_id_list)
Given a list of volumes find all of the volumes that are not attached to any other entity through a merge.
- target_volume_idsList of volumes ids to examine.
- volume_listUser specified list where the ids of floating volumes are returned
- std::vector< int > target_volume_ids,
- std::vector< int > & returned_curve_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.
- target_volume_idsList of volumes ids to examine.
- curve_listUser specified list where the ids of nonmanifold curves are returned
- std::vector< int > target_volume_ids,
- std::vector< int > & returned_vertex_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.
- target_volume_idsList of volumes ids to examine.
- vertex_listUser specified list where the ids of nonmanifold vertices are returned
- std::vector< int > seed_surf_ids,
- std::vector< int > all_surf_ids)
/brief Gathers connected surfaces to those in 'seed_surf_ids'
that use common curves in an opposite sense. For example,
if a surface A in 'seed_surf_ids' uses a curve in the
FORWARD sense and it can find surface, B, that uses that
same curve in a REVERSED sense, it adds B to the list.
The search continues with all of surface B's curves.
All the surfaces in 'seed_surf_ids' will be returned. If
the user wants to limit the scope of possible surfaces
that are searched, 'all_surf_ids' can be populated. If
'all_surf_ids' is empty, all surfaces are candidates.
This function can be helpful in finding enclosures when
you have a set of non-manifold surfaces.
- const int op_type,
- const int entity_id1,
- const int entity_id2,
- const std::vector< double > params,
- const double small_curve_size,
- const double mesh_size)
- op_typeoperation type (see get_ML_operation_features)
- entity1_idfirst entity associated with operation (see table)
- entity2_idsecond entity associated with operation (see table)
- paramsoptional parameters for operation
- const int op_type)
- op_typecubit operation id from table in get_ML_operation_features
- const int op_type)
- op_typecubit operation id from table in get_ML_operation_features
- const int op_type)
- boolean 1 or 0
- categorical usually positive integer representing a unique
continuous could be double or integer describing a continuous range (i.e. number of adjacent curves, area of a surface, etc..)
- op_typescubit operation id from table in get_ML_operation_features
- std::vector< int > op_types,
- std::vector< int > entity1_ids,
- std::vector< int > entity2_ids,
- std::vector< std::vector< double >> params,
- double mesh_size)
- op_typeslist of cubit operation types. One of the following IDs:
op_type Description Entity1 Entity2 Params
0 Unknown none none 1 Vertex No Operation vertex none 2 Curve No Operation curve none 3 Surface No Operation surface none 4 Volume No Operation volume none 5 Remove Surface surface none 6 Tweak Replace Surface surface surface 7 Composite Surfaces surface surface 8 Collapse Curve curve vertex 9 Tweak Remove Topology Curve curve none 10 Virtual Collapse Curve curve vertex 11 Tweak Remove Topology Surface surface none 12 Blunt Tangency vertex none remove_mat, angle, depth 13 Remove Cone Surface surface none 14 Collapse Angle vertex none real_split, angle, composite_vertex 15 Remove Blend surface none 16 Remove Cavity surface none
- entity1_idslist of first entity ids associated with operation (see above table)
- entity2_idslist of second entity associated with operation (see above table)
- paramsarray of parameters the operation needs to execute (see above table)
- mesh_sizetarget mesh size for operation
- const int op_type)
- op_typecubit operation id from table in get_ML_operation_features
- int entity_id)
/param entity_id Id of the acceleration /return The combine type for the given acceleration
- int entity_id)
/param entity_id Id of the acceleration /return An array of ints which are the dof signs
- int entity_id)
/param entity_id Id of the acceleration /return An array of doubles which are the dof values
- const std::string & geometry_type,
- int entity_id)
For a specified entity, find all surfaces that own the entity and surfaces that touch the surface that owns this entity.
- geom_typeSpecifies the geometry type of the entity
- entity_idSpecifies the id of the entity
- const std::string & geometry_type,
- int entity_id)
For a specified entity, find all volumes that own the entity and volumes that touch the volume that owns this entity.
- geom_typeSpecifies the geometry type of the entity
- entity_idSpecifies the id of the entity
- const std::string & filename)
- filenameFully qualified exodus file name
- const std::string & filename,
- const std::string & variable_type)
- filenameFully qualified exodus file name
- typeVariable type - 'g', 'n', or 'e'
- std::string mesh_entity_type,
- std::string mesh_entity_list)
- mesh_entity_typeThe type of mesh entity. Works for 'quad, 'face', 'tri', 'hex', 'tet', 'edge', 'node'
- mesh_entity_listA string containing space delimited ids, Cubit command form (i.e. 'all', '1 to 8', '1 2 3', etc)
- std::string variable_name)
- std::string variable_name,
- int & returned_variable_type,
- double & returned_double_val,
- std::string & returned_string_val)
- var_nameaprepro variable name
- var_typereturn 0, 1 or 3 where 0=undefined 1=double/int 2=string
- dvalreturn integer or double value if var_type=1
- svalreturn string if var_type=2
- std::string variable_name)
/param var_name aprepro variable name /return The string value of the aprepro variable name
/return A list (python tuple) of the current aprepro variable names
- int curve_id)
- curve_idID of the curve
- int assembly_id)
- assembly_idId that identifies the assembly node
- int assembly_id)
- assembly_idId that identifies the assembly node
- int assembly_id)
- assembly_idId that identifies the assembly node
- int assembly_id)
- assembly_idId that identifies the assembly node
- int assembly_id)
- assembly_idId that identifies the assembly node
- int assembly_id)
- assembly_idId that identifies the assembly node
- int volume_id,
- int data_type)
- volume_idID of the volume
- data_typeMagic 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
- int assembly_id)
- assembly_idId that identifies the assembly node
- int assembly_id)
- assembly_idId that identifies the assembly node
- int assembly_id)
- assembly_idId that identifies the assembly node
- int assembly_id)
- assembly_idId that identifies the assembly node
- const std::string & geometry_type,
- std::vector< int > entity_id_list,
- double size)
- entity_typeSpecifies the geometry type of the entity
- enitty_id_listList (vector) of entity ids
- sizeThe auto factor for the AutoSizeTool
- std::vector< int > target_volume_ids,
- std::vector< int > & returned_body_list,
- std::vector< int > & returned_volume_list,
- std::vector< int > & returned_surface_list,
- std::vector< int > & returned_curve_list)
Bad geometry can be any number of problems associated with poorly defined ACIS geometry.
- target_volume_idsList of volume ids to examine.
- body_listUser specified list where ids of bad bodies will be returned
- volume_listUser specified list where ids of bad volumes will be returned
- surface_listUser specified list where ids of bad surfaces will be returned
- curve_listUser specified list where ids of bad curves will be returned
- bc_type_inas an enum defined by CI_BCTypes. 1-9 is FEA, 10-30 is CFD
- bc_type_intype of bc, as defined by enum CI_BCTypes. 1-9 is FEA, 10-30 is CFD
- bc_idID of the desired bc.
/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 surface_id)
- surface_idsurface to retrieve the blend chains from
- std::vector< int > target_volume_ids)
- target_volume_idsList of volume ids to examine.
- int block_id)
- block_idThe block id
- int block_id,
- int attribute_index)
- block_idThe block id
- indexThe index of the attribute
- int block_id,
- int attribute_index)
- block_idThe block id
- indexThe index of the attribute
- int block_id,
- std::vector< int > & returned_group_list,
- std::vector< int > & returned_node_list,
- std::vector< int > & returned_sphere_list,
- std::vector< int > & returned_edge_list,
- std::vector< int > & returned_tri_list,
- std::vector< int > & returned_face_list,
- std::vector< int > & returned_pyramid_list,
- std::vector< int > & returned_tet_list,
- std::vector< int > & returned_hex_list,
- std::vector< int > & returned_wedge_list,
- std::vector< int > & returned_volume_list,
- std::vector< int > & returned_surface_list,
- std::vector< int > & returned_curve_list,
- std::vector< int > & returned_vertex_list)
A block can contain a variety of entity types. This routine will return all contents of a specified block.
- block_idID of block to examine
- group_listUser specified list where groups associated with this block are returned
- node_listUser specified list where nodes associated with this block are returned
- edge_listUser specified list where edges associated with this block are returned
- tri_listUser specified list where tris associated with this block are returned
- face_listUser specified list where faces associated with this block are returned
- pyramid_listUser specified list where pyramids associated with this block are returned
- tet_listUser specified list where tets associated with this block are returned
- hex_listUser specified list where hexes associated with this block are returned
- volume_listUser specified list where volumes associated with this block are returned
- surface_listUser specified list where surfaces associated with this block are returned
- curve_listUser specified list where curves associated with this block are returned
- vertex_listUser specified list where vertices associated with this block are returned
- int block_id)
- block_idUser specified id of the desired block
- int block_id)
- block_idUser specified id of the desired block
- int block_id)
- block_idThe block id
- int block_id)
- block_idThe block id
- indexThe index of the attribute
- int block_id)
- block_idThe block id
- int block_id,
- std::vector< int > & returned_node_list,
- std::vector< int > & returned_sphere_list,
- std::vector< int > & returned_edge_list,
- std::vector< int > & returned_tri_list,
- std::vector< int > & returned_face_list,
- std::vector< int > & returned_pyramid_list,
- std::vector< int > & returned_wedge_list,
- std::vector< int > & returned_tet_list,
- std::vector< int > & returned_hex_list)
- block_idUser 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
- int block_id)
- block_idUser specified id of the desired block
- int block_id)
- block_idUser specified id of the desired block
- std::string entity_type,
- int entity_id)
- entity_typeType of entity
- entity_idId of entity in question
- const std::string & mesh_geometry_file_name)
- mesh_geom_file_nameFully qualified name of a mesh geometry file
- int block_id)
- int block_id)
- block_idUser specified id of the desired block
- int block_id)
- block_idUser specified id of the desired block
- int block_id)
- block_idUser specified id of the desired block
- int block_id)
- block_idUser specified id of the desired block
- int block_id)
- block_idUser specified id of the desired block
- int block_id)
- block_idUser specified id of the desired block
- int block_id)
- block_idUser specified id of the desired block
- int block_id)
- block_idUser specified id of the desired block
- int vert_id,
- double angle,
- bool add_material)
/brief get default depth value for blunt tangency operation /return depth
- const std::string & geometry_type,
- int entity_id)
- geom_typeSpecifies the geometry type of the entity
- entity_idSpecifies the id of the entity
- int surface_id)
- surface_idthat is part of the cavity
- const std::string & entity_type,
- int entity_id)
- entity_typeSpecifies the geometry type of the entity
- entity_idSpecifies the id of the entity
- int entity_id)
- entity_idID of the cfd BC
- int surface_id)
- surafceid
- std::vector< int > target_volume_ids,
- double mesh_size)
'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.
- target_volume_idsList of volume ids to examine.
- mesh_sizeIndicate the mesh size used as the threshold
- std::vector< int > target_volume_ids,
- double mesh_size,
- int genus)
'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.
- target_volume_idsList of volume ids to examine.
- mesh_sizeIndicate the mesh size used as the threshold
- genusIndicate the genus of the surfaces requested. Genus is defined as the number of loops on the surface minus 1. To return any genus surface in the volume(s), use genus < 0
- std::vector< int > target_volume_ids,
- double high_tolerance)
- target_volume_listList of volumes ids to examine.
- std::vector< int > target_ids,
- double narrow_size)
- target_volume_idsList of volume ids to examine.
- narrow_sizeIndicate the narrow size threshold
- double x_coordinate,
- double y_coordinate,
- double z_coordinate)
- xcoordinate
- ycoordinate
- zcoordinate
- std::vector< int > target_ids,
- int & returned_number_to_return,
- std::vector< int > & returned_vertex_ids,
- std::vector< int > & returned_curve_ids,
- std::vector< double > & returned_distances)
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.
- target_idsList of volumes ids to examine.
- num_to_returnNumber of vertex curve pairs to return.
- vert_idsIds of returned vertices.
- curve_idsIds of returned curves.
- distancesVertex-curve pair distances.
- std::vector< int > target_volume_ids,
- std::vector< int > & returned_v_v_vertex_list,
- std::vector< int > & returned_v_c_vertex_list,
- std::vector< int > & returned_v_c_curve_list,
- std::vector< int > & returned_v_s_vertex_list,
- std::vector< int > & returned_v_s_surf_list,
- std::vector< double > & returned_vertex_distance_list,
- std::vector< double > & returned_curve_distance_list,
- std::vector< double > & returned_surf_distance_list,
- double low_value,
- double high_value,
- bool do_vertex_vertex,
- bool do_vertex_curve,
- bool do_vertex_surf,
- bool filter_same_volume_cases)
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 double the size of the distance lists. For each distance, 2 entities will be associated at the same relative place in the list.
- target_volume_idsList of volumes ids to examine.
- do_vertex_vertexParameter specifying whether to do vertex-vertex check.
- do_vertex_curveParameter specifying whether to do vertex-curve check.
- do_vertex_surfParameter specifying whether to do vertex-surface check.
- v_v_vertex_listUser specified list where the ids of coincident vertex pairs are returned
- v_c_vertex_listUser specified list where the ids of the vertices of coincident vertex-curve pairs are returned
- v_c_curve_listUser specified list where the ids of the curves of coincident vertex-curve pairs are returned
- v_s_vertex_listUser specified list where the ids of the vertices of coincident vertex-surface pairs are returned
- v_s_surf_listUser specified list where the ids of the surfaces of coincident vertex-surface pairs are returned
- vertex_distance_listUser specified list where the vertex-vertex distance values will be returned
- curve_distance_listUser specified list where the vertex-curve distance values will be returned
- surf_distance_listUser specified list where the vertex-surface distance values will be returned
- low_valueUser specified low threshold value
- hi_valueUser specified high threshold value
- filter_same_volume_casesParameter specifying whether to weed out entity pairs that are in the same volume.
- std::vector< int > target_volume_ids,
- std::vector< int > & returned_vertex_list,
- std::vector< int > & returned_curve_list,
- std::vector< double > & returned_distance_list,
- double low_value,
- double threshold_value,
- bool filter_same_volume_cases)
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.
- target_volume_idsList of vertices ids to examine.
- vertex_listUser specified list for the ids of coincident vertices
- curve_listUser specified list for the ids of coincident curves
- distance_listUser specified list where the distance values will be returned
- threshold_valueUser specified threshold value
- std::vector< int > target_volume_ids,
- std::vector< int > & returned_vertex_list,
- std::vector< int > & returned_surface_list,
- std::vector< double > & returned_distance_list,
- double low_value,
- double threshold_value,
- bool filter_same_volume_cases)
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.
- target_volume_idsList of vertices ids to examine.
- vertex_listUser specified list for the ids of coincident vertices
- surface_listUser specified list for the ids of coincident surfaces
- distance_listUser specified list where the distance values will be returned
- threshold_valueUser specified threshold value
- std::vector< int > target_volume_ids,
- std::vector< int > & returned_vertex_pair_list,
- std::vector< double > & returned_distance_list,
- double low_value,
- double threshold_value,
- bool filter_same_volume_cases)
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 double the size of the distance list. For each distance, 2 vertices will be associated at the same relative place in the list.
- target_volume_idsList of volumes ids to examine.
- vertex_pair_listUser specified list where the ids of coincident vertex pairs be returned
- distance_listUser specified list where the distance values will be returned
- threshold_valueUser specified threshold value
- std::vector< int > target_volume_ids,
- double high_tolerance)
Get the list of coincident vertex pairs
- target_volume_listList of volumes ids to examine.
- int command_number)
- int surface_1_id,
- int surface_2_id)
- surface_1_idThe id of one of the surfaces
- surface_2_idThe id of the other surface
- int curve_1_id,
- int curve_2_id)
- curve_1_idThe id of one of the curves
- curve_2_idThe id of the other curves
- std::vector< int > target_volume_ids)
- target_volume_idsList of volume ids to examine.
- const std::string & entity_type,
- int entity_id)
- entity_typeThe mesh element type
- entity_idThe mesh element id
- int constraint_id)
- constraint_idID of the constraint
- int constraint_id)
- constraint_idID of the constraint
- int constraint_id)
- constraint_idID of the constraint
- int entity_id)
/param entity_id Id of the contact pair /return The exterior state of the contact pair
- int entity_id)
/param entity_id Id of the contact pair /return The friction value of the contact pair
- int entity_id)
/param entity_id Id of the contact pair /return The general state of the contact pair
- int entity_id)
/param entity_id Id of the contact pair /return The tied state of the contact pair
- int entity_id)
/param entity_id Id of the contact pair /return The tolerance value of the contact pair
- int entity_id)
/param entity_id Id of the contact pair /return The tolerance value of the contact pair
- int surface_id,
- double angle_tol)
- surface_idthat is part of the cavity
- angle_tolangle tolerance for continuity
/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
/brief get a list of coordinate system ids
/return List (python tuple) of ids
- int curve_id)
Get the bias coarse size of a curve
- curve_idSpecifies the id of the curve
- int curve_id)
Get the bias fine size of a curve
- curve_idSpecifies the id of the curve
- int curve_id)
Get the bias first interval fraction of a curve
- curve_idSpecifies the id of the curve
- int curve_id)
Get the bias first interval length of a curve
- curve_idSpecifies the id of the curve
- int curve_id)
Get the bias first/last ratio at start of a curve
- curve_idSpecifies the id of the curve
- int curve_id)
Get the bias first/last ratio at end of a curve
- curve_idSpecifies the id of the curve
- int curve_id,
- bool & value)
Get whether the bias is from the start of a curve
- curve_idSpecifies the id of the curve
- valueReturns whether the bias is from the start of the curve.
- int curve_id)
Get whether the bias from the start of a curve settings has been set
- curve_idSpecifies the id of the curve
- valueReturns whether the bias from the start of the curve settings has been set.
- int curve_id)
Get the first bias geometric factor of a curve
- curve_idSpecifies the id of the curve
- int curve_id)
Get the second bias geometric factor of a curve
- curve_idSpecifies the id of the curve
- int curve_id)
Get the bias last/first ratio at start of a curve
- curve_idSpecifies the id of the curve
- int curve_id)
Get the bias last/first ratio at end of a curve
- curve_idSpecifies the id of the curve
- int curve_id)
Get the bias start vertex id of a curve
- curve_idSpecifies the id of the curve
- int curve_id)
Get the bias type of a curve
- curve_idSpecifies the id of the curve
- int curve_id)
- curve_idID of the curve
- std::vector< int > target_volume_ids)
- int curve_id)
- curve_idUser specified id of the desired curve
- int curve_id)
- curve_idID of the curve
- int curve_id)
- curve_idSpecifies the id of the curve
- int curve_id)
Get the pinpoint mesh scheme locations of a curve
- curve_idSpecifies the id of the curve
- int curve_id,
- double & first_size,
- double & factor,
- double & last_size,
- bool & start,
- int & vertex_id)
Get the stretch mesh scheme values of a curve
- curve_idSpecifies the id of the curve
- first_sizeReturns the first_size
- factorReturns the factor
- last_sizeReturns the last_size
- startReturns whether the scheme is from the start of the curve.
- vertex_idReturns the vertex id used for the start of the scheme.
- int curve_id)
- curv_idid of curve
- int curve_id)
- curve_idID of the curve
- int curve_id)
- curve_idID of the curve
- const char * variable)
/brief return sculpt default value
- "tri" indicates a tri/tet mesh default
- "hex" indicates a quad/hex mesh default
- "none" indicates no default has been assigned
- int entity_id)
/param entity_id Id of the displacement /return The combine type for the given displacement
- int entity_id)
/param entity_id Id of the displacement /return The Id of the displacement's coordinate system
- int entity_id)
/param entity_id Id of the displacement /return
- int entity_id)
/param entity_id Id of the displacement /return
- int vertex_id_1,
- int vertex_id_2)
- vertex_id_1ID of vertex 1 vertex_id_2 ID of vertex 2
- std::string geom_type_1,
- int entity_id_1,
- std::string geom_type_2,
- int entity_id_2)
- geom_type_1geometry type of entity 1: "vertex", "curve", "surface", "volume" entity_id_1 ID of entity 1 geom_type_2 geometry type of entity 2: "vertex", "curve", "surface", "volume" entity_id_2 ID of entity 2
- double x_coordinate,
- double y_coordinate,
- double z_coordinate,
- int curve_id)
- xvalue of the point to measure
- yvalue of the point to measure
- zvalue of the point to measure
- curve_idID of the curve
- int edge_id)
- edge_idSpecifies the id of the edge
- const std::string & entity_type,
- const std::vector< int > id_list,
- const std::string & metric_name,
- const double single_threshold,
- const bool use_low_threshold,
- const double low_threshold,
- const double high_threshold,
- const bool make_group)
- entity_typeSpecifies the geometry type of the entity
- id_listSpecifies a list of ids to work on
- metric_nameSpecify the metric used to determine the quality
- single_thresholdQuality threshold value
- use_low_thresholduse threshold as lower or upper bound
- low_thresholdQuality threshold when using a lower and upper range
- high_thresholdQuality threshold when using a lower and upper range
- int element_id)
- element_idThe element id (i.e. the global element export id)
- const std::string & element_type,
- std::vector< int > entity_id_list,
- int auto_factor)
- element_type"hex" or "tet"
- entity_id_listList (vector) of volume ids
- auto_factorThe current auto size factor value
- int element_id)
- element_idThe element id (i.e. the global element export id)
- int element_id)
- element_idThe element id (i.e. the global element export id)
- int element_id)
- element_idThe element id (i.e. the global element export id)
- const std::string & entity_type)
- entity_typeSpecifies the type of the entity
- const std::string & entity_type,
- int entity_id)
- entity_typeSpecifies the type of the entity
- entity_idSpecifies the id of the entity
- const std::string & geometry_type,
- int entity_id)
- geom_typeSpecifies the geometry type of the entity
- entity_idSpecifies the id of the entity
- const std::string & entity_type,
- int entity_id)
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.
- entity_typeSpecifies the type of the entity
- entity_idSpecifies the id of the entity
- std::string source_type,
- int source_id,
- int sideset_id)
- source_typeItem type - could be 'face', 'quad' or 'tri'
- source_idID of entity
- sideset_idID of the sideset
- int entity_id,
- std::string entity_type)
- entity_idThe id of the entity
- entity_typeThe type of the entity
- std::string entity_type,
- int entity_id)
- entity_type"block", "sideset", nodeset"
- entity_idId of the entity in question
- const std::string entity_type,
- int entity_id)
- entity_type"block", "sideset", nodeset"
- entity_idId of the entity in question
- std::string entity_type,
- int entity_id)
- entity_type"block", "sideset", nodeset"
- entity_idId of the entity in question
- const std::string & entity_type,
- int entity_id)
- entity_typeThe mesh element type
- entity_idThe mesh element id
- std::string container_type,
- int container_id)
- entity_type: nodeset, sideset, or block block_id The block id
- std::string container_type,
- int container_id)
- entity_type: nodeset, sideset, or block block_id The block id
- const std::string & entity_type,
- int entity_id)
- entity_typeThe mesh element type
- entity_idThe mesh element id
- int entity_id)
/param entity_id Id of the force /return A vector (python tuple) [x,y,z] of the direction the given force is acting
- int entity_id)
/param entity_id Id of the force /return Magnitude of the given force
- int entity_id)
/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
- std::string mesh_entity_type,
- std::string mesh_entity_list)
- mesh_entity_typeThe type of mesh entity. Works for 'quad, 'face', 'tri', 'hex', 'tet', 'edge', 'node'
- mesh_entity_listA string containing space delimited ids, Cubit command form (i.e. 'all', '1 to 8', '1 2 3', etc)
- const std::string & 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
- const std::string & entity_type,
- int entity_id)
- entity_typeThe mesh element type
- entity_idThe mesh element id
- const std::string & element_type,
- int id)
- idSpecifies the id of the hex, tet, etc. elem_type the type of the entity ("hex", "tet", "wedge", "pyramid", "tri", "face", "quad", "edge", or "sphere")
- int group_id)
This routine returns a list of bodies that are contained in a specified group.
- group_idID of the group to examine return List (python tuple) of bodies ids contained in the specified group
- int group_id,
- std::vector< int > & returned_group_list,
- std::vector< int > & returned_body_list,
- std::vector< int > & returned_volume_list,
- std::vector< int > & returned_surface_list,
- std::vector< int > & returned_curve_list,
- std::vector< int > & returned_vertex_list,
- int & returned_node_count,
- int & returned_edge_count,
- int & returned_hex_count,
- int & returned_quad_count,
- int & returned_tet_count,
- int & returned_tri_count,
- int & returned_wedge_count,
- int & returned_pyramid_count,
- int & returned_sphere_count)
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.
- group_idID of the group to examine
- group_listUser specified list where group ids will be returned
- body_listUser specified list where body ids will be returned
- volume_listUser specified list where volume ids will be returned
- surface_listUser specified list where surface ids will be returned
- curve_listUser specified list where curve ids will be returned
- vertex_listUser specified list where vertex ids will be returned
- node_countUser specified variable where the number of nodes will be returned
- edge_countUser specified variable where the number of edges will be returned
- hex_countUser specified variable where the number of hexes will be returned
- quad_countUser specified variable where the number of quads will be returned
- tet_countUser specified variable where the number of tets will be returned
- tri_countUser specified variable where the number of tris will be returned
- int group_id)
This routine returns a list of curves that are contained in a specified group.
- group_idID of the group to examine return List (python tuple) of curve ids contained in the specified group
- int group_id)
This routine returns a list of edges that are contained in a specified group.
- group_idID of the group to examine return List (python tuple) of edge ids contained in the specified group
- int group_id)
This routine returns a list a groups that are contained in a specified group.
- group_idID of the group to examine return List (python tuple) of group ids contained in the specified group
- 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.
- group_idID of the group to examine return List (python tuple) of hex ids contained in the specified group
- int group_id)
This routine returns a list of nodes that are contained in a specified group.
- group_idID of the group to examine return List (python tuple) of node ids contained in the specified group
- int group_id)
This routine returns a list of pyramids that are contained in a specified group.
- group_idID of the group to examine return List (python tuple) of pyramid ids contained in the specified group
- int group_id)
This routine returns a list of quads that are contained in a specified group.
- group_idID of the group to examine return List (python tuple) of quad ids contained in the specified group
- 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.
- group_idID of the group to examine return List (python tuple) of sphere ids contained in the specified group
- int group_id)
This routine returns a list of surfaces that are contained in a specified group.
- group_idID of the group to examine return List (python tuple) of surface ids contained in the specified group
- int group_id)
This routine returns a list of tets that are contained in a specified group.
- group_idID of the group to examine return List (python tuple) of tet ids contained in the specified group
- int group_id)
This routine returns a list of tris that are contained in a specified group.
- group_idID of the group to examine return List (python tuple) of tri ids contained in the specified group
- int group_id)
This routine returns a list of vertices that are contained in a specified group.
- group_idID of the group to examine return List (python tuple) of vertex ids contained in the specified group
- int group_id)
This routine returns a list of volumes that are contained in a specified group.
- group_idID of the group to examine return List (python tuple) of volume ids contained in the specified group
- int group_id)
This routine returns a list of wedges that are contained in a specified group.
- group_idID of the group to examine return List (python tuple) of wedge ids contained in the specified group
/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 hex_id)
- hex_idSpecifies the id of the hex
- int node_id_1,
- int node_id_2)
- int surface_id)
- surface_idID of the surface
- int volume_id)
- volume_idID of the volume
- const std::string & name)
This routine returns an integer id for the entity whose name is passed in.
- nameName of the entity to examine return Integer representing the entity
- std::string entity_type,
- int entity_id)
- typethe type of the requested entity
- idthe id of the requested entity
- std::string entity_type,
- const std::vector< int > & entity_id_list)
- typethe type of the requested entity
- idlista list of ids
- std::string interface_name)
- interface_namethe name of interface
- const char * entity_type)
/brief make calls to SVDrawTool::get_label_type
/return label type currently associated with entity_type
- const std::string & entity_type)
- entity_typeType of the entity being queried
- const std::string & geometry_type)
- geom_typeSpecifies the geometry type of the free entity
- int material_id)
/brief Get a list of all defined material names
/return List (python tuple) of all the material names.
/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
/brief Get a list of all defined material names
/return List (python tuple) of all the material names.
- 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
- const std::string & geometry_type,
- int entity_id)
- geom_typeSpecifies the geometry type of the entity
- entity_idSpecifies the id of the entity
- std::vector< int > target_volume_ids)
Given a list of volume ids, this will return a list of potentially mergeable curves. The returned lists include lists of the merge partners.
- target_volume_idsList of volume ids to examine.
- std::vector< int > target_volume_ids,
- std::vector< std::vector< int > > & returned_surface_list,
- std::vector< std::vector< int > > & returned_curve_list,
- std::vector< std::vector< int > > & returned_vertex_list,
- double merge_tol)
Given a list of volume ids, this will return 3 lists of potential merge candidates. The returned lists include lists of the merge partners.
- target_volume_idsList of volume ids to examine.
- surface_listUser specified list where mergeable surfaces will be stored
- curve_listUser specified list where mergeable curves will be stored
- vertex_listUser specified list where mergeable vertices will be stored
- merge_tolmerge tolerance to determine mergable (optional). Uses the default merge_tolerance if not specified
- std::vector< int > target_volume_ids)
Given a list of volume ids, this will return a list of potentially mergeable surfaces. The returned lists include lists of the merge partners.
- target_volume_idsList of volume ids to examine.
- std::vector< int > target_volume_ids)
Given a list of volume ids, this will return a list of potentially mergeable vertices. The returned lists include lists of the merge partners.
- target_volume_idsList of volume ids to examine.
- int edge_id)
- edge_idSpecifies the id of the edge
- const std::string & entity_type,
- int entity_id)
- entity_typeThe type of entity
- entity_idThe id of the entity
- int error_code)
- error_codeThe error code associated with the error solution
- std::string geometry_type,
- int entity_id)
- geom_typeeither "surface" or "volume"
- entity_idthe entity id
- const std::string & element_type,
- int element_id)
- element_typeMesh type of the element
- element_idID of the mesh element return List (python tuple) of group ids that contain this mesh element
- const std::string & geometry_type,
- int entity_id)
- geom_typeSpecifies the geometry type of the entity
- entity_idSpecifies the id of the entity
- const std::string & geometry_type,
- int entity_id)
- geom_typeSpecifies the geometry type of the entity
- entity_idSpecifies the id of the entity
- const std::string & geometry_type,
- int entity_id)
- geom_typeSpecifies the geometry type of the entity
- entity_idSpecifies the id of the entity
- const std::string & geometry_type,
- int entity_id)
- geom_typeSpecifies the geometry type of the entity
- entity_idSpecifies the id of the entity
- const std::string & geometry_type,
- int entity_id)
- geom_typeSpecifies the geometry type of the entity
- entity_idSpecifies the id of the entity
- const std::string & geometry_type,
- int entity_id)
- geom_typeSpecifies the geometry type of the entity
- entity_idSpecifies the id of the entity
- const std::string & geometry_type,
- std::vector< int > entity_ids)
- geom_typeSpecifies the type of entity - volume, surface, hex, tet, tri, quad
- entity_idsA list of ids for the entity type
- int entity_id)
/param entity_id Id of the force /return magnitude of the moment on the given force
- std::vector< int > target_ids,
- double narrow_size)
- target_volume_idsList of volume ids to examine.
- narrow_sizeIndicate the size that defines 'narrowness'
- std::vector< int > target_volume_ids,
- double mesh_size)
'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.
- target_volume_idsList of volume ids to examine.
- mesh_sizeIndicate the mesh size used as the threshold
- int volume_id,
- std::vector< int > compare_volumes,
- double distance)
- volume_idvolume to check.
- volumesto check against. If empty, will check against all volumes in model
- maximumdistance betwen volumes. Optional. Use -1 to compute default tolerance
- int node_id)
- node_idThe node id
- int node_id)
- node_idThe node id
- int node_id)
|brief Get the face/quad ids that share a node
- node_idThe node id
- int node_id)
- node_idSpecifies the id of the sphere
- int node_id)
- node_idThe node id
- int node_id)
|brief Get the tri ids that share a node
- node_idThe node id
- int nodeset_id,
- std::vector< int > & returned_node_list,
- std::vector< int > & returned_volume_list,
- std::vector< int > & returned_surface_list,
- std::vector< int > & returned_curve_list,
- std::vector< int > & returned_vertex_list)
A nodeset can contain a variety of entity types. This routine will return all contents of a specified nodeset.
- nodeset_idUser specified id of the desired nodeset
- node_listUser specified list where nodes associated with this nodeset are returned
- volume_listUser specified list where volumes associated with this nodeset are returned
- surface_listUser specified list where surfaces associated with this nodeset are returned
- curve_listUser specified list where curves associated with this nodeset are returned
- vertex_listUser specified list where vertices associated with this nodeset are returned
- int nodeset_id)
- nodeset_idUser specified id of the desired nodeset
- bc_type_inType of bc to query, as defined by enum CI_BCTypes. 1-9 is FEA, 10-30 is CFD
- bc_idID of the bc to query
- int nodeset_id)
- nodeset_idThe nodeset id
- int nodeset_id)
- nodeset_idUser specified id of the desired nodeset
- int nodeset_id)
- nodeset_idUser specified id of the desired nodeset
- int nodeset_id)
- nodeset_idUser specified id of the desired nodeset
- int nodeset_id)
- nodeset_idUser specified id of the desired nodeset
- int nodeset_id)
- nodeset_idUser specified id of the desired nodeset
- void)
- void)
- void)
- std::vector< int > target_surface_ids,
- double min_gap,
- double max_gap,
- std::vector< int > & returned_curve_list_1,
- std::vector< int > & returned_curve_list_2,
- std::vector< double > & returned_distance_list)
For every occurance of two overlapping curves, two curve ids are returned. Those ids are returned in the indicated lists and are aligned. In other words the first id in curv_list_1 overlaps with the first id in curv_list_2. The second id in curv_list_1 overlaps with the second id in curv_list-2, and so on.
- target_surface_idsList of surface ids to examine.
- min_gapminimum overlap distance between curves to return
- max_gapmaximum overlap distance between curves to return
- returned_curve_list_1User specified list where the ids of overlapping curves will be returned
- returned_curve_list_2User specified list where the ids of overlapping curves will be returned
- returned_distance_listCorresponding user specified list where distances between curves will be returned
- std::vector< int > target_surface_ids,
- std::vector< int > & returned_surface_list_1,
- std::vector< int > & returned_surface_list_2,
- std::vector< double > & returned_distance_list,
- std::vector< double > & returned_overlap_area_list,
- bool filter_slivers,
- bool filter_volume_overlaps,
- int cache_overlaps)
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.
- target_surface_idsList of surface ids to examine.
- returned_surface_list_1User specified list where the ids of overlapping surfaces will be returned
- returned_surface_list_2User specified list where the ids of overlapping surfaces will be returned
- returned_distance_listCorresponding user specified list where distances between surfaces will be returned
- returned_overlap_area_listCorresponding user specified list where overlap areas between surfaces will be returned
- filter_sliverswhether to return filter slivers
- filter_volume_overlapswhether to return surfaces on the same volume
- cache_overlapsspeed up overlaps by caching and using previously computed results. Default 0 = no caching. 1 = clear out old values first. 2 = use and add to existing cache
- int surface_id,
- std::vector< int > compare_volumes,
- int cache_overlaps)
- surface_idsurface to check.
- compare_volumesvolumes to check against. If empty, will check against all volumes in model
- std::vector< int > target_volume_ids,
- std::vector< int > & returned_surface_list_1,
- std::vector< int > & returned_surface_list_2,
- std::vector< double > & returned_distance_list,
- std::vector< double > & returned_overlap_area_list,
- bool filter_slivers,
- bool filter_volume_overlaps,
- int cache_overlaps)
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.
- target_volume_idsList of volume ids to examine.
- surf_list_1User specified list where the ids of overlapping surfaces will be returned
- surf_list_2User specified list where the ids of overlapping surfaces will be returned
- returned_distance_listCorresponding user specified list where distances between surfaces will be returned
- returned_overlap_area_listCorresponding user specified list where overlap areas between surfaces will be returned
- filter_sliverswhether to return filter slivers
- filter_volume_overlapswhether to return surfaces on the same volume
- cache_overlapsspeed up overlaps by caching and using previously computed results. Default 0 = no caching. 1 = clear out old values first. 2 = use and add to existing cache
- std::vector< int > target_volume_ids)
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.
- target_volume_idsList of volume ids to examine.
- int volume_id,
- std::vector< int > compare_volumes)
- volume_idvolume to check.
- volumesto check against. If empty, will check against all volumes in model
- const std::string & geometry_type,
- int entity_id)
- geom_typeSpecifies the geometry type of the entity
- entity_idSpecifies the id of the entity
- const std::string & geometry_type,
- int entity_id)
- geom_typeSpecifies the geometry type of the entity
- entity_idSpecifies the id of the entity
- const std::string & entity_name)
- entity_nameSpecifies the name (supplied by Cubit) of the entity
- const std::string & entity_type,
- std::vector< int > & entity_list,
- std::vector< int > & volume_ids)
- entity_type
- entity_list
- vol_ids
- int assembly_id)
- assembly_idId that identifies the assembly node
- int assembly_id)
- assembly_idId that identifies the assembly node
- const std::string & geometry_type,
- int entity_id,
- double & returned_interval,
- std::string & returned_firmness,
- int & returned_lower_bound,
- std::string & returned_upper_bound)
- geom_typeSpecifies the geometry type of the entity
- entity_idSpecifies the id of the entity
- intervalUser specified variable where interval count for the specified entity is returned
- firmnessUser specified variable where a firmness of 'hard', 'soft', or 'default' is returned
- lower_boundUser specified variable where the lower bound value is returned
- upper_boundUser specified variable where the upper bound value is returned
- int entity_id)
/param entity_id Id of the pressure /return The pressure function
- int entity_id)
/param entity_id Id of the pressure /return The value or magnitude of the given pressure
- int pyramid_id)
- pyramid_idSpecifies the id of the pyramid
- int quad_id)
- quad_idSpecifies the id of the quad
- const std::string & entity_type,
- std::vector< int > id_list,
- const std::string & metric_name,
- double single_threshold,
- bool use_low_threshold,
- double low_threshold,
- double high_threshold,
- double & min_value,
- double & max_value,
- double & mean_value,
- double & std_value,
- int & min_element_id,
- int & max_element_id,
- std::vector< int > & mesh_list,
- std::string & element_type,
- int & bad_group_id,
- bool make_group)
- entity_typeSpecifies the geometry type of the entity
- id_listSpecifies a list of ids to work on
- metric_nameSpecify the metric used to determine the quality
- single_thresholdQuality threshold value
- use_low_thresholduse threshold as lower or upper bound
- low_thresholdQuality threshold when using a lower and upper range
- high_thresholdQuality threshold when using a lower and upper range
- min_valueQuality value of the worst element
- max_valueQuality value of the best element
- mean_valueAverage quality value of all elements
- std_valueStd deviationvalue of all elements
- min_element_idID of the worst element
- max_element_idID of the best element
- mesh_listlist of failed elements
- element_typetype of failed elements (does not support mixed element types)
- make_groupwhether to create a group or not
- bad_group_idID of the created group
- min_valueUser specified variable where the minimum quality value will be returned
- max_valueUser specified variable where the maximum quality value will be returned
- mean_valueUser specified variable where the mean quality value will be returned
- std_valueUser specified variable where the standard deviation quality value will be returned
- const std::string & geom_type,
- const std::string & mesh_type,
- const std::vector< int > geom_id_list,
- const int expand_levels,
- const std::string & metric_name,
- const double single_threshold,
- const bool use_low_threshold,
- const double low_threshold,
- const double high_threshold,
- const bool make_group)
- geom_typeSpecifies the geometry type of the entities
- mesh_typeSpecifies the element type to find quality at geom entities
- id_listSpecifies a list of geometry entity ids to work on
- expand_levelsNumber of element levels from target geometry to expand
- metric_nameSpecify the metric used to determine the quality
- single_thresholdQuality threshold value
- use_low_thresholduse threshold as lower or upper bound
- low_thresholdQuality threshold when using a lower and upper range
- high_thresholdQuality threshold when using a lower and upper range
- const std::string & mesh_type,
- int mesh_id,
- const std::string & metric_name)
- mesh_typeSpecifies the mesh entity type (hex, tet, tri, quad)
- mesh_idSpecifies the id of the mesh entity
- metric_nameSpecifies the name of the metric (skew, taper, jacobian, etc)
- const std::string & source_geometry_type,
- int source_id,
- const std::string & target_geom_type)
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_geometry_type, '1' is the source_id, and 'surface' is the target_geom_type.
- source_geom_typeThe entity type of the source entity
- source_idThe id of the source entity
- target_geom_typeThe target geometry type
- const std::string & geometry_type,
- int entity_id)
- geom_typeSpecifies the geometry type of the entity
- entity_idSpecifies the id of the entity
- const std::string & geometry_type,
- int entity_id)
- geom_typeSpecifies the geometry type of the entity
- entity_idSpecifies the id of the entity
- const std::string & geometry_type,
- int id)
- geom_typeSpecifies the geometry type of the entity
- entity_idSpecifies the id of the entity
- const std::string & geometry_type,
- int entity_id)
- geom_typeSpecifies the geometry type of the entity
- entity_idSpecifies the id of the entity
- int index)
- int index)
- std::vector< int > target_volume_ids,
- double upper_bound,
- double lower_bound)
'Sharp' is a function of the upper_bound and lower_bound threshold parameters. The id of vertices is returned. Similar to get_sharp_curve_angles except only vertices are returned with angles above upper_bound and below lower_bound
- target_volume_idsList of volume ids to examine.
- upper_boundUpper threshold angle
- lower_boundLower threshold angle
- std::vector< int > target_volume_ids,
- std::vector< int > & returned_large_curve_angles,
- std::vector< int > & returned_small_curve_angles,
- std::vector< double > & returned_large_angles,
- std::vector< double > & returned_small_angles,
- double upper_bound,
- double lower_bound)
'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.
- target_volume_idsList of volume ids to examine.
- large_curve_anglesUser specified list where the ids of curves with curve angles will be returned
- small_curve_anglesUser specified list where the ids of curves with small angles will be returned
- large_anglesUser 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_anglesUser 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_boundUpper threshold angle
- lower_boundLower threshold angle
- std::vector< int > target_volume_ids,
- std::vector< int > & returned_large_surface_angles,
- std::vector< int > & returned_small_surface_angles,
- std::vector< double > & returned_large_angles,
- std::vector< double > & returned_small_angles,
- double upper_bound,
- double lower_bound)
'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.
- target_volume_idsList of volume ids to examine.
- large_surface_anglesUser specified list where the ids of surfaces with large angles will be returned
- small_surface_anglesUser specified list where the ids of surfaces with small angles will be returned
- large_anglesUser 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_anglesUser 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_boundUpper threshold angle
- lower_boundLower threshold angle
- int sideset_id,
- std::vector< int > & returned_face_list,
- std::vector< int > & returned_surface_list,
- std::vector< int > & returned_curve_list)
A nodeset can contain a variety of entity types. This routine will return all contents of a specified sideset.
- sideset_idUser specified id of the desired sideset
- face_listUser specified list where faces associated with this sideset are returned
- surface_listUser specified list where surfaces associated with this sideset are returned
- curve_listUser specified list where curves associated with this sideset are returned
- int sideset_id)
- sideset_idUser specified id of the desired sideset
- int sideset_id)
- sideset_idThe id of the sideset to be queried
- bc_type_inType of bc to query, as defined by enum CI_BCTypes. 1-9 is FEA, 10-30 is CFD
- bc_idID of the bc to query
- int sideset_id)
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.
- sideset_idUser specified id of the desired sideset
- int sideset_id)
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.
- sideset_idUser specified id of the desired sideset
- std::vector< int > curve_ids)
- curve_idsIDs of curve to compare against
- std::vector< int > surface_ids)
- surface_idsIDs of surface to compare against
- std::vector< int > volume_ids)
- volume_idsIDs of volume(s) to compare against
- const std::string & entity_type,
- int surface_id)
- entity_typeType (volume or surface)
- entity_idId of the entity
- std::vector< int > target_ids,
- double small_area,
- double small_curve_size)
- target_volume_idsList of volume ids to examine.
- small_areaIndicate the area threshold
- small_curve_sizeIndicate size for 'narrowness'
- std::vector< int > target_volume_ids,
- double mesh_size)
'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.
- target_volume_idsList of volume ids to examine. in Cubit is valid as input here.
- mesh_sizeIndicate the mesh size used as the threshold
- std::vector< int > target_volume_ids,
- double max_radius)
- target_volume_idsList of volume ids to examine. max_radius maximum radius of curvature for which blend surfaces will be returned if max_radius = 0, then all blend surfaces will be returned.
- std::vector< int > target_volume_ids,
- double mesh_size)
'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.
- target_volume_idsList of volume ids to examine.
- mesh_sizeIndicate the mesh size used as the threshold
- std::vector< int > target_volume_ids,
- double mesh_size)
'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.
- target_volume_idsList of volume ids to examine.
- mesh_sizeIndicate the mesh size used as the threshold
- std::vector< int > target_volume_ids,
- double mesh_size,
- std::vector< int > & returned_small_surfaces,
- std::vector< double > & returned_small_radius)
'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.
- target_volume_idsList of volume ids to examine.
- mesh_sizeIndicate the mesh size used as the threshold
- returned_small_surfacesids of small hydraulic radius surfaces will be returned
- returned_small_radiusUser The hydrualic radius of each small surface will be returned. The order of the radius values is the same as the order of the returned ids.
- std::vector< int > target_volume_ids,
- double mesh_size)
'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. volumes with volume < 10*mesh_size^3 will be returned.
- target_volume_idsList of volume ids to examine.
- mesh_sizeIndicate the mesh size used as the threshold
- std::vector< int > target_volume_ids,
- double mesh_size,
- std::vector< int > & returned_small_volumes,
- std::vector< double > & returned_small_radius)
'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.
- target_volume_idsList of volume ids to examine.
- mesh_sizeIndicate the mesh size used as the threshold
- small_volumesUser specified list where the ids of small volumes will be returned
- small_radiusUser 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.
- std::vector< int > target_volume_ids,
- int number_to_return)
- target_volume_idsList of volume ids to examine. in Cubit is valid as input here.
- num_to_returnIndicate the number of curves to return
- std::vector< int > target_ids,
- int & returned_number_to_return,
- std::vector< int > & returned_type_1_list,
- std::vector< int > & returned_type_2_list,
- std::vector< int > & returned_id_1_list,
- std::vector< int > & returned_id_2_list,
- std::vector< double > & returned_distance_list)
- target_idsThe entities to query
- num_to_returnnumber of small features to return
- type1_list
- type2_list
- id1_list
- id2_list
- distance_list
- const std::string & geometry_type,
- int entity_id)
- geom_typeSpecifies the geometry type of the entity
- entity_idSpecifies the id of the entity
- std::string geom_type,
- int geom_id)
- geom_type"curve", "surface", "volume" or "body"
- geom_idID of geometry entity
- int surface_id)
- surface_idthe surface being queried
- max_radiusthe maximum radius of curvature for which solutions will be returned max_radius=-1 will return solutions for any blend
- int surface_id)
- surface_idthe surface being queries
- std::string classification,
- int vol_id)
- classificationstring defining the classification type: "bolt", "nut", "washer", "spring", "ball", "race", "pin", "gear", "other"
- vol_id
- int surface_id,
- double mesh_size)
- surface_idthe surface being queried
- mesh_sizeIndicate size for 'narrowness'
- int surface_id)
- surface_idcone surface
- const std::vector< int > & volume_list,
- double exterior_angle,
- bool do_imprint_merge,
- bool tolerant_imprint)
- volume_listList of volumes to query
- exterior_angleThreshold value for the exterior angle
- do_imprint_mergeSet to true (1) if you want the imprint and merge to be done
- tol_imprintSet to true (1) if you want to do a tolerant imprint
- int volume_id,
- std::vector< int > & source_surface_id_list,
- std::vector< int > & target_surface_id_list,
- double small_curve_size)
- volume_idid 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
- int surface_id1,
- int surface_id2)
- surface_id1overlapping surface 1 surface_id2 overlapping surface 2
- int vertex_id,
- int curve_id)
- vertex_idID of the vertex
- curve_idID of the curve
- int vertex_id,
- int surface_id)
- vertex_idID of the vertex
- surface_idID of the surface
- int vertex_id_1,
- int vertex_id_2)
- target_vertex_idsVertex list
- high_toleranceThe upper threshold tolerance value
- int surface_id_1,
- int surface_id_2)
- idof surface 1
- idof surface 2
- int volume_id_1,
- int volume_id_2,
- double maximum_gap_tolerance,
- double maximum_gap_angle)
- idof volume 1
- idof volume 2
- int vertex_id,
- double small_curve_size,
- double mesh_size)
- vertex_idvertex with sharp angle
- small_curve_sizeThreshold value used to determine what 'small' is
- mesh_sizeElement size of the model
- int curve_id,
- double small_curve_size,
- double mesh_size)
- curve_idSmall curve
- small_curve_sizeThreshold value used to determine what 'small' is
- mesh_sizeElement size of the model
- int surface_id,
- double small_curve_size,
- double mesh_size)
- surface_idSmall surface
- small_curve_sizeThreshold value used to determine what 'small' is
- mesh_sizeElement size of the model
- int surface_id,
- double small_curve_size,
- double mesh_size)
- surface_idSmall surface
- small_curve_sizeThreshold value used to determine what 'small' is
- mesh_sizeElement size of the model
- int vol_id,
- double small_curve_size,
- double mesh_size)
- vol_id
- small_curve_sizeThreshold value used to determine what 'small' is
- mesh_sizeElement size of the model
- int volume_id)
- volume_idSpecifies the volume id
- int edge_id)
- sphere_idSpecifies the id of the sphere
- const std::string & entity_type,
- int entity_id,
- int dimension)
- entity_typeThe mesh element type of the higher dimension entity
- entity_idThe mesh element id
- dimensionThe dimension of the desired sub entities
- int surface_id)
- theid of the surface
UNSET_TYPE = -1, END_TYPE = 1, SIDE_TYPE, CORNER_TYPE, REVERSAL_TYPE, TRIANGLE_TYPE, NON_TRIANGLE_TYPE };
- int surface_id)
- surface_idID of the surface
- const std::vector< int > & volume_list,
- double hr_threshold,
- double area_threshold,
- std::vector< double > & return_cavity_hrs,
- std::vector< double > & return_cavity_areas)
- volume_listList of volumes to query
- hr_thresholdreturn cavities with computed hydraulic radius less than hr_threshold. Where hr = 4*Area/Perimeter. Use hr_threshold < 0.0 to return all cavities
- area_thresholdreturn cavities with computed surface area less than area_threshold. Use area_threshold < 0.0 to return all cavities
- returna vector of cavity areas corresponding to the return cavity id lists
- int surface_id)
- surface_idID of the surface
- int surface_id)
- int surface_id)
- surface_idUser specified id of the desired surface
- int surface_id)
- surf_idid of surface
- int surface_id)
- surface_idID of the surface
- int surface_id,
- std::array< double, 3 >)
- surface_idID of the surface
- coordarray of x,y,z location on surface
- int surface_id)
- surface_idUser specified id of the desired surface
- int surface_id)
- surface_idID of the surface
- int surface_id)
- surface_idUser specified id of the desired surface
- int surface_id)
- surface_idID of the surface
- int surface_id)
- surface_idUser specified id of the desired surface
- int surface_id)
- surface_idID of the surface
- std::vector< int > target_ids,
- double narrow_size)
- target_volume_idsList of volume ids to examine.
- narrow_sizeIndicate the size that defines 'narrowness'
- std::vector< int > target_volume_ids,
- double upper_bound,
- double lower_bound)
'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.
- target_volume_idsList of volume ids to examine.
- upper_boundUpper threshold angle
- lower_boundLower threshold angle
- int volume_id)
- volume_idSpecifies the volume id
- int tet_id)
- tet_idSpecifies the id of the tet
- int volume_id)
- int volume_id)
- volume_idthe volume id
- int volume_id)
- volume_idthe volume id
- const std::string & geometry_type,
- std::vector< int > entity_list)
- geom_typeSpecifies the geometry type of the entity
- entity_listList of ids associated with geom_type
- const std::string & geometry_type,
- std::vector< int > entity_list)
- geom_typeSpecifies the geometry type of the entity
- entity_listList of ids associated with geom_type
- std::vector< int > volume_list)
- volume_listList of volume ids
- int tri_id)
- tri_idSpecifies the id of the tri
/brief Query whether undo is currently enabled
/return True if undo is enabled, otherwise false
- int vertex_id)
- vertex_idID of vertex
- int block_id)
- block_idThe block id
- int entity_id)
/param entity_id Id of the velocity /return The combine type for the given velocity
- int entity_id)
/param entity_id Id of the velocity /return
- int entity_id)
/param entity_id Id of the velocity /return
- int vertex_id)
- vert_idid of vertex
- int surface_id,
- int vertex_id)
- surface_idId of the surface associated with the vertex
- vertex_idId of the vertex
- std::vector< int > sphere_id_list,
- int & rad_intervals,
- int & az_intervals,
- double & bias,
- double & fract,
- int & max_smooth_iterations)
- sphere_id_listlist of volume ids (should be spheres)
- rad_intervalsnumber of radial intervals (around circle)
- az_intervalsnumber of intervals from inner mapped box to surface
- biasbias from inner mapped box to surface (<1 increases size to boundary)
- fractfraction of radius to use as size of interior mapped box
- max_smooth_iterationsmax number of smooth iterations to perform after meshing
- int volume_id)
- volume_idID of the volume
- int volume_id)
- int surface_id_1,
- int surface_id_2)
Get lists of display strings and command strings for gaps
- idof surface 1
- idof surface 2
- std::vector< int > target_volume_ids,
- std::vector< int > & returned_surface_list_1,
- std::vector< int > & returned_surface_list_2,
- std::vector< double > & returned_distance_list,
- std::vector< double > & returned_overlap_area_list,
- double maximum_gap_tolerance,
- double maximum_gap_angle,
- int cache_overlaps)
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.
- target_volume_idsList of volume ids to examine.
- surf_list_1User specified list where the ids of the gap surfaces will be returned
- surf_list_2User specified list where the ids of the gap surfaces will be returned
- distance_listUser specified list where the distance between the gap surface will be returned
- max_gap_toleranceUser specified tolerance used to find the gaps.
- cache_overlapsspeed up overlaps by caching and using previously computed results. Default 0 = no caching. 1 = clear out old values first. 2 = use and add to existing cache
- int volume_id)
- volume_idUser specified id of the desired volume
- int volume_id)
- vol_idid of volume
- int volume_id)
- volume_idUser specified id of the desired volume
- int wedge_id)
- wedge_idSpecifies the id of the wedge
- std::string source_type,
- int source_id,
- int sideset_id)
- source_typeItem type - could be 'face', 'quad' or 'tri'
- source_idID of entity
- sideset_idID of the sideset
- std::vector< std::string > & name_list,
- std::vector< int > & returned_id_list)
- name_listUser specified list where the active group names will be returned
- id_listUser specified list where the ids of all active groups will be returned
return A list of std::pair<std::string, int> structure instances
/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
- const std::vector< std::string > & argv)
- argvList of start-up directives. A blank list such as [''] will suffice. See Cubit Help for details
- int volume_id)
- volume_idID of the volume
- int surface_id)
- surface_idID ofsurface
- int surface_id)
- surface_idID ofsurface
- int surface_id,
- double mesh_size)
- surface_idID ofsurface
- mesh_sizeIndicate the mesh size used as the threshold
- int surface_id)
- surface_idID ofsurface
- int surface_id,
- double angle_tol)
- surface_idID ofsurface
- angle_tolangle tolerance for continuity
- int surface_id)
- surface_idID ofsurface
- int surface_id)
- surface_idId of the surface
- const std::string & geometry_type,
- int entity_id)
- geom_typeSpecifies the geometry type of the entity
- entity_idSpecifies the id of the entity
- const std::string & element_type,
- int element_id)
- element_typeMesh type of the element
- element_idID of the mesh element return True if in a group, otherwise false
- const std::string & geometry_type,
- int entity_id)
- geom_typeSpecifies the geometry type of the entity
- entity_idSpecifies the id of the entity
- int body_id)
- body_idId of the body
- int surface_id,
- double mesh_size)
- surface_idID ofsurface
- mesh_sizethreshold used to determine if is narrow
/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
- int target_id,
- std::vector< int > id_list)
- target_idTarget id
- id_listList of ids
- const std::string & geometry_type,
- int entity_id)
- geom_typeSpecifies the geometry type of the entity
- entity_idSpecifies the id of the entity
- const std::string & geometry_type,
- int entity_id,
- const std::array< double, 3 > & xyz_point)
- geom_typestring defining geometry type (volume or body) id ID of the geometric entity point xyz triplet defining the point (note that it must be std::array<double,3>
- int volume_id)
- volume_idId of the volume
- int surface_id)
- surface_idSpecifies the id of the surface
- const std::string & geometry_type,
- int entity_id)
- geom_typeSpecifies the geometry type of the entity
- entity_idSpecifies the id of the entity
- const std::string & geometry_type,
- int entity_id)
- geom_typeSpecifies the geometry type of the entity
- entity_idSpecifies the id of the entity
- int volume_id)
was the -workingdir passed in from the command line
- bool state)
- stateA boolean that turns journaling on (1) and off (0)
- std::string entity_type1,
- int entity_id1,
- std::string entity_type2,
- int entity_id2)
/brief returns distance between two geometry entities and their closest points
- entity_type1type of first entity
- entity_id1id of first entity
- entity_type2type of second entity
- entity_id2id of second entity
/brief Query whether there are any undo commands to execute
/return The number of commands in the undo stack
- JournalStreamBase * jnl_stream)
- const std::string & type,
- std::string entity_list_string)
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')
- typeThe specific entity type represented by the list of entities
- int_listThe string that contains the entity list
- const char * input_line,
- int order_dependent,
- int consecutive_dependent)
- input_lineThe current command line being typed by the user
- order_dependentIs set to '1' if the key pressed is not &, otherwise '0'
- consecutive_dependentIs set to '1' if the pressed is '?', otherwise '0'
- [in] heightThe height of the prism
- [in] sidesThe number of sides of the prism
- [in] majorThe major radius
- [in] minorThe minor radius
- std::vector< std::vector< double > > pts,
- int surface_id,
- int quad_id,
- int node00_id,
- int node10_id)
- ptsThe x,y (abstract u,v) coordinates of the input points. Should be in [0,1].
- surf_idThe surface.
- quad_idThe quad.
- node00_idThe id of the node of the quad corresponding to an input point with coordinates (0,0)
- node10_idThe id of the node of the quad corresponding to an input point with coordinates (1,0)
- [in] heightThe height of the pyramid
- [in] sidesThe number of sides of the pyramid
- [in] majorThe major radius
- [in] minorThe minor radius
- [in] topdetermines size for the top of the pyramid. Defaults to 0, meaning it will go to a point
- [in] entityThe Entity to be reflected
- [in] axisThe axis to be reflected about
- [in] previewFlag to show the preview or not, default is false
- CubitBaseInterface * instance)
- interface_namethe name of interface
- int group_id,
- int entity_id,
- const std::string & entity_type)
- group_idID of group from which the entity will be removed
- entity_idID of the entity to be removed from the group
- entity_typeType of the entity to be removed from the group. Note that only geometric entities can be removed
- std::vector< int > tet_ids)
/brief Deletes over-constrained tets (tets with all
four corner nodes and and two triangles on the same surface).
The tet is deleted and two triangles are created from
the back sides of the tet. For tets with mid-edge nodes,
the tet is only removed if after removal, the mid-edge
node on the back of the tet
can be snapped to the surface without causing adjacent
tets to have an inradius smaller than the tet we are removing.
- CubitProgressHandler * progress)
- progressA pointer to a CubitProgressHandler instance
- [in] entityThe Entity to be scaled
- [in] factorThe scale factor
- [in] previewFlag to show the preview or not, default is false
- std::string val)
- std::string val)
- std::string val)
- bool interrupt)
- interruptBoolean set to TRUE if process is to be stopped
- CubitMessageHandler * hdlr)
- const std::string & entity_type,
- int entity_id,
- const std::string & new_name)
- entity_typeSpecifies the type of the entity
- entity_idSpecifies the id of the entity
- new_nameSpecifies what the name of the entity should be changed to
- ExternalExitHandler * hdlr)
- Aninstance of a class that inherits from ExternalExitHandler
- const char * entity_type,
- int label_flag)
/brief make calls to SVDrawTool::set_label_type
/return none.
- int maximum_group_id)
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.
- max_idID of group to make 'max'
- const double maximum_angle)
- maxangle
- const double maximum_gap)
- maxgap
- const double min_gap)
- min_gap
- ExternalPlaybackHandler * hdlr)
- bool pause)
- pauseTrue if playback should be paused when an error occurs.
- CubitProgressHandler * progress)
- progressA pointer to a CubitProgressHandler instance
- int mode)
- modeInteger associated with the rendering mode. Options are 1,7,2,8, or 5
- const char * input_string)
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.
- input_stringPointer to a string containing a complete Cubit command
- std::vector< double > locations,
- std::string entity_type,
- int entity_id,
- double tol)
/brief Snaps xyz locations to closest point on entity.
Then snaps to child curves or vertices within given tolerance.
Vertices snapped to before curves.
- [in] radiusThe radius of the sphere
- [in] x_cutIf 1, cuts sphere by yz plane (default to 0)
- [in] y_cutIf 1, cuts sphere by xz plane (default to 0)
- [in] z_cutIf 1, cuts sphere by xy plane (default to 0)
- [in] inner_radiusThe inside radius if the sphere is hollow (default to 0)
- std::vector< int > ids)
For example: string_from_id_list(<1, 2, 3, 4, 5, 6, 7, 8>) returns '1 to 8' example: string_from_id_list(<1, 2, 3, 100, 5, 6, 7, 8>) returns '1 to 3, 5 to 8, 100'
- idsThe vector of integer ids
- std::vector< CubitInterface::Body > tool_in,
- std::vector< CubitInterface::Body > from_in,
- bool imprint_in,
- bool keep_old_in)
- id_inThe ID of the surface
- [in] curvesA list of curves to sweep
- [in] along_curvesA list of curves to sweep along
- [in] draft_angleThe sweep draft angle (default to 0)
- [in] draft_typeThe draft type (default to 0) 0 => extended (draws two straight tangent lines from the ends of each segment until they intersect) 1 => rounded (create rounded corner between segments) 2 => natural (extends the shapes along their natural curve) ***
- [in] rigidThe inside radius if the sphere is hollow (default to False)
- CI_BCTypes bc_type_enum,
- CI_BCEntityTypes bc_area_enum,
- int entity_id)
/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
/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
- [in] r1radius from center to center of circle to be swept (r1>r2)
- [in] r2radius of circle swept to create torus (r1>r2)
- std::vector< Curve > curves,
- std::vector< double > distances,
- bool keep_old,
- bool preview)
- [in] curvesA list of curve objects to offset
- [in] distancesA list of distances associated with the offset for each curve
- [in] keep_oldKeep the old body (defaults to false)
- [in] previewFlag to show the preview (defaults to false)
- std::vector< Curve > curves,
- bool keep_old,
- bool preview)
Removes a curve from a body
- [in] surfacesA list of the curves to be removed
- [in] keep_oldKeep the old body (defaults to false)
- [in] previewFlag to show the preview (defaults to false)
- std::vector< Surface > surfaces,
- std::vector< double > distances)
- surfacesA list of surface objects to offset
- distancesA list of distances associated with the offset for each surface
- std::vector< Surface > surfaces,
- bool extend_ajoining,
- bool keep_old,
- bool preview)
Removes a surface from a body
- [in] surfacesThe surfaces to be removed
- [in] extend_ajoiningExtend the ajoining surfaces (default to true)
- [in] keep_oldKeep the old body (default to false)
- [in] previewFlag to show the preview or not (default to false)
- std::vector< Vertex > verts,
- double radius,
- bool keep_old,
- bool preview)
- [in] vertsA list of vertex objects to fillet
- [in] r0radius of the fillet
- [in] keep_oldKeep the old body (defaults to false)
- [in] previewFlag to show the preview (defaults to false)
- [in] body_inA list of body objects to unite
- [in] keep_old_inFlag to keep old bodies (defaults to false)
- const std::string & entity_type,
- int entity_id)
Unselecting an entity will unhighlight it in the graphics window and remove it from the global pick list.
- entity_typeThe type of the entity to be unselected
- entity_idThe ID of the entity to be unselected
- id_inThe ID of the vertex
- id_inThe ID of the volume
- int volume_id)
- std::string words)
words string to write to journal file