boxes

Unless otherwise specified, data names are accessible in level 3 only.

activesuppressed
Returns non-zero if the entity is set inactive, 0 otherwise.
Type: integer
ars_fr
Defines a radius of curvature to smooth discontinuities between adjoining straight-line segments, adjoining circular-arc segments, and adjoining straight-line and circular-arc segments.
Type: double
ars_maxratio
The upper bound of the ratio of a facet's contact thickness to its minimum edge (or diagonal) length.
Type: double
ars_scalethick
The amount by which to scale the thicknesses of the underlying elements to compute the contact thicknesses.
Type: double
ars_trim_value
Invoke trimming of open free surfaces.
Type: unsigned integer
ars_types
The surface type:
1 - Segment
2 - Cylinder
3 - Revolution
Type: unsigned integer
attributesmax
The number of attributes owned by this entity.
Type: unsigned integer
box_corner1
The minimum corner points of the box.
Type: triple double
box_corner2
The maximum corner points of the box.
Type: triple double
box_corner1_x
The minimum x-corner point of the box. Valid for hm_getvalue query only.
Type: double
box_corner1_y
The minimum y-corner point of the box. Valid for hm_getvalue query only.
Type: double
box_corner1_z
The minimum z-corner point of the box. Valid for hm_getvalue query only.
Type: double
box_corner2_x
The maximum x-corner point of the box. Valid for hm_getvalue query only.
Type: double
box_corner2_y
The maximum y-corner point of the box. Valid for hm_getvalue query only.
Type: double
box_corner2_z
The maximum z-corner point of the box. Valid for hm_getvalue query only.
Type: double
box_corner_node1
The node defining minimum corner points of a box.
Type: pointer
box_corner_node2
The node defining maximum corner points of a box.
Type: pointer
box_system
Local coordinate system of a box.
Type: pointer
color
The 1-64 color of the entity.
Type: integer
color_rgb
The RGB color of the entity.
Type: string
config
The geometry type configuration of the entity.
201 - Rectangular box
202 - Cylindrical box
203 - Spherical box
Type: unsigned integer
crop_orient_a_x
The x coordinate of the lower box corner. Valid for hm_getvalue query only..
Type: double
crop_orient_a_y
The y coordinate of the lower box corner. Valid for hm_getvalue query only.
Type: double
crop_orient_a_z
The z coordinate of the lower box corner. Valid for hm_getvalue query only.
Type: double
crop_orient_b_x
The x coordinate of the opposite box corner. Valid for hm_getvalue query only.
Type: double
crop_orient_b_y
The y coordinate of the opposite box corner. Valid for hm_getvalue query only.
Type: double
crop_orient_b_z
The z coordinate of the opposite box corner. Valid for hm_getvalue query only.
Type: double
cylinder_base_node
Base node of the cylinder.
Type: entity
cylinder_base_point
Base point of the cylinder.
Type: triple double
cylinder_base_x
Base point x-coordinate of the cylinder. Valid for hm_getvalue query only.
Type: double
cylinder_base_y
Base point y-coordinate of the cylinder. Valid for hm_getvalue query only.
Type: double
cylinder_base_z
Base point z-coordinate of the cylinder. Valid for hm_getvalue query only.
Type: double
cylinder_diameter
Diameter of the cylinder.
Type: double
cylinder_direction_node
Direction axis node of the cylinder.
Type: entity
cylinder_direction_point
Direction axis point of the cylinder.
Type: triple double
cylinder_direction_x
Direction axis x-point of the cylinder. Valid for hm_getvalue query only.
Type: double
cylinder_direction_y
Direction axis y-point of the cylinder. Valid for hm_getvalue query only.
Type: double
cylinder_direction_z
Direction axis z-point of the cylinder. Valid for hm_getvalue query only.
Type: double
definedentity
True if the entity is defined, false otherwise.
Type: Boolean
gen_pointa
The global coordinates of point a.
Type: triple double
gen_pointb
The global coordinates of point b.
Type: triple double
gen_pointc
The global coordinates of point c.
Type: triple double
global_a_x
The global x coordinate of point a. Valid for hm_getvalue query only.
Type: double
global_a_y
The global y coordinate of point a. Valid for hm_getvalue query only.
Type: double
global_a_z
The global z coordinate of point a. Valid for hm_getvalue query only.
Type: double
global_b_x
The global x coordinate of point b. Valid for hm_getvalue query only.
Type: double
global_b_y
The global y coordinate of point b. Valid for hm_getvalue query only.
Type: double
global_b_z
The global z coordinate of point b. Valid for hm_getvalue query only.
Type: double
global_c_x
The global x coordinate of point c. Valid for hm_getvalue query only.
Type: double
global_c_y
The global y coordinate of point c. Valid for hm_getvalue query only.
Type: double
global_c_z
The global z coordinate of point c. Valid for hm_getvalue query only.
Type: double
id
The ID of the entity.
Type: unsigned integer
include
The ID of the include file the entity is organized in.
Type: entity
includeid
The ID of the include file the entity is organized in.
Type: unsigned integer
internalid
The ID of the entity.
Type: unsigned integer
internalname
The internal name of the entity.
Type: string
moduleid
The module ID of the entity.
Type: integer
name
The name of the entity.
Type: string
no_offset
Returns true if this surface will ignore the midplane offset of any shell, membrane, or rigid elements that form the surface.
Type: Boolean
no_thickness
Returns true if this surface will ignore the thickness of any shell, membrane, or rigid elements that form the surface.
Type: Boolean
orienta_pointa
The coordinates of the lower box corner.
Type: triple double
orienta_pointa
The coordinates of the opposite box corner.
Type: triple double
Orientation
Returns true if defining coordinates of first and second point orientation.
Type: Boolean
outputsuppressed
Returns non-zero if the entity is set "do not export", 0 otherwise.
Type: integer
poolid
The pool number of the entity.
Type: integer
poolname
The pool name of the entity.
Type: string
preservenodes
Returns true if the box corner nodes are to be preserved, false otherwise.
Type: Boolean
region_type
Relevant for surfaces defined on the boundary of an adaptive mesh domain.
Type: unsigned integer
segment_datalines
Subsequent data lines define the various line, circular, and parabolic segments that form the profile of the analytical surface.
Type: unsigned integer
segment_p1_x
The x coordinate of end point 1.
Type: double
segment_p1_y
The y coordinate of end point 1.
Type: double
segment_p2_x
The x coordinate of end point 2.
Type: double
segment_p2_y
The y coordinate of end point 2.
Type: double
segment_start_x
The local r coordinate of the starting point of the line segments.
Type: double
segment_start_y
The local z coordinate of the starting point of the line segments.
Type: double
segment_table
The table defining the line, circle and parabola to form a cylinder and revolution.
Type: entity
segment_types
The line, circular, and parabolic segments that form the profile of the analytical surface.
Type: unsigned integer
solver_id
The solver ID of the entity.
Type: integer
solverkeyword
The name of the solver keyword.
Type: string
solvername
The solver name of the entity for entities enabled for name pool, otherwise the internal name of the entity.
Type: string
sphere_center_node
Center point node of the sphere.
Type: entity
sphere_center_point
Center point of the sphere.
Type: triple double
sphere_center_x
Center point x-coordinate of the sphere. Valid for hm_getvalue query only.
Type: double
sphere_center_y
Center point y-coordinate of the sphere. Valid for hm_getvalue query only.
Type: double
sphere_center_z
Center point z-coordinate of the sphere. Valid for hm_getvalue query only.
Type: double
sphere_diameter
Diameter of the sphere.
Type: double
Surface
Create a new surface that will contain only those faces from an existing surface that have nodes in a specified rectangular box.
Type: entity array

Version History

2020 - Added new data names ars_fr, ars_maxratio, ars_scalethick, ars_trim_value, ars_types, color_rgb, crop_orient_a_x, crop_orient_a_y, crop_orient_a_z, crop_orient_b_x, crop_orient_b_y, crop_orient_b_z, gen_pointa, gen_pointb, gen_pointc, global_a_x, global_a_y, global_a_z, global_b_x, global_b_y, global_b_z, global_c_x, global_c_y, global_c_z, no_offset, no_thickness, orienta_pointa, orienta_pointb, orientation, region_type, segment_datalines, segment_p1_x, segment_p1_y, segment_p2_x, segment_p2_y, segment_start_x, segment_start_y, segment_table, segment_types and surface.

2020.1 - Added new data name solverkeyword.

2021.1 - Added new data names moduleid, poolid, poolname, and solver_id.

2021.2 - Added new data names internalname and solvername.