free shape

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
anchorpoint
Pointer to the anchor node.
Type: pointer
anchorpointid
The ID of the anchor node.
Type: integer
attributesmax
The number of attributes owned by this entity.
Type: unsigned integer
boundary
Flag indicating that the boundary information of design domain is to follow.
Type: Boolean
boundary_btype
The boundary handling type for shell design domain.
FREE (default), FIXED or Blank.
Type: string
boundary_option
0 - BTYPE
1 - SETID
Type: unsigned integer
boundary_setid
Grid SET identification number, which contains a set of non-design grids.
Type: entity
boundary_skip
Which nodes should be excluded from the design domain.
BOTH (default), BC, SPC, LOAD or NONE.
Type: string
bounds
Flag indicating that shape variable bounds bounds_lb and bounds_ub are defined.
0 - Off
1 - On
Type: Boolean
bounds_lb
The shape design variable lower bound.
When bounds_lb is TOTAL, (Blank, Real≤0.0)
When bounds_lb is MESHF, (Blank, Real≥0.0)
Type: double
bounds_option
Character flag indicating the bound setting method.
TOTAL - bounds_lb and bounds_ub are total absolute values
MESHF - bounds_lb and bounds_ub are relative factors of average mesh size
Type: string
bounds_ub
The shape design variable upper bound.
(Blank, Real≥0.0)
Type: double
config
The configuration of the entity.
112 - Free shape
Type: unsigned integer
configname
The solver keyword for the designvar. Valid for hm_getvalue query only.
Type: string
definedentity
True if the entity is defined, false otherwise.
Type: Boolean
designable
Mesh smoothing method.
1 - Optimized for speed
2 - Optimized for accuracy
Type: integer
draft
Indicates whether draftangle is applied. Only used when a draw direction constraint is defined.
0 - Off
1 - On
Type: Boolean
draftangle
The draft angle, in degrees (0 <= draftangle > 90.0)
Type: double
dshapeconstrained
Array of integers indicating the type of constraint specified on each of the GRIDCON nodes. Valid for hm_getvalue query only.
1 - FIXED
2 - VECTOR
3 - PLANAR
Type: integer array
dshapeconstrainedfortable
Defines the GRIDCON constrained type.
Type: string array
dshapeconstrainedfortableset
The GRIDCON constrained type.
Type: string array
dshapeconstrainedset
The array of integers indicating the type of constraint specified on each of the GRIDCON sets. Valid for hm_getvalue query only.
1 - FIXED
2 - VECTOR
3 - PLANAR
Type: integer array
dshapegridconvector
The x-y-z component of the GRIDCON vector of motion.
Type: double array
dshapegridconvectorset
The x, y, and z component of the GRIDCON vector of motion.
Type: double array
extrusion
Flag to indicate if extrusion constraints are being applied.
Type: Boolean
filter
Flag indicating that nodal shape sensitivities filtering options are to follow.
Type: Boolean
filter_radius
The sensitivities filtering radius.
Type: double
filter_type
The filtering type of nodal shape sensitivities. It indicates the method of nodal shape sensitivities smoothing.
GAUSS (default), LINEAR, QUAD or CUBIC.
Type: string
firstgrid
The ID of the first grid node.
Type: integer
freeshape_lowerbound
The x-y-z component of side constraints defined by lower bounds of coordinates.
Type: double array
freeshape_manualblock
The side constrained option:
0 - Manual
1 - Block
Type: integer
freeshape_method
The free shape optimization method.
CLASSIC (default), GRID or Blank.
Type: string
freeshape_nodesettoggle
Option to select grids or gridset for free shape optimization.
Type: unsigned integer
freeshape_systemid
The pointer of a coordinate system in which the x-y-z components are resolved.
Type: entity
freeshape_systemval
The system type in the DRAW category:
0 - Global
1 - Local
Type: integer
freeshape_upperbound
The x-y-z component of side constraints defined by upper bounds of coordinates.
Type: double array
freeshapeblock
Array of side constraint blocks.
Type: entity array
freeshapedirection
The direction type for free shape variation DTYPE.
Type: integer
freeshapedrawtype
The draw type.
Type: integer
freeshapeelem
An array of element IDs for which the DSHAPE card is defined.
Type: entity array
freeshapegridcnodelistmax
The total count of GRIDCON nodes. Valid for hm_getvalue query only.
Type: unsigned integer
freeshapegridcnodes
Array of grid IDs which are constrained to move in a predefined matter, GDID#.
Type: entity array
freeshapegridcsetlistmax
The total count of GRIDCON sets. Valid for hm_getvalue query only.
Type: unsigned integer
freeshapegridcsets
The array of set IDs which are constrained to move in a predefined matter, GCSETID#.
Type: entity array
freeshapegridsetsystem
The ID of a coordinate system in which the x, y, and z components are resolved.
Type: entity array
freeshapegridsystem
The ID of a coordinate system in which the x-y-z components are resolved.
Type: entity array
freeshapemaxgrow
The maximum growing distance.
Type: double
freeshapemaxshrink
The maximum shrinking distance.
Type: double
freeshapenodes
Array of grid IDs for which the DSHAPE card is defined.
Type: entity array
freeshapentrans
The number of design grid layers in the transition zone to the non-design area.
Type: integer
freeshapeproperty
An array of property IDs for which the DSHAPE card is defined.
Type: entity array
freeshapeset
Grid SET identification number containing design grids for free-shape optimization..
Type: entity
freeshapesidecon_component
The BMFACE ID which defines a list of quads and/or trias which define a barrier that the design surface will not penetrate during shape optimization.
Type: entity
freeshapesidecon_systemid
The SIDECON coordinate system pointer.
Type: entity
freeshapesidecon_systemval
The system type in the SIDECON category:
0 - Global
1 - Local
Type: integer
freeshapesmoothingmethod
Mesh smoothing method.
Type: integer
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
initialvalue
The initial maximum perturbation factor MVFACTOR.
Type: double
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
nlayer_value
The number of grid layers (valid if smooth_nlayer is set to “integer”).
Type: integer
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
smooth
The flag to indicate that the parameters for mesh smoothing method are to follow.
0 - Off
1 - On
Type: Boolean
smooth_method
The mesh smoothing method.
1 - Laplacian based method. (default)
2 - FEA based method.
Type: string
smooth_nlayer
The number of grid layers for mesh smoothing.
Integer – Indicates Integer value. (default)
All - Indicates that the entire model is involved in mesh smoothing.
Type: string
smooth_trans
The flag to indicate a transition zone to the non-design region.
No – There is no transition zone to a non-design region. (default)
Yes - There is a transition zone to a non-design region.
Type: string
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
type
The pattern grouping type. If > 0, the PATRN card is specified.
Type: integer
xorder
The number of mesh smoothing layers NSMOOTH.
Type: double
xtype
The direction type for free shape variation DTYPE.
1 - BOTH
2 - GROW
3 - SHRINK
Type: integer
yorder
Draw Type.
1 - Single
Type: integer
ytype
Flag indicating that extrusion constraints are being applied.
Type: integer
vectorcomponents
The x-y-z component of a vector under the system defined by the extrusion coordinate system, which defines the extrusion path.
Type: double array

Grid constraint variables (applicable if GRIDCON is specified on DSHAPE card).

$DSHP_BARRIER_COMPONENTID
The BMFACE ID which defines a list of QUADs and/or TRIAs which define a barrier that the design surface will not penetrate during shape optimization.
Type: entity
$TPL_DrawAnchorNodeId
Draw direction anchor point.
Type: entity
$TPL_DrawAnchorX
X component of draw direction anchor point.
Type: double
$TPL_DrawAnchorY
Y component of draw direction anchor point.
Type: double
$TPL_DrawAnchorZ
Z component of draw direction anchor point.
Type: double
$TPL_DrawFirstGridId
Direction of vector for draw direction definition.
Type: integer
$TPL_DrawFirstGridX
X component of direction of vector for draw direction definition.
Type: double
$TPL_DrawFirstGridY
Y component of direction of vector for draw direction definition.
Type: double
$TPL_DrawFirstGridZ
Z component of direction of vector for draw direction definition.
Type: double
$DSHP_EXTRUSION_CID
The ID of a coordinate system which the following X, Y, and Z components are resolved in.
Type: entity
$DSHP_EXTRUSION_XE
X component of a vector under system defined by $DSHP_EXTRUSION_CID, which define the extrusion path.
Type: double
$DSHP_EXTRUSION_YE
Y component of a vector under system defined by $DSHP_EXTRUSION_CID, which define the extrusion path.
Type: double
$DSHP_EXTRUSION_ZE
Z component of a vector under system defined by $DSHP_EXTRUSION_CID, which define the extrusion path.
Type: double
$DSHP_GSETID
Grid SET identification number. A grid set containing design grids for free-shape optimization.
Type: entity
$DSHP_GRIDCON_CID
Array of coordinate system IDs in which the motion components are resolved, CID#.
Type: entity array
$DSHP_GRIDCON_CTYPE
Array of integers indicating the type of constraint specified on each of the GRIDCON nodes, CTYPE#.
1 - FIXED
2 - VECTOR
4 - PLANAR
Type: integer array
$DSHP_GRIDCON_NODES
Array of grid IDs which are constrained to move in a predefined manner, GDID#.
Type: entity array
$DSHP_GRIDCON_SETS
Number of grid SET identification.
Type: integer
$DSHP_GRIDCON_XCOMP
Array of reals indicating the x component of motion.
Type: double array
$DSHP_GRIDCON_YCOMP
Array of reals indicating the y component of motion.
Type: double array
$DSHP_GRIDCON_ZCOMP
Array of reals indicating the z component of motion.
Type: double array
$DSHP_GRIDS
Array of grid IDs for which the DSHAPE card is defined.
Type: entity array
$DSHP_MAXSHRINK
Maximum shrinking distance
Type: double
$DSHP_MAXGROW
Maximum growing distance.
Type: double
$DSHP_SET_GRIDCON_CTYPE
Specifies the type of constraint applied to the grid.
Type: array of entity
$DSHP_SET_GRIDCON_CID
The ID of a coordinate system which the following X, Y, and Z components are resolved in.
Type: array of entity
$DSHP_SET_GRIDCON_XCOMP
Array of reals indicating the x component of motion.
Type: double array
$DSHP_SET_GRIDCON_YCOMP
Array of reals indicating the y component of motion.
Type: double array
$DSHP_SET_GRIDCON_ZCOMP
Array of reals indicating the z component of motion.
Type: double array
$DSHP_SIDECON_BLOCKS
Array of side constraint blocks.
Type: array of entity
$DSHP_SIDECON_CID
Array of coordinate system IDs.
Type: array of entity
$DSHP_SIDECON_LB_X
Array of x component of side constraints defined by lower bounds of coordinates.
Type: array of real
$DSHP_SIDECON_LB_Y
Array of y component of side constraints defined by lower bounds of coordinates.
Type: array of real
$DSHP_SIDECON_LB_Z
Array of z component of side constraints defined by lower bounds of coordinates.
Type: array of real
$DSHP_SIDECON_UB_X
Array of x component of side constraints defined by upper bounds of coordinates.
Type: array of real
$DSHP_SIDECON_UB_Y
Array of y component of side constraints defined by upper bounds of coordinates.
Type: array of real
$DSHP_SIDECON_UB_Z
Array of z component of side constraints defined by upper bounds of coordinates.
Type: array of real
$TPL_SymmetryAnchorX
If coordinates were used to specify the anchor point, the x coordinate of the point.
Type: double
$TPL_SymmetryAnchorY
If coordinates were used to specify the anchor point, the y coordinate of the point.
Type: double
$TPL_SymmetryAnchorZ
If coordinates were used to specify the anchor point, the z coordinate of the point.
Type: double
$TPL_SymmetryFirstGridX
If coordinates were used to specify the first point, the x coordinate of the point.
Type: double
$TPL_SymmetryFirstGridY
If coordinates were used to specify the first point, the y coordinate of the point.
Type: double
$TPL_SymmetryFirstGridZ
If coordinates were used to specify the first point, the z coordinate of the point.
Type: double

Version History

2017.1 - Added new data names dshapeconstrained, dshapeconstrainedfortable, vdshapegridconvector, extrusion, freeshape_lowerbound, freeshape_manualblock, freeshape_nodesettoggle, freeshape_systemid, freeshape_systemval, freeshape_upperbound, freeshapeblock, freeshape_direction, freeshapedrawtype, freeshapegridcnodelistmax, freeshapegridcnodes, freeshapegridsystem, freeshapemaxgrow, freeshapemaxshrink, freeshapenodes, freeshapentrans, freeshapeset, freeshapesidecon_component, freeshapesidecon_systemid, freeshapesidecon_systemval, freeshapesmoothingmethod and vectorcomponents.

2019.1 - Added new data names boundary, boundary_btype, boundary_option, boundary_setid, boundary_skip, bounds, bounds_lb, bounds_option, bounds_ub, draft, draftangle, filter, filter_radius, filter_type, freeshape_method, freeshapeelem and freeshapeproperty.

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 dshapeconstrainedfortableset, dshapeconstrainedset, dshapegridconvectorset, freeshapegridcsetlistmax, freeshapegridcsets, freeshapegridsetsystem, internalname, and solvername.

2024 - Added new data names nlayer_value, smooth, smooth_method, smooth_nlayer, and smooth_trans.