PCL Reference Manual > Basic Functions > Tools Menu
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
Tools Menu
This section is used to describe functions that used to create and manipulate lists of geometric and finite element model entities using the list processor and the list processor format. It is also used to describe some of the functions that can be used to create and report the mass properties associated with a model.
The list processing functions described below all make use of five global variables as a working or scratch space: lista, lista_reset, listb, listb_reset, and listc. These variables are all global virtual string variables whose length is manipulated with the aid of the sys_allocate_string() and sys_reallocate_string() functions. They can be accessed directly if a declaration similar to the following is made in a PCL source file:
 GLOBAL STRING lista[VIRTUAL]
However, extreme care should be used in accessing or manipulating these values directly as they are intended for internal use only and changing the contents of these strings can lead to unpredictable results.
 
list_create_boolean_list
(blist_a,blist_b,btype,bret_list)
 
Description:
This function creates a list of entities by combining the contents of the global strings lista and listb using the type of operation specified by the input value boolean and placing the results in the global string listc.
Input:
STRING
blist_a[]
This value specifies the first string of entities to be combined.
STRING
blist_b[]
This value specifies the second string of entities to be combined.
STRING
btype[7]
This value specifies the type of operation to be used to combine the first and second strings of entities. See the remarks below for more information.
Output:
STRING
bret_list[]
This value returns the results of the specified combination operation.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
48000002
*%A% * is not a valid boolean operator!
48000013
Boolean listc is empty!
Remarks:
The input value btype can have the following values used to specify the different types of combinational operations which combine the lists listed by the global string values lista and listb in the following manner:
 
Operational string value
Description:
“or”, “eval_or”
Combines the two global strings lista and listb, sorts them, and deletes any duplicate values.
“and”, “and_fg”
Combines the two global strings lista and listb, sorts them, and leaves any duplicate entries in place.
“a-b”
Removes all items in listb from lista, then sorts the results.
“b-a”
Removes all items in lista from listb, then sorts the results.
This function will display an information popup form if the boolean operation results in an single space character string or if both of the input values blist_a and blist_b are set to some combination of either “” or “None”. The information popup form will have the following message:
 
48000013
Boolean listc is empty!
This function will display a warning popup form with the following message if the input value btype is set to an invalid value:
 
48000002
*%A% * is not a valid boolean operator!
This function calls the function fem_u_count_id() and will display a warning type popup form and return the error value returned by this function if it has an error.
Space is internally allocated for the output value bret_list. It is the responsibility of the calling function to free the allocated string storage space.
Example:
Please see list_create_boolean_list (p. 293) in the PCL Reference Manual Examples.
 
list_create_curve_ass_geo
(entity_list, target, return_list)
 
Description:
This function will create a list of all curves from a list of geometric entities.
Input:
STRING
entity_list[]
This value specifies a list of geometric entities.
STRING
target[6]
This value specifies which global string will be used for the storage of the results. This argument can have the following values: ”lista”, or “listb”.
Output:
STRING
return_list[VIRTUAL]
This value returns a list of curves.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000003
LpSublistType: No sublist filter bits are set on invocation
14000004
LpSublistType: I am being invoked with a NULL list
14000005
LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006
LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007
LpSublistType: In the list being used, the current finite element sublist is unclassifiable.
14000008
LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009
LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010
LpSublistType: In the list being used, the current sublist does not match the sublist filter.
14000014
LpSublistNext: Attempt to proceed past last sublist in current list.
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000281
LpExpandPclVariables: Virtual memory is full.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
48000001
*%A% * is not a valid target list!
48000006
No Curve found!
Remarks:
Space is internally allocated for the output value return_list. It is the responsibility of the calling function to free the allocated string storage space.
This function can display an information popup form with the following messages:
 
48000006
No Curve found!
This function can display a warning popup form with the following messages:
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000281
LpExpandPclVariables: Virtual memory is full.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
This function makes use of following documented functions:
app_get_handle()
lp_sublist_count()
list_create_target_list()
Example:
Please see list_create_curve_ass_geo (p. 294) in the PCL Reference Manual Examples.
  
list_create_curve_ass_group
(group_list, number_of_groups, target, return_list)
 
Description:
This function will create a list of all curves in a list of groups of geometric entities.
Input:
STRING
group_list[](number_of_groups)
This value specifies a list of groups of geometric entities.
INTEGER
number_of_groups
This value specifies the number of groups in the group_list input value.
STRING
target[6]
This value specifies which global string will be used for the storage of the results. This argument can have the following values: ”lista”, or “listb”.
Output:
STRING
return_list[VIRTUAL]
This value returns a list of curves.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
8104003
Out of room in destination format string.
8107002
Last command aborted.
11000050
The group name is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000105
The specified group was not found in the database.
11000121
There is not a current group defined.
11000127
The group does not have any entities in it.
48000001
*%A% * is not a valid target list!
48000006
No Curve found!
48000010
No Group selected!
Remarks:
Space is internally allocated for the output value return_list. It is the responsibility of the calling function to free the allocated string storage space.
This function can display an information popup form with the following messages:
 
48000006
No Curve found!
This function can display a warning popup form with the following messages:
8104003
Out of room in destination format string.
8107002
Last command aborted.
11000050
The group name is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000105
The specified group was not found in the database.
11000121
There is not a current group defined.
11000127
The group does not have any entities in it.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
13000008
Group not found
13000014
Viewport not found
48000001
*%A% * is not a valid target list!
48000010
No Group selected!
This function makes use of following documented functions:
list_create_target_list()
Example:
Please see list_create_curve_ass_group (p. 296) in the PCL Reference Manual Examples.
 
list_create_elem_ass_geo
(element_shape_code, entity_list, target, return_list)
 
Description:
This function will create a list of all elements of a particular finite element model shape in a list of geometric entities.
Input:
INTEGER
element_shape_code
This value specifies a code value used to select the type of element shape to be used to make the returned list of entities. See the remarks below for more information.
STRING
entity_list[]
This value specifies a list of geometric entities.
STRING
target[6]
This value specifies which global string will be used for the storage of the results. This argument can have the following values: “lista”, or “listb”.
Output:
STRING
return_list[VIRTUAL]
This value returns a list of elements.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000003
LpSublistType: No sublist filter bits are set on invocation
14000004
LpSublistType: I am being invoked with a NULL list
14000005
LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006
LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007
LpSublistType: In the list being used, the current finite element sublist is unclassifiable.
14000008
LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009
LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010
LpSublistType: In the list being used, the current sublist does not match the sublist filter.
14000014
LpSublistNext: Attempt to proceed past last sublist in current list.
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000281
LpExpandPclVariables: Virtual memory is full.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
48000001
*%A% * is not a valid target list!
48000003
No Element found!
Remarks:
The input value element_shape_code can have the following values:
Element Shape Code
Description
0
Any element
1
point
2
beam/bar
3
tria
4
quad
5
tet
6
pyramid
7
wedge
8
hex
Space is internally allocated for the output value return_list. It is the responsibility of the calling function to free the allocated string storage space.
This function can display an information popup form with the following messages:
48000003
No Element found!
This function can display a warning popup form with the following messages:
 
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000281
LpExpandPclVariables: Virtual memory is full.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
This function makes use of following documented functions:
list_create_target_list()
Example:
Please see list_create_elem_ass_geo (p. 297) in the PCL Reference Manual Examples.
 
list_create_elem_ass_group
(element_shape_code, group_list, number_of_groups, target, return_list)
 
Description:
This function will create a list of all elements of a particular finite element model shape in a list of groups of geometric entities.
Input:
INTEGER
element_shape_code
This value specifies a code value used to select the type of element shape to be used to make the returned list of entities. See the remarks below for more information.
STRING
group_list[](number_of_groups)
This value specifies a list of groups of geometric entities.
INTEGER
number_of_groups
This value specifies the number of groups in the group_list input value.
STRING
target[6]
This value specifies which global string will be used for the storage of the results. This argument can have the following values: “lista”, or “listb”.
Output:
STRING
return_list[VIRTUAL]
This value returns a list of elements.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
8104003
Out of room in destination format string.
8107002
Last command aborted.
11000050
The group name is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000105
The specified group was not found in the database.
11000121
There is not a current group defined.
11000127
The group does not have any entities in it.
48000001
*%A% * is not a valid target list!
48000003
No Element found!
48000010
No Group selected!
Remarks:
The input value element_shape_code can have the following values:
 
Element Shape Code
Description
0
Any element
1
point
2
beam/bar
3
tria
4
quad
5
tet
6
pyramid
7
wedge
8
hex
Space is internally allocated for the output value return_list. It is the responsibility of the calling function to free the allocated string storage space.
This function can display an information popup form with the following messages:
 
48000003
No Element found!
This function can display a warning popup form with the following messages:
8104003
Out of room in destination format string.
8107002
Last command aborted.
11000050
The group name is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000105
The specified group was not found in the database.
11000121
There is not a current group defined.
11000127
The group does not have any entities in it.
48000010
No Group selected!
This function makes use of following documented functions:
list_create_target_list()
Example:
Please see list_create_elem_ass_group (p. 299) in the PCL Reference Manual Examples
 
list_create_elem_ass_node
(element_shape_code, node_list, target, return_list)
 
Description:
This function will create a list of all elements of a particular finite element model shape in a list of nodes.
Input:
INTEGER
element_shape_code
This value specifies a code value used to select the type of element shape to be used to make the returned list of elements. See the remarks below for more information.
STRING
node_list[]
This value specifies a list of nodes.
STRING
target[6]
This value specifies which global string will be used for the storage of the results. This argument can have the following values: “lista”, or “listb”.
Output:
STRING
return_list[VIRTUAL]
This value returns a list of elements.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
1
This is an internal status condition. There is no corresponding status message in the message database.
258
This is an internal status condition. There is no corresponding status message in the message database.
259
This is an internal status condition. There is no corresponding status message in the message database.
13000096
Not enough storage allocated for elements
14000004
LpSublistType: I am being invoked with a NULL list
48000001
*%A% * is not a valid target list!
48000003
No Element found!
 
Remarks:
The input value element_shape_code can have the following values:
 
Element Shape Code
Description
0
Any element
1
point
2
beam/bar
3
tria
4
quad
5
tet
6
pyramid
7
wedge
8
hex
Space is internally allocated for the output value return_list. It is the responsibility of the calling function to free the allocated string storage space.
This function can display a warning popup form with the following messages:
 
1
Not owner
13000096
Not enough storage allocated for elements
14000004
LpSublistType: I am being invoked with a NULL list
This function can display an information popup form with the following messages:
48000003
No Element found!
This function makes use of following documented functions:
list_create_target_list()
sys_allocate_array()
Example:
None.
 
list_create_elem_att_fringe
(element_shape_code, fringe_limits, fringe_comparison_type, tolerance, group_name, target, return_list)
 
Description:
This function will create a list of all elements of a particular finite element model shape with a specified fringe value in a single group of geometric entities.
Input:
INTEGER
element_shape_code
This value specifies a code value used to select the type of element shape to be used to make the returned list of entities. See the remarks below for more information.
REAL
fringe_limits(2)
This value specifies the lower fringe limit as the value in offset 1 and the upper fringe limit as the value in offset 2.
STRING
fringe_comparison_type[7]
This value specifies the method that will be used for comparing the fringe limits to the fringe value of the element shape. See the remarks below for more information.
REAL
tolerance
This value specifies a range over which a match between the input value fringe_limits and the fringe value for the finite element model shape can be made.
STRING
group_name[]
This value specifies the name of a group of geometric entities.
STRING
target[6]
This value specifies which global string will be used for the storage of the results. This argument can have the following values: “lista”, or “listb”.
Output:
STRING
return_list[VIRTUAL]
This value returns a list of elements.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
13000008
Group not found
1300002
Element not found
15500001
Message 15500001 not found in message file(s)
15500002
Message 15500002 not found in message file(s)
15500003
Message 15500003 not found in message file(s)
48000001
*%A% * is not a valid target list!
48000003
No Element found!
48000010
No Group selected!
48000014
*%A% * is not a valid Value option!
Remarks:
The input value element_shape_code can have the following values:
Element Shape Code
Description
0
Any element
1
point
2
beam/bar
3
tria
4
quad
5
tet
6
pyramid
7
wedge
8
hex
The input value fringe_comparison_type can have the following values:
 
Operation Name
Operation Action
“equal”
Is the fringe value within the input value tolerance of the input value fringe_limits(1)?
“minimum”
Is the fringe value less than the input value fringe_limits(1) plus the input value tolerance?
“maximum”
Is the fringe value greater than the input value fringe_limits(1) plus the input value tolerance?
“range”
Does the fringe value fall in the range defined by the input value fringe_limits(1) as the lower limit and input value fringe_limits(2) as the upper limit plus or minus the input value tolerance?
Space is internally allocated for the output value return_list. It is the responsibility of the calling function to free the allocated string storage space.
This function can display an information popup form with the following messages:
48000003
No Element found!
This function can display a warning popup form with the following messages:
 
13000008
Group not found
13000021
Element not found
15500001
Message 15500001 not found in message file(s)
15500002
Message 15500002 not found in message file(s)
15500003
Message 15500003 not found in message file(s)
48000010
No Group selected!
48000014
*%A% * is not a valid Value option!
This function makes use of following documented functions:
list_create_target_list()
Example:
Please see list_create_elem_att_fringe (p. 302) in the PCL Reference Manual Examples.
 
list_create_elem_att_mat
(element_shape_code, material_list, num_materials, target, return_list)
 
Description:
This function will create a list of all elements of a particular finite element model shape from a list of material names.
Input:
INTEGER
element_shape_code
This value specifies a code value used to select the type of element shape to be used to make the returned list of entities. See the remarks below for more information.
STRING
material_list[](num_materials)
This value specifies a list of materials names.
INTEGER
num_materials
This value specifies the number of material entries in the material_list input value.
STRING
target[6]
This value specifies which global string will be used for the storage of the results. This argument can have the following values: ”lista”, or “listb”.
 
Output:
STRING
return_list[VIRTUAL]
This value returns a list of elements.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
-1
This is an internal status condition. There is no corresponding status message in the message database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
13000120
The material specified in the query was not found
48000001
*%A% * is not a valid target list!
48000003
No Element found!
Remarks:
The input value element_shape_code can have the following values:
Element Shape Code
Description
0
Any element
1
point
2
beam/bar
3
tria
4
quad
5
tet
6
pyramid
7
wedge
8
hex
Space is internally allocated for the output value return_list. It is the responsibility of the calling function to free the allocated string storage space.
This function can display an information popup form with the following messages:
48000003
No Element found!
This function can display a warning popup form with the following messages:
 
-1
End of File Reached
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
13000120
The material specified in the query was not found
48000009
No Material selected!
This function makes use of following documented functions:
list_create_target_list()
Example:
Please see list_create_elem_att_mat (p. 304) in the PCL Reference Manual Examples.
 
list_create_elem_att_prop
(element_shape_code, properties_list, num_properties, target, return_list)
 
Description:
This function will create a list of all elements of a particular finite element model shape from a list of property names.
Input:
INTEGER
element_shape_code
This value specifies a code value used to select the type of element shape to be used to make the returned list of entities. See the remarks below for more information.
STRING
properties_list[](num_properties)
This value specifies a list of property names.
INTEGER
num_properties
This value specifies the number of material entries in the properties_list input value.
STRING
target[6]
This value specifies which global string will be used for the storage of the results. This argument can have the following values: ”lista”, or “listb”.
Output:
STRING
return_list[VIRTUAL]
This value returns a list of elements.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
 
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
29004006
Property%A% could not be retrieved from the database.
48000001
*%A% * is not a valid target list!
48000003
No Element found!
48000011
No Property selected!
Remarks:
The input value element_shape_code can have the following values:
Element Shape Code
Description
0
Any element
1
point
2
beam/bar
3
tria
4
quad
5
tet
6
pyramid
7
wedge
8
hex
Space is internally allocated for the output value return_list. It is the responsibility of the calling function to free the allocated string storage space.
This function can display an information popup form with the following messages:
48000003
No Element found!
This function can display a warning popup form with the following messages:
 
48000001
*%A% * is not a valid target list!
48000011
No Property selected!
This function can display a fatal popup form with the following messages:
 
29004006
Property%A% could not be retrieved from the database.
 
This function makes use of following documented functions:
list_create_target_list()
Example:
Please see list_create_elem_att_prop (p. 306) in the PCL Reference Manual Examples.
list_create_ent_ass_group
(group_count, group_name, entity_count, entity_name, return_list)
Description:
This function will retrieve from the database a list of entities with an association to groups.
Input:
INTEGER
group_count
This value specifies the number of groups.
STRING
group_name[31](group_count)
This array specifies the group names. The default group will be used if this value is set to ““.
INTEGER
entity_count
This value specifies the number of acceptable entity types.
STRING
entity_name[7](entity_count)
This array specifies the acceptable entity type names. See the remarks below for more information.
Output:
STRING
return_list[VIRTUAL]
This value returns a list processor string of entities.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate an error.
Error Conditions:
-1
This is an internal error status condition. There is no corresponding status message in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need to release the memory of the output variable.
 
The input value entity_name can have the following values:
Point
Curve
Surface
Solid
Node
Element
MPC
 
 
Example:
Please see list_create_elem_ass_group (p. 299) in the PCL Reference Manual Examples.
list_create_ent_ass_vp
(viewport_count, viewport_name, entity_count, entity_name, return_list)
 
Description:
This function will retrieve from the database a list of entities with an association to viewports.
Input:
INTEGER
viewport_count
This value specifies the number of viewports.
STRING
viewport_name[31](viewport_count)
This array specifies the viewport names. The default viewport will be used if this value is set to ““.
INTEGER
entity_count
This value specifies the number of acceptable entity types.
STRING
entity_name[7](entity_count)
This array specifies the acceptable entity type names. See the remarks below for more information.
Output:
STRING
return_list[VIRTUAL]
This value returns a list processor string of entities.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate an error.
Error Conditions:
-1
This is an internal error status condition. There is no corresponding status message in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need to release the memory of the output variable.
The input value entity_name can have the following values:
Point
Curve
Surface
Solid
Node
Element
MPC
 
 
Example:
Please see list_create_ent_ass_vp (p. 310) in the PCL Reference Manual Examples.
list_create_ent_att_ep_name
(ep_count, ep_name, entity_count, entity_name, return_list)
 
Description:
This function will retrieve from the database a list of entities with an association to element properties.
Input:
INTEGER
ep_count
This value specifies the number of element properties.
STRING
ep_name[31](ep_count)
This array specifies the element property names.
INTEGER
entity_count
This value specifies the number of acceptable entity types.
STRING
entity_name[7](entity_count)
This array specifies the acceptable entity type names. See the remarks below for more information.
Output:
STRING
return_list[VIRTUAL]
This value returns a list processor string of entities.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate an error.
Error Conditions:
-1
This is an internal error status condition. There is no corresponding status message in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need to release the memory of the output variable.
The input value entity_name can have the following values:
Point
Curve
Surface
Solid
Node
Element
MPC
 
 
Example:
Please see list_create_ent_att_ep_name (p. 311) in the PCL Reference Manual Examples.
list_create_ent_att_ep_type
(general_count, general_name, entity_count, entity_name, return_list)
 
Description:
This function will retrieve from the database a list of entities with an association to generic element types.
Input:
INTEGER
general_count
This value specifies the number of generic element types.
STRING
general_name[](general_count)
This array specifies the generic element type names. See the remarks below for more information.
INTEGER
entity_count
This value specifies the number of acceptable entity types.
STRING
entity_name[7](entity_count)
This array specifies the acceptable entity type names. See the remarks below for more information.
Output:
STRING
return_list[VIRTUAL]
This value returns a list processor string of entities.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate an error.
Error Conditions:
-1
This is an internal error status condition. There is no corresponding status message in the message database.
 
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need to release the memory of the output variable.
The input value general_name can have the following values:
Mass
Axisym Shell
Rotary Inertia
1D Preference
Grounded Spring
Planar Beam
Grounded Damper
3D Beam
IRS ( single node )
ISL ( in plane )
3D Mass
ISL ( in space )
2D Mass
Slide Line
Beam
IRS ( planar/axisym )
Beam in XY Plane
IRS ( beam/pipe )
Beam in Space
RigidSurf ( Seg )
2D Spar
RigidSurf ( Cyl )
3D Spar
RigidSurf ( Axi )
Elastic Beam
RigidSurf ( Bz2D )
Thin-Walled Beam
Shell
Rod
Thin Shell
Link
Thick Shell
Truss
Plate
Spring
Bending Panel
Damper
2D Solid
Spring/Damper
Membrane
Gap
Shear Panel
2D Gap
Twist Panel
3D Gap
Rigid Surface
Cable
2D Preference
Planar Rigid Surf
IRS ( shell/solid )
Combination
RigidSurf ( Bz3D )
Surface Effect
Solid
1D Mass
3D Preference
Axisymmetric Link
 
The input value entity_name can have the following values:
Point
Curve
Surface
Solid
Node
Element
MPC
 
 
Example:
Please see list_create_ent_att_ep_type (p. 312) in the PCL Reference Manual Examples.
list_create_ent_att_lbc_name
(lbc_count, lbc_name, entity_count, entity_name, return_list)
 
Description:
This function will retrieve from the database a list of entities with an association to load and boundary condition names.
Input:
INTEGER
lbc_count
This value specifies the number of load and boundary condition names.
STRING
lbc_name[31](lbc_count)
This array specifies the load and boundary condition names.
INTEGER
entity_count
This value specifies the number of acceptable entity types.
STRING
entity_name[7](entity_count)
This array specifies the acceptable entity type names. See the remarks below for more information.
Output:
STRING
return_list[VIRTUAL]
This value returns a list processor string of entities.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate an error.
Error Conditions:
-1
This is an internal error status condition. There is no corresponding status message in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need to release the memory of the output variable.
The input value entity_name can have the following values:
Point
Curve
Surface
Solid
Node
Element
MPC
 
 
Example:
Please see list_create_ent_att_lbc_name (p. 314) in the PCL Reference Manual Examples.
list_create_ent_att_lbc_type
(lbc_type_count, lbc_type_name, entity_count, entity_name, return_list)
 
Description:
This function will retrieve from the database a list of entities with an association to load and boundary condition types.
Input:
INTEGER
lbc_type_count
This value specifies the number of load and boundary condition type names.
STRING
lbc_type_name[31](lbc_type_count)
This array specifies the load and boundary condition type names. See the remarks below for more information.
INTEGER
entity_count
This value specifies the number of acceptable entity types.
STRING
entity_name[7](entity_count)
This array specifies the acceptable entity type names. See the remarks below for more information.
Output:
STRING
return_list[VIRTUAL]
This value returns a list processor string of entities.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate an error.
Error Conditions:
-1
This is an internal error status condition. There is no corresponding status message in the message database.
 
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need to release the memory of the output variable.
The input value lbc_type_name can accept a variety of values that are dependent on the type of preference currently loaded. Examples of these type names are “Temperature”, and “Pressure”. A complete of the values allowed under the current preference can be seen by selecting “Loads/BCs” on the tool bar of Patran and then setting the “Action” entry on the form to “Create”. The currently allowed lbc_type_name values are displayed when the “Object” list on the form is selected.
The input value entity_name can have the following values:
Point
Curve
Surface
Solid
Node
Element
MPC
 
 
Example:
Please see list_create_ent_att_lbc_type (p. 316) in the PCL Reference Manual Examples.
list_create_ent_att_mat_name
(material_count, material_name, entity_count, entity_name, return_list)
Description:
This function will retrieve from the database a list of entities with an association to material property names.
Input:
INTEGER
material_count
This value specifies the number of materials.
STRING
material_name[31](material_count)
This array specifies the material names.
INTEGER
entity_count
This value specifies the number of acceptable entity types.
STRING
entity_name[7](entity_count)
This array specifies the acceptable entity type names. See the remarks below for more information.
Output:
STRING
return_list[VIRTUAL]
This value returns a list processor string of entities.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate an error.
Error Conditions:
-1
This is an internal error status condition. There is no corresponding status message in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need to release the memory of the output variable.
The input value entity_name can have the following values:
Point
Curve
Surface
Solid
Node
Element
MPC
 
 
Example:
Please see list_create_ent_att_mat_name (p. 317) in the PCL Reference Manual Examples.
list_create_ent_att_mat_type
(mat_type_count, mat_type_name, entity_count, entity_name, return_list)
 
Description:
This function will retrieve from the database a list of entities with an association to material property types.
Input:
INTEGER
mat_type_count
This value specifies the number of material types.
STRING
mat_type_name[31](mat_type_count)
This array specifies the material type names. See the remarks below for more information.
INTEGER
entity_count
This value specifies the number of acceptable entity types.
STRING
entity_name[7](entity_count)
This array specifies the acceptable entity type names. See the remarks below for more information.
Output:
STRING
return_list[VIRTUAL]
This value returns a list processor string of entities.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate an error.
Error Conditions:
-1
This is an internal error status condition. There is no corresponding status message in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need to release the memory of the output variable.
The input value mat_type_name can accept a variety of values that are dependent on the type of preference currently loaded. Examples of these type names are “Isotropic”, and “2d Orthotropic”. A complete of the values allowed under the current preference can be seen by selecting “Materials” on the tool bar of Patran and then setting the “Action” entry on the form to “Create”. The currently allowed mat_type_name values are displayed when the “Object” list on the form is selected.
The input value entity_name can have the following values:
Point
Curve
Surface
Solid
Node
Element
MPC
 
 
Example:
Please see list_create_ent_att_mat_type (p. 319) in the PCL Reference Manual Examples.
list_create_ent_att_mat_value
(entity_count, entity_name, mat_prop_name, minimum, maximum, eval_at_temperature, evaluation_strain, evaluation_rate, evaluation_time, evaluation_frequency, return_list)
Description:
 
 
This function will retrieve from the database a list of entities with an association to material property word values.
Input:
 
 
INTEGER
entity_count
This value specifies the number of acceptable entity types.
STRING
entity_name[7](entity_count)
This array specifies the acceptable entity type names. See the remarks below for more information.
STRING
mat_prop_name[]
This value specifies the material property word name. See the remarks below for more information.
REAL
minimum
This value specifies the minimum value for the range of the material value.
REAL
maximum
This value specifies the maximum value for the range of the material value.
REAL
evaluation_temperature
This value specifies the temperature value used for field evaluation.
REAL
evaluation_strain
This value specifies the strain, total strain, plastic strain, or stress value used for field evaluation.
REAL
evaluation_rate
This value specifies the strain rate value used for field evaluation.
REAL
evaluation_time
This value specifies the time value used for field evaluation.
REAL
evaluation_frequency
This value specifies the frequency value used for field evaluation.
Output:
STRING
return_list[VIRTUAL]
This value returns a list processor string of entities.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate an error.
Error Conditions:
-1
This is an internal error status condition. There is no corresponding status message in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need to release the memory of the output variable.
If a load and boundary condition variable value cannot be evaluated because it is based on a field which cannot be evaluated, the corresponding material and element properties associated with the material are skipped. A field that is of the general field type is a typical cause of this behavior.
The input value entity_name can have the following values:
Point
Curve
Surface
Solid
Node
Element
MPC
 
 
The input value mat_prop_name can have the following values:
Value
Name
Value
Name
 
 
 
 
1
Reference Temperature
144
Coefficient D
2
Elastic Modulus
145
Coefficient E
3
Elastic Modulus 22
146
Coefficient F
4
Elastic Modulus 33
147
Coefficient G
5
Poisson Ratio
148
Interaction Term 23
6
Poisson Ratio 23
149
Interaction Term 31
7
Poisson Ratio 31
150
Not used
8
Shear Modulus
.
.
9
Shear Modulus 23
.
.
10
Shear Modulus 31
.
.
11
Not used
502
Not used
12
Not used
503
Stress/Strain Curve
13
Poisson Ratio 13
504
Not used
14
Bulk Modulus
.
.
15
Lame Constant
.
.
16
Density
.
.
17
Conductivity
1000
Not used
18
Conductivity 12
1001
Mass Propornl Damping
19
Conductivity 13
1002
Stiffness Propornl Damping
20
Conductivity 22
1003
Fraction Critical Damping
21
Conductivity 23
1004
Not used
22
Conductivity 33
.
.
23
Specific Heat
.
.
24
Thermal Expansion Coeff
.
.
25
Thermal Expansion Coeff 22
1010
Not used
26
Thermal Expansion Coeff 33
1011
2nd. Yield Stress
27
Thermal Expansion Coeff 12
1012
Plastic Strain
28
Thermal Expansion Coeff 23
1013
Rate Dependent Param D
29
Thermal Expansion Coeff 31
1014
Rate Dependent Param p
30
Structural Damping Coeff
1016
Dilation Angle
31
Emissivity
1017
Ratio of Flow Stresses
32
Not used
1018
Absolute Plastic Strain
.
.
1019
Exponent
.
.
1020
Yield Offset
.
.
1021
Not used
36
Not used
1022
Not used
37
Composite Options Flag
1023
Material Cohesion
38
Positive Definite Flag
1024
Eccentricity Parameter
39
Total Laminate Thickness
1025
Yield Surface Transition
40
Number of Plies
1026
Surface Radius Parameter
41
Laminate Offset
1027
Hydrostatic Yield Stress
42
Moisture Expansion Coeff 11
1028
Volumetric Plastic Strain
43
Moisture Expansion Coeff 22
1029
Not used
44
Moisture Expansion Coeff 33
.
.
45
Moisture Expansion Coeff 12
.
.
46
Moisture Expansion Coeff 23
.
.
47
Moisture Expansion Coeff 31
1100
Not used
48
Force Resultant (N1) per Temp
1101
Real Part of g1
49
Force Resultant (N2) per Temp
1102
Imaginary Part of g1
50
Force Resultant (N12) per Temp
1103
Value of a
51
Moment Resultant (M1) per Temp
1104
Real Part of k1
52
Moment Resultant (M2) per Temp
1105
Imaginary Part of k1
53
Moment Resultant (M12) per Temp
1106
Value of b
54
Stiffness 11
1107
Not used
55
Stiffness 12
.
.
56
Stiffness 13
.
.
57
Stiffness 22
.
.
58
Stiffness 23
1200
Not used
59
Stiffness 33
1201
Value of A
60
Stiffness 44
1202
Value of B
61
Stiffness 45
1203
Value of n
62
Stiffness 46
1204
Value of m
63
Stiffness 55
1205
Value of delta_H
64
Stiffness 56
1206
Value of R
65
Stiffness 66
1207
Not used
66
Stiffness 14
.
.
67
Stiffness 15
.
.
.
Stiffness 16
 
.
68
Not used
1300
Not used
69
Stiffness 24
1301
Coefficient C10
70
Stiffness 25
1302
Coefficient C20
71
Stiffness 26
1303
Coefficient C30
72
Stiffness 34
1304
Coefficient C40
73
Stiffness 35
1305
Coefficient C50
74
Stiffness 36
1306
Coefficient C60
75
Stiffness 11
1307
Not used
76
Stiffness 12
1308
Not used
77
Stiffness 13
1309
Not used
78
Stiffness 22
1310
Not used
79
Stiffness 23
1311
Coefficient C01
80
Stiffness 33
1312
Coefficient C02
81
Membrane Stiffness 11
1313
Coefficient C03
82
Membrane Stiffness 12
1314
Coefficient C04
83
Membrane Stiffness 13
1315
Coefficient C05
84
Membrane Stiffness 22
1316
Coefficient C06
85
Membrane Stiffness 23
1317
Not used
86
Membrane Stiffness 33
1318
Not used
87
Bending Stiffness 11
1319
Not used
88
Bending Stiffness 12
1320
Not used
89
Bending Stiffness 13
1321
Coefficient C11
90
Bending Stiffness 22
1322
Coefficient C21
91
Bending Stiffness 23
1323
Coefficient C12
92
Bending Stiffness 33
1324
Coefficient C31
93
Coupling Stiffness 11
1325
Coefficient C22
94
Coupling Stiffness 12
1326
Coefficient C13
95
Coupling Stiffness 13
1327
Coefficient C41
96
Coupling Stiffness 22
1328
Coefficient C32
97
Coupling Stiffness 23
1329
Coefficient C23
98
Coupling Stiffness 33
1330
Coefficient C14
99
Tension Stress Limit
1331
Coefficient C51
100
Compression Stress Limit
1332
Coefficient C42
101
Shear Stress Limit
1333
Coefficient C33
102
Tension Stress Limit 22
1334
Coefficient C24
103
Compression Stress Limit 22
1335
Coefficient C15
104
Shear Stress Limit 23
1336
Not used
105
Tension Stress Limit 33
.
.
106
Compression Stress Limit 33
.
.
107
Shear Stress Limit 31
.
.
108
Tension Strain Limit
1400
Not used
109
Compression Strain Limit
1401
Coefficient MU1
110
Shear Strain Limit
1402
Coefficient MU2
111
Tension Strain Limit 22
1403
Coefficient MU3
112
Compression Strain Limit 22
1404
Coefficient MU4
113
Shear Strain Limit 23
1405
Coefficient MU5
114
Tension Strain Limit 33
1406
Coefficient MU6
115
Compression Strain Limit 33
1407
Not used
116
Shear Strain Limit 31
1408
Not used
117
Ht Ratio
1409
Not used
118
Not used
1410
Not used
119
Not used
1411
Coefficient ALPHA_1
120
Hardening Slope
1412
Coefficient ALPHA_2
121
Yield Point
1413
Coefficient ALPHA_3
122
Equivalent Yield Stress (J1=0)
1414
Coefficient ALPHA_4
123
Alpha
1415
Coefficient ALPHA_5
124
Beta
1416
Coefficient ALPHA_6
125
Stress 11 Yield Ratio
1417
Not used
126
Stress 22 Yield Ratio
1418
Not used
127
Stress 33 Yield Ratio
1419
Not used
128
Stress 12 Yield Ratio
1420
Not used
129
Stress 23 Yield Ratio
1421
Coefficient D1
130
Stress 31 Yield Ratio
1422
Coefficient D2
131
Internal Friction Angle
1423
Coefficient D3
132
Bonding Shear Stress Limit
1424
Coefficient D4
133
Interaction Term
1425
+Coefficient D5
134
Failure Index
1426
Coefficient D6
135
Creep Reference Temperature
1427
Not used
136
Creep Threshold Factor
.
.
137
Temperature Dependence Exponent
.
.
138
Primary Creep Stiffness
.
.
139
Primary Creep Damping
2001
Not used
140
Secondary Creep Damping
2002
SigmaYY/Strain Curve
141
Coefficient A
2003
SigmaZZ/Strain Curve
142
Coefficient B
2004
SigmaXY/Strain Curve
143
Coefficient C
2005
SigmaYZ/Strain Curve
 
 
2006
SigmaZX/Strain Curve
Example:
Please see list_create_ent_att_mat_value (p. 320) in the PCL Reference Manual Examples.
list_create_ent_att_vp_vis
(viewport_count, viewport_name, entity_count, entity_name, pick_type, pick_erased, return_list)
 
Description:
This function will retrieve from the database a list of entities with an association to viewports.
Input:
 
 
INTEGER
viewport_count
This value specifies the number of viewports.
STRING
viewport_name[31](viewport_count)
This array specifies the viewport names. The default viewport will be used if this value is set to ““.
INTEGER
entity_count
This value specifies the number of acceptable entity types.
STRING
entity_name[7](entity_count)
This array specifies the acceptable entity type names. See the remarks below for more information.
INTEGER
pick_type
This value specifies the type of operation used to select entities in the viewport. This value can be set to 0 for picking entities with a centroid visible in the viewport, 1 for picking entities that have any portion of themselves visible in the viewport, or 2 for picking only entities that are completely visible in the viewport.
INTEGER
pick_erased
This value specifies, when set to TRUE, that entities that have been erased but are still associated with the viewport be considered for retrieval.
Output:
STRING
return_list[VIRTUAL]
This value returns a list processor string of entities.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate an error.
Error Conditions:
-1
This is an internal error status condition. There is no corresponding status message in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need to release the memory of the output variable.
The input value entity_name can have the following values:
Point
Curve
Surface
Solid
Node
Element
MPC
 
 
Example:
Please see list_create_ent_att_vp_vis (p. 323) in the PCL Reference Manual Examples.
 
list_create_fem_con_fem
(in_list, get_node_con_to_node_by_elem, get_node_con_to_node_by_mpc, get_node_used_by_elem, get_node_used_by_mpc, get_elem_using_node, get_elem_adj_to_elem, get_elem_adj_to_mpc, get_mpc_using_node, get_mpc_adj_to_elem, get_mpc_adj_to_mpc, return_list)
Description:
This function queries the database for entities connected to those in a list processor string.
Input:
STRING
in_list[]
This value specifies the list processor string of entities.
INTEGER
get_node_con_to_node_by_elem
This value specifies 1 (TRUE): get nodes connected to nodes in the list processor string by being part of a same Element. 0 otherwise.
INTEGER
get_node_con_to_node_by_mpc
This value specifies 1 (TRUE): get nodes connected to nodes in the list processor string by being part of a same MPC. 0 otherwise.
INTEGER
get_node_used_by_elem
This value specifies 1 (TRUE): get nodes part of an Element in the list processor string. 0 otherwise.
INTEGER
get_node_used_by_mpc
This value specifies 1 (TRUE): get nodes part of an MPC in the list processor string. 0 otherwise.
INTEGER
get_elem_using_node
This value specifies 1 (TRUE): get Elements having at least one node in the list processor string. 0 otherwise.
INTEGER
get_elem_adj_to_elem
This value specifies 1 (TRUE): get Elements adjacent (sharing at least a node) to an Element in the list processor string. 0 otherwise.
INTEGER
get_elem_adj_to_mpc
This value specifies 1 (TRUE): get Elements adjacent (sharing at least a node) to an MPC in the list processor string. 0 otherwise.
INTEGER
get_mpc_using_node
This value specifies 1 (TRUE): get MPCs having at least one node in the list processor string. 0 otherwise.
INTEGER
get_mpc_adj_to_elem
This value specifies 1 (TRUE): get MPCs adjacent (sharing at least a node) to an Element in the list processor string. 0 otherwise.
INTEGER
get_mpc_adj_to_mpc
This value specifies 1 (TRUE): get MPCs adjacent (sharing at least a node) to an MPC in the list processor string. 0 otherwise.
Output:
STRING
return_list[VIRTUAL]
This value returns a list processor string of entities. The entities output are exclusive (not within) to the input list processor string in_list.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate an error.
Error Conditions:
-1
This is an internal error status condition. There is no corresponding status message in the message database.
 
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need to release the memory of the output variable.
Example:
Please see list_create_fem_con_fem (p. 324) in the PCL Reference Manual Examples.
 
list_create_node_ass_elem
(element_list, target, return_list)
 
Description:
This function will create a list of all nodes associated with a list of elements.
Input:
STRING
element_list[]
This value specifies a list of elements.
STRING
target[6]
This value specifies which global string will be used for the storage of the results. This argument can have the following values: ”lista”, or “listb”.
Output:
STRING
return_list[VIRTUAL]
This value returns a list of nodes.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
1
This is an internal status condition. There is no corresponding status message in the message database.
258
This is an internal status condition. There is no corresponding status message in the message database.
259
This is an internal status condition. There is no corresponding status message in the message database.
14000004
LpSublistType: I am being invoked with a NULL list
48000001
*%A% * is not a valid target list!
48000004
No Node found!
Remarks:
Space is internally allocated for the output value return_list. It is the responsibility of the calling function to free the allocated string storage space.
This function can display an information popup form with the following messages:
48000004
No Node found!
This function can display a warning popup form with the following messages:
1
Not owner
14000004
LpSublistType: I am being invoked with a NULL list
48000001
*%A% * is not a valid target list!
This function makes use of following documented functions:
db_count_nodes()
fem_u_count_id_list()
list_create_target_list()
sys_allocate_array()
Example:
Please see list_create_node_ass_elem (p. 326) in the PCL Reference Manual Examples.
 
list_create_node_ass_geo
(geometry_list, target, return_list)
 
Description:
This function will create a list of all nodes associated with a list of geometry IDs.
Input:
STRING
geometry_list[]
This value specifies a list of geometry IDs.
STRING
target[6]
This value specifies which global string will be used for the storage of the results. This argument can have the following values: ”lista”, or “listb”.
Output:
STRING
return_list[VIRTUAL]
This value returns a list of nodes.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000003
LpSublistType: No sublist filter bits are set on invocation
14000004
LpSublistType: I am being invoked with a NULL list
14000005
LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006
LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007
LpSublistType: In the list being used, the current finite element sublist is unclassifiable.
14000008
LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009
LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010
LpSublistType: In the list being used, the current sublist does not match the sublist filter.
14000014
LpSublistNext: Attempt to proceed past last sublist in current list.
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000281
LpExpandPclVariables: Virtual memory is full.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
48000004
No Node found!
Remarks:
Space is internally allocated for the output value return_list. It is the responsibility of the calling function to free the allocated string storage space.
This function can display an information popup form with the following messages:
48000004
No Node found!
This function can display a warning popup form with the following messages:
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000003
LpSublistType: No sublist filter bits are set on invocation
14000004
LpSublistType: I am being invoked with a NULL list
14000005
LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006
LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007
LpSublistType: In the list being used, the current finite element sublist is unclassifiable.
14000008
LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009
LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010
LpSublistType: In the list being used, the current sublist does not match the sublist filter.
14000014
LpSublistNext: Attempt to proceed past last sublist in current list.
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000281
LpExpandPclVariables: Virtual memory is full.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
This function makes use of following documented functions:
list_create_target_list()
sys_allocate_array()
Example:
Please see list_create_node_ass_geo (p. 328) in the PCL Reference Manual Examples.
 
list_create_node_ass_group
(group_list, number_of_groups, target, return_list)
Description:
This function will create a list of all nodes associated with a list of groups.
Input:
 
 
STRING
group_list[](number_of_groups)
This value specifies a list of groups of geometric entities.
INTEGER
number_of_groups
This value specifies the number of groups in the group_list input value.
STRING
target[6]
This value specifies which global string will be used for the storage of the results. This argument can have the following values: “lista”, or “listb”.
Output:
STRING
return_list[VIRTUAL]
This value returns a list of nodes.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
8104003
Out of room in destination format string.
8107002
Last command aborted.
11000050
The group name is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000105
The specified group was not found in the database.
11000121
There is not a current group defined.
11000127
The group does not have any entities in it.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
13000008
Group not found
13000014
Viewport not found
14000001
LpGetHeapSpace: Allocated heap space is exhausted
48000004
No Node found!
48000010
No Group selected!
Remarks:
Space is internally allocated for the output value return_list. It is the responsibility of the calling function to free the allocated string storage space.
This function can display an information popup form with the following messages:
48000004
No Node found!
This function can display a warning popup form with the following messages:
8104003
Out of room in destination format string.
8107002
Last command aborted.
11000050
The group name is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000105
The specified group was not found in the database.
11000121
There is not a current group defined.
11000127
The group does not have any entities in it.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
13000008
Group not found
13000014
Viewport not found
14000001
LpGetHeapSpace: Allocated heap space is exhausted
48000010
No Group selected!
This function makes use of following documented functions:
list_create_target_list()
Example:
Please see list_create_node_ass_group (p. 329) in the PCL Reference Manual Examples.
 
list_create_node_att_fringe
(fringe_limits, fringe_comparison_type, tolerance, group_name, target, return_list)
 
Description:
This function will create a list of all nodes with a specified fringe value associated with a single group of geometric entities.
Input:
REAL
fringe_limits(2)
This value specifies the lower fringe limit as the value in offset 1 and the upper fringe limit as the value in offset 2.
STRING
fringe_comparison_type[7]
This value specifies the method that will be used for comparing the fringe limits to the fringe value of the element shape.
REAL
tolerance
This value specifies a range over which a match between the input value fringe_limits and the fringe value for the finite element model shape can be made.
STRING
group_name[]
This value specifies the name of a group of geometric entities.
STRING
target[6]
This value specifies which global string will be used for the storage of the results. This argument can have the following values: “lista”, or “listb”.
Output:
STRING
return_list[VIRTUAL]
This value returns a list of nodes.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
13000008
Group not found
13000021
Element not found
15500001
Message 15500001 not found in message file(s)
15500002
Message 15500002 not found in message file(s)
15500003
Message 15500003 not found in message file(s)
48000001
*%A% * is not a valid target list!
48000004
No Node found!
48000010
No Group selected!
48000014
*%A% * is not a valid Value option!
Remarks:
The input value fringe_comparison_type can have the following values:
 
Operation Name
Operation Action
“equal”
Is the fringe value within the input value tolerance of the input value fringe_limits(1)?
“minimum”
Is the fringe value less than the input value fringe_limits(1) plus the input value tolerance?
“maximum”
Is the fringe value greater than the input value fringe_limits(1) plus the input value tolerance?
“range”
Does the fringe value fall in the range defined by the input value fringe_limits(1) as the lower limit and input value fringe_limits(2) as the upper limit plus or minus the input value tolerance?
Space is internally allocated for the output value return_list. It is the responsibility of the calling function to free the allocated string storage space.
This function can display an information popup form with the following message:
 
48000004
No Node found!
This function can display a warning popup form with the following messages:
 
13000008
Group not found
13000021
Element not found
15500001
Message 15500001 not found in message file(s)
15500002
Message 15500002 not found in message file(s)
15500003
Message 15500003 not found in message file(s)
48000001
*%A% * is not a valid target list!
48000010
No Group selected!
 
This function makes use of following documented functions:
db_count_elems_in_group()
db_get_group_id()
list_create_target_list()
Example:
Please see list_create_node_att_fringe (p. 331) in the PCL Reference Manual Examples.
  
list_create_node_att_value
(coord_values, coord_values_active, coord_comparison_type, tolerance, coord_name, target, return_list)
 
Description:
This function will get all nodes with a specified coordinate value.
Input:
REAL
coord_values(6)
This value specifies a list of sets of fringe limits as follows: the lower fringe limits and the upper fringe limits for set 1 are at offsets 1 and 4, the lower fringe limits and the upper fringe limits for set 2 are at offsets 2 and 5, the lower fringe limits and the upper fringe limits for set 3 are at offsets 3 and 6.
LOGICAL
coord_values_active(3)
This value specifies which sets of fringe values are used for the fringe comparison by setting offset 1 TRUE for the first set, offset 2 TRUE for the second set, and offset 3 TRUE for the third set.
STRING
coord_comparison_type{}
This value specifies the method that will be used for comparing the fringe limits to the fringe value of the element shape.
REAL
tolerance(2)
This value specifies a range over which a match between the input value fringe_limits and the fringe value for the finite element model shape can be made.
The first array offset is used to set the distance value for the x, y, and z axis for rectangular coordinate systems. The second array offset is used to set the r and z axis distances for cylindrical coordinate systems. The third array offset is used to set the theta angle for cylindrical coordinate systems.
STRING
coord_name{}
This value specifies the name of a group of geometric entities.
STRING
target[]
This value specifies which global string will be used for the storage of the results. This argument can have the following values: “lista”, or “listb”.
Output:
STRING
return_list[VIRTUAL]
This value returns a list of nodes.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Example:
Please see list_create_node_att_value (p. 333) in the PCL Reference Manual Examples.
 
list_create_point_ass_geo
(entity_list, target, return_list)
 
Description:
Get all points associated to geometry.
Input:
STRING
entity_list[]
This value specifies a list of geometric entities.
STRING
target[6]
This value specifies which global string will be used for the storage of the results. This argument can have the following values: “lista”, or “listb”.
Output:
STRING
return_list[VIRTUAL]
This value returns a list of points.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000003
LpSublistType: No sublist filter bits are set on invocation
14000004
LpSublistType: I am being invoked with a NULL list
14000005
LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006
LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007
LpSublistType: In the list being used, the current finite element sublist is unclassifiable.
14000008
LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009
LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010
LpSublistType: In the list being used, the current sublist does not match the sublist filter.
14000014
LpSublistNext: Attempt to proceed past last sublist in current list.
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000281
LpExpandPclVariables: Virtual memory is full.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
48000001
*%A% * is not a valid target list!
48000005
No Point found!
 
Remarks:
Space is internally allocated for the output value return_list. It is the responsibility of the calling function to free the allocated string storage space.
This function can display an information popup form with the following messages:
48000005
No Point found!
This function can display a warning popup form with the following messages:
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000003
LpSublistType: No sublist filter bits are set on invocation
14000004
LpSublistType: I am being invoked with a NULL list
14000005
LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006
LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007
LpSublistType: In the list being used, the current finite element sublist is unclassifiable.
14000008
LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009
LpSublistType: In the list being used, the current sublist does not match the sublist filter.
14000014
LpSublistNext: Attempt to proceed past last sublist in current list.
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000281
LpExpandPclVariables: Virtual memory is full.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
48000001
*%A% * is not a valid target list!
This function makes use of following documented functions:
app_get_handle()
list_create_target_list()
Example:
Please see list_create_point_ass_geo (p. 334) in the PCL Reference Manual Examples.
 
list_create_point_ass_group
(group_list, number_of_groups, target, return_list)
 
Description:
This function will create a list of all points in a list of groups of geometric entities.
Input:
STRING
group_list[](number_of_groups)
This value specifies a list of groups of geometric entities.
INTEGER
number_of_groups
This value specifies the number of groups in the group_list input value.
STRING
target[6]
This value specifies which global string will be used for the storage of the results. This argument can have the following values: “lista”, or “listb”.
Output:
STRING
return_list[VIRTUAL]
This value returns a list of points.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
8104003
Out of room in destination format string.
8107002
Last command aborted.
11000050
The group name is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000105
The specified group was not found in the database.
11000121
There is not a current group defined.
11000127
The group does not have any entities in it.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
13000008
Group not found
13000014
Viewport not found
48000001
*%A% * is not a valid target list!
48000005
No Point found!
48000010
No Group selected!
Remarks:
Space is internally allocated for the output value return_list. It is the responsibility of the calling function to free the allocated string storage space.
This function can display an information popup form with the following messages:
 
48000005
No Point found!
This function can display a warning popup form with the following messages:
8104003
Out of room in destination format string.
8107002
Last command aborted.
11000050
The group name is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000105
The specified group was not found in the database.
11000121
There is not a current group defined.
11000127
The group does not have any entities in it.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
13000008
Group not found
13000014
Viewport not found
48000001
*%A% * is not a valid target list!
48000010
No Group selected!
 
This function makes use of following documented functions:
list_create_target_list()
Example:
Please see list_create_point_ass_group (p. 336) in the PCL Reference Manual Examples.
 
list_create_surface_ass_geo
(entity_list, target, return_list)
 
Description:
This function will create a list of all surfaces in a list of geometric entities.
Input:
STRING
entity_list[]
This value specifies a list of geometry IDs for surfaces.
STRING
target[6]
This value specifies which global string will be used for the storage of the results. This argument can have the following values: “lista”, or “listb”.
Output:
STRING
return_list[VIRTUAL]
This value returns a list of points.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
7000132
Unable to allocate enough memory for data.
14000001
LpGetHeapSpace: Allocated heap space is exhausted.
14000003
LpSublistType: No sublist filter bits are set on invocation.
14000004
LpSublistType: I am being invoked with a NULL list.
14000005
LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006
LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007
LpSublistType: In the list being used, the current finite element sublist is unclassifiable.
14000008
LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009
LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010
LpSublistType: In the list being used, the current sublist does not match the sublist filter.
14000014
LpSublistNext: Attempt to proceed past last sublist in current list.
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000281
LpExpandPclVariables: Virtual memory is full.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
48000001
*%A% * is not a valid target list!
48000007
No Surface found!
Remarks:
This function will modify the contents of the global string variable specified as the target input value.
Space is internally allocated for the output value return_list. It is the responsibility of the calling function to free the allocated string storage space.
This function is used in the implementation of the form that can be accessed through “Tools”, “List”, “Create” on the Patran menu bar.
This function can display a warning popup form with the following messages:
 
7000132
Unable to allocate enough memory for data.
14000001
LpGetHeapSpace: Allocated heap space is exhausted.
14000003
LpSublistType: No sublist filter bits are set on invocation.
14000004
LpSublistType: I am being invoked with a NULL list.
14000005
LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006
LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007
LpSublistType: In the list being used, the current finite element sublist is unclassifiable.
14000008
LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009
LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010
LpSublistType: In the list being used, the current sublist does not match the sublist filter.
14000014
LpSublistNext: Attempt to proceed past last sublist in current list.
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000281
LpExpandPclVariables: Virtual memory is full.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
48000007
No Surface found!
 
This function makes use of following documented functions:
list_create_target_list()
Example:
Please see list_create_surface_ass_geo (p. 337) in the PCL Reference Manual Examples.
 
list_create_surface_ass_group
(group_list, number_of_groups, target, return_list)
Description:
This function will create a list of all surfaces in a list of groups of geometric entities.
Input:
STRING
group_list[](number_of_groups)
This value specifies a list of groups of geometric entities.
INTEGER
number_of_groups
This value specifies the number of groups in the group_list input value.
STRING
target[6]
This value specifies which global string will be used for the storage of the results. This argument can have the following values: “lista”, or “listb”.
Output:
STRING
return_list[VIRTUAL]
This value returns a list of surfaces.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
8104003
Out of room in destination format string.
8107002
Last command aborted.
11000050
The group name is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000105
The specified group was not found in the database.
11000121
There is not a current group defined.
11000127
The group does not have any entities in it.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
13000008
Group not found
13000014
Viewport not found
48000001
*%A% * is not a valid target list!
48000007
No Surface found!
48000010
No Group selected!
Remarks:
This function is used in the implementation of the form that can be accessed through “Tools”, “List”, “Create” on the Patran menu bar.
Space is internally allocated for the output value return_list. It is the responsibility of the calling function to free the allocated string storage space.
This function can display an information popup form with the following messages:
 
48000007
No Surface found!
This function can display a warning popup form with the following messages:
 
8104003
Out of room in destination format string.
8107002
Last command aborted.
11000050
The group name is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000105
The specified group was not found in the database.
11000121
There is not a current group defined.
11000127
The group does not have any entities in it.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
13000008
Group not found
13000014
Viewport not found
This function makes use of following documented functions:
list_create_target_list()
Example:
Please see list_create_surface_ass_group (p. 339) in the PCL Reference Manual Examples.
 
list_create_target_list
(target, entity_list)
Description:
This function allocates space for a string, sets the value of the allocated string using an input value, and assigns the allocated string to one of two global string variables named lista or listb based on the settings of two matching internal global variables named lista_nomerge and listb_nomerge.
Input:
STRING
target[]
This value specifies which global string will be used for the storage of the results. This argument can have the following values: “lista”, or “listb”.
STRING
entity_list[]
This value specifies a list of entities to be stored.
Output:
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
48000001
*%A% * is not a valid target list!
Remarks:
The input value target can have the following values: “lista”, or “listb”.
The behavior of this function is influenced by the settings in the following global variables:
LOGICAL lista_nomerge
LOGICAL listb_nomerge
This function can modify the following global variables:
STRING list_a[VIRTUAL]
STRING list_b[VIRTUAL]
STRING lista_reset[VIRTUAL]
STRING listb_reset[VIRTUAL]
If the input value target is set to “lista” or “listb” and the matching lista_nomerge or listb_nomerge global value is set to TRUE, the string passed in the input return_list will be placed at the start of the string stored in the lista or listb value specified by target. If the matching lista_nomerge or listb_nomerge global values are set to FALSE, the PCL function list_create_boolean_list() is used to create a sorted list that is placed at the start of the string stored in the lista or listb value specified by target.
This function saves the old value for lista in the global string lista_reset and the old value for listb in listb_reset.
By default the lista_nomerge and listb_nomerge global variables are set to FALSE.
This function will display a warning popup form with the following message if the target input value is out of range:
48000001
*%A% * is not a valid target list!
Example:
Please see list_create_target_list (p. 340) in the PCL Reference Manual Examples.
list_filter_by_elem_dim
(input_list, criterion, segment_count, minimum, maximum, return_list)
Description:
This function will create a list processor string of entities for elements which have dimensions within a specified range.
Input:
STRING
input_list[]
This value specifies the list processor string of entities that will be filtered by this function.
STRING
criterion[13]
This value specifies the element attribute criterion for evaluation. See the remarks below for more information.
INTEGER
segment_count
This value specifies the number of segments desired for length evaluation on an element edge. Isoparametric shape functions are used for the evaluation of intermediate locations. If this value is 0, then consider segments formed by the straight lines between the nodes along the edge.
REAL
minimum
This value specifies the minimum value for the range of the specified criterion.
REAL
maximuim
This value specifies the maximum value for the range of the specified criterion.
Output:
STRING
return_list[VIRTUAL]
This value returns a list processor string of entities that fit the range and attribute criteria specified in the input values.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate an error.
Error Conditions:
-1
This is an internal error status condition. There is no corresponding status message in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need to release the memory of the output variable.
The input value criterion uses the following values to specify the element attributes for evaluation:
 
Value
Description
 
 
EdgeLengthMin
The minimum edge length of an element.
EdgeLengthMax
The maximum edge length of an element.
EdgeLengthAvg
The average edge length of an element.
EdgeLengthOne
Use at least one edge of an element.
EdgeLengthall
Use all of the element edges.
LengthElem1D
Use the length of all single dimensional elements.
AreaElem2D
Use the area of all two dimensional elements.
VolumeElem3D
Use the volume of all three dimensional elements.
Example:
Please see list_filter_by_elem_dim (p. 342) in the PCL Reference Manual Examples.
list_filter_by_ent_shape
(input_list, geometric_points, geometric_curves, geometric_surfaces, geometric_solids, element_points, element_beams, element_tria, element_quad, element_tet, element_wedge, element_hex, node, mpc, any_other, return_list)
Description:
This function will create a list processor string of entities match the specified entity types.
Input:
STRING
input_list[]
This value specifies the list processor string of entities that will be filtered by this function. See the remarks below for more information.
INTEGER
geometric_points
This value specifies, when set to FALSE, that all zero dimensional geometric or point entities be ignored.
INTEGER
geometric_curves
This value specifies, when set to FALSE, that all single dimensional geometric or curve entities be ignored.
INTEGER
geometric_surfaces
This value specifies, when set to FALSE, that all two dimensional geometric or surface entities be ignored.
INTEGER
geometric_solids
This value specifies, when set to FALSE, that all three dimensional geometric or solid entities be ignored.
INTEGER
element_points
This value specifies, when set to FALSE, that all zero dimensional or point elements be ignored.
INTEGER
element_beams
This value specifies, when set to FALSE, that all single dimensional or beam elements be ignored.
INTEGER
element_tria
This value specifies, when set to FALSE, that all two dimensional triangular elements be ignored.
INTEGER
element_quad
This value specifies, when set to FALSE, that all two dimensional quadrilateral elements be ignored.
INTEGER
element_tet
This value specifies, when set to FALSE, that all three dimensional tetrahedral elements be ignored.
INTEGER
element_wedge
This value specifies, when set to FALSE, that all three dimensional wedge elements be ignored.
INTEGER
element_hex
This value specifies, when set to FALSE, that all three dimensional hexagonal elements be ignored.
INTEGER
node
This value specifies, when set to FALSE, that all nodes be ignored.
INTEGER
mpc
This value specifies, when set to FALSE, that all mass property constraints be ignored.
INTEGER
any_other
This value specifies, when set to FALSE, that all entities of a type that is not listed above be ignored.
Output:
STRING
return_list[ VIRTUAL]
This value returns a list processor string of entities that match the specified types.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate an error.
Error Conditions:
-1
This is an internal error status condition. There is no corresponding status message in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need to release the memory of the output variable.
An example of a list processor string used as an input for this function might look like this:
“Surface 1.3 Element 1 2.4”
Note that only the last level of the sub-entities are considered by this function: in “Surface 1.3” we are considering the hypothetical curve defined by the 3rd edge of surface 1. In “Element 2.4” we consider the hypothetical element defined by face 1 of element 3.
Example:
Please see list_filter_by_ent_shape (p. 343) in the PCL Reference Manual Examples.
list_filter_by_ep_type
(input_list, ep_type_count, ep_type_name, return_list)
Description:
This function will create a list processor string of entities that match the specified element property types.
Input:
STRING
input_list[]
This value specifies the list processor string of entities that will be filtered by this function.
INTEGER
ep_type_count
This value specifies the number of generic element types.
STRING
ep_type_name[31](type_count)
This array specifies the generic element type names. See the remarks below for more information.
Output:
STRING
return_list[VIRTUAL]
This value returns a list processor string of entities that match the specified types.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate an error.
Error Conditions:
-1
This is an internal error status condition. There is no corresponding status message in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need to release the memory of the output variable.
 
The input value ep_type_name can have the following values:
Mass
Axisym Shell
Rotary Inertia
1D Preference
Grounded Spring
Planar Beam
Grounded Damper
3D Beam
IRS ( single node )
ISL ( in plane )
3D Mass
ISL ( in space )
2D Mass
Slide Line
Beam
IRS ( planar/axisym )
Beam in XY Plane
IRS ( beam/pipe )
Beam in Space
RigidSurf ( Seg )
2D Spar
RigidSurf ( Cyl )
3D Spar
RigidSurf ( Axi )
Elastic Beam
RigidSurf ( Bz2D )
Thin-Walled Beam
Shell
Rod
Thin Shell
Link
Thick Shell
Truss
Plate
Spring
Bending Panel
Damper
2D Solid
Spring/Damper
Membrane
Gap
Shear Panel
2D Gap
Twist Panel
3D Gap
Rigid Surface
Cable
2D Preference
Planar Rigid Surf
IRS ( shell/solid )
Combination
RigidSurf ( Bz3D )
Surface Effect
Solid
1D Mass
3D Preference
Axisymmetric Link
 
Example:
Please see list_filter_by_ep_type (p. 345) in the PCL Reference Manual Examples.
 
list_filter_by_ep_value
(input_list, element_property, component, minimum, maximum, return_list)
Description:
This function will create a list processor string of entities that match the specified element property word value range.
Input:
STRING
input_list[]
This value specifies the list processor string of entities that will be filtered by this function.
STRING
element_property[]
This value specifies the element property word string. See the remarks below for more information.
INTEGER
component
This value specifies the component of data to extract. This value ranges from 1 to 3 and is ignored if the entities in the input value input_list are scalar values.
REAL
minimum
This value specifies the minimum value for the range of the specified criterion.
REAL
maximum
This value specifies the maximum value for the range of the specified criterion.
Output:
STRING
return_list[VIRTUAL]
This value returns a list processor string of entities that match the specified types.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate an error.
Error Conditions:
-1
This is an internal error status condition. There is no corresponding status message in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need to release the memory of the output variable.
The input value element_property can have the following word name values:
Value
Word Name
Value
Word Name
 
 
 
 
 
 
 
1
Area
 
2094
Shear Area at J
 
2
Beam Orientation
 
 
Not used
.
.
Not used
 
3
Center of Rotation
 
 
 
4
Closure Direction
 
 
 
5
Damping Coefficient
 
 
 
6
Definition of XY Plane
 
2097
Y Direction Shear Constant
 
7
Dof at Node 1
 
2098
Z Direction Shear Constant
 
8
Dof at Node 2
 
2099
Slide Force Limit
 
9
Emissivity
 
2100
Stability Options
 
10
Inertia 1,1
 
 
Not used
 
11
Inertia 2,2
 
2102
Sticking Options
 
12
Inertia 3,3
 
2103
Sticking Stiffness
 
13
Material Name
 
2104
Spring Constant 1
 
14
Translation Inertia,X
 
2105
Spring constant 2
 
15
Translation Inertia,Y
 
2106
Stifness Direction Options
 
16
Translation Inertia,Z
 
 
Not used
 
17
Ixx
 
2108
Strain Representation Options
 
18
Iyy
 
2109
Temperature Loading Options
 
19
Izz
 
2110
Thermal Capacitance
 
20
Orientation Angle
 
2111
Theta
 
21
Orientation System
 
2113
Thickness at I
 
22
Pipe Thickness
 
2114
Thickness at J
 
23
Rotary Inertia,XX
 
2115
Y Direction Thickness
 
24
Rotary Inertia,YY
 
2116
Z Direction Thickness
 
25
Rotary Inertia,ZZ
 
2117
Y Bottom Thickness at I
 
27
Section Height
 
2118
Y Bottom Thickness at J
 
28
Section Radius (ave)
 
2119
Y Top Thickness at I
 
29
Section Width
 
2120
Y Top Thickness at J
 
30
Shear Area-2
 
2121
Z Bottom Thickness at I
 
31
Shear Area-3
 
2122
Z Bottom Thickness at J
 
32
Shear Area-y
 
2123
Z Top Thickness at I
 
33
Shear Area-z
 
2124
Z Top Thickness at J
 
34
Stefan-Boltzmann Constant
 
2125
Distance Centroid to Top
 
35
Stiffness
 
2126
Distance Centroid to Top at I
 
36
Thickness
 
2127
Distance Centroid to Top at J
 
 
Not used
.
.
Not used
 
2128
Torsional Shear Factor at I
 
 
 
2129
Torsional Shear Factor at J
 
 
 
2130
Ultimate Shear Stress
 
 
 
2131
Unloading Path Options
 
1002
Degree-of-freedom
 
 
Not used
.
.
Not used
 
1003
Element Set Name
 
 
 
1004
Shear Factor
 
 
 
1005
Reference Temperature
 
 
 
1006
X-Sectional area
 
3001
Absolute Temp Conversion
 
 
Not used
.
.
Not used
 
3002
Angular Vel at Center of Rot
 
 
 
3003
Branch Length
 
 
 
3004
Closure Distance
 
 
 
3005
Direction of Rotation Axis
 
1010
Mass Magnitude
 
3006
dx/ds where Branches Begin
 
1011
Mass Damping Factor
 
3007
dx/ds where Branches End
 
1012
Crit Damping Factor
 
3008
dy/ds where Branches Begin
 
1013
Force/Displcmnt Tble
 
3009
dy/ds where Branches End
 
1014
Force/Velocity Table
 
3010
Element Length
 
1015
Channel Thickness
 
3011
Film Coefficient
 
1016
Initial Clearence
 
3012
Friction Coefficient
 
1017
Stiffness in Stick
 
3013
Initially Open or Closed
 
1018
Equiv Shear Strs Lim
 
3014
Initial Stress
 
1019
Friction in Dir_1
 
3015
K Normal (closed)
 
1020
Friction in Dir_2
 
3016
K Tangent (closed)
 
1021
Area Moment I1
 
3017
Limiting Distance
 
1022
Area Moment I2
 
3018
Min or Max Limit Type
 
1023
Area Moment I11
 
3019
Number Divisions ea Branch
 
1024
Area Moment I22
 
3020
Thicknesses where Branches Begin
 
1025
Area Moment I12
 
3021
Thicknesses where Branches End
 
1026
Torsional Constant
 
3022
Tied Shell Thickness
 
1027
Outside Radius
 
3023
Activation Time
 
 
Not used
.
.
Not used
 
3024
Deactivation Time
 
 
 
3025
Vel at Center of Rotation
 
 
 
3026
X Coords where Branches Begin
 
 
 
3027
X Coords where Branches End
 
1031
Thickness_RHS
 
3028
Y Coords where Branches Begin
 
1032
Thickness_TOP
 
3029
Y Coords where Branches End
 
1033
Thickness_LHS
 
 
Not used
.
.
Not used
 
1034
Thickness_BOT
 
 
 
 
Not used
 
 
 
1036
Centroidal Height
 
 
 
 
Not used
 
4001
Mass Orientation
 
1038
Bottom Web Width
 
4002
Mass Component 1,1
 
1039
Top Web Width
 
4003
Mass Component 2,1
 
1040
Bottom Web Thickness
 
4004
Mass Component 2,2
 
1041
Top Web Thickness
 
4005
Mass Component 3,1
 
1042
Middle Web Thickness
 
4006
Mass Component 3,2
 
1043
Circumscrbing Radius
 
4007
Mass Component 3,3
 
 
Note used
 
4008
Mass Component 4,1
 
1045
Wall Thickness
 
4009
Mass Component 4,2
 
1046
Torus Radius
 
4010
Mass Component 4,3
 
1047
Bottom Width
 
4011
Mass Component 4,4
 
1048
Top Width
 
4012
Mass Component 5,1
 
1049
Horizontal Width
 
4013
Mass Component 5,2
 
1050
Vertical Height
 
4014
Mass Component 5,3
 
1051
Horizontal Thickness
 
4015
Mass Component 5,4
 
1052
Vertical Thickness
 
4016
Mass Component 5,5
 
 
Not used
 
4017
Mass Component 6,1
 
1054
Surfce Contct Softnd
 
4018
Mass Component 6,2
 
1055
Clearence Zero-Press
 
4019
Mass Component 6,3
 
1056
Contact Pressure
 
4020
Mass Component 6,4
 
1057
Maximum Overclosure
 
4021
Mass Component 6,5
 
1058
Maximum -ve Pressure
 
4022
Mass Component 6,6
 
1059
Gap Conductance Tble
 
4023
Spring Constant
 
1060
Rad Constant Fa
 
4024
Mass Offset
 
1061
Rad Constant Fb
 
4026
Inertia 2,1
 
1062
Absolute Zero Temp
 
4028
Inertia 3,1
 
1063
Hourglss Stiff Param
 
4029
Inertia 3,2
 
1064
Shear Stiffness K13
 
4032
Stress Coefficient
 
1065
Shear Stiffness K23
 
4033
Ext. Viscous Coeff.
 
1066
Ave Shear Stiffness
 
4034
Rot. Viscous Coeff.
 
1067
Membrne Hourglss Stif
 
4036
Tors. Stress Coeff.
 
1068
Normal Hourglss Stiff
 
4037
Nonstructural Mass
 
1069
Bending Hourglss Stiff
 
4039
Outer Diam. @ Node 2
 
1070
Density, mass/area
 
 
Not used
.
.
Not used
 
1071
# Integration Points
 
 
 
1072
Poisson Parameter
 
 
 
1073
Point Tangents Intersection
 
 
 
1074
Integ Points thru Thickness
 
4042
Offset @ Node 1
 
1075
Integ Points around Pipe
 
4043
Offset @ Node 2
 
1076
# Ovalization Modes
 
4044
Shear Stiff. Y
 
1077
Section Points
 
4045
Shear Stiff. Z
 
1079
Orientation Axis
 
4046
Shear Stiff. R
 
1080
Shell Thickness
 
4047
Y of Point C
 
1081
Membrane Thickness
 
4048
Z of Point C
 
 
Not used
.
.
Not used
 
4049
R of Point C
 
 
 
4050
Y of Point D
 
 
 
4051
Z of Point D
 
 
 
4052
R of Point D
 
2015
Distance Centroid to Bottom at I
 
4053
Y of Point E
 
2016
Distance Centroid to Bottom at J
 
4054
Z of Point E
 
2017
Cable or Gap Option
 
4055
R of Point E
 
2018
Cable Stiffness Options
 
4056
Y of Point F
 
2019
Convection Function Constant
 
4057
Z of Point F
 
2020
Compression Options
 
4058
R of Point F
 
2021
Heat Gen. Rate Const1
 
4059
Ys of C Points
 
2022
Heat Gen. Rate Const2
 
4060
Zs of C Points
 
2023
Heat Gen. Rate Const3
 
4061
Station Distances
 
2024
Heat Gen. Rate Const4
 
4062
Ys of D Points
 
2025
Heat Gen. Rate Const5
 
4063
Zs of D Points
 
2026
Heat Gen. Rate Const6
 
4064
Warp DOF @ Node 1
 
2027
Convergence Tolerance
 
4065
Ys of E Points
 
2028
Damping Coefficient 1
 
4066
Zs of E Points
 
2029
Damping Coefficient 2
 
4067
Warp DOF @ Node 2
 
2030
Deflection
 
4068
Ys of F Points
 
2031
Delta Temperature
 
4069
Zs of F Points
 
2032
Degree(s) of Freedom
 
4070
Cross Sect. Areas
 
2033
Shear Center Offset Y at I
 
4071
Initial Opening
 
2034
Shear Center Offset Y at J
 
4072
Preload
 
2035
Shear Center Offset Z at I
 
4073
Opened Stiffness
 
2036
Shear Center Offset Z at J
 
4074
Closed Stiffness
 
2037
Application Type
 
4075
Sliding Stiffness
 
 
Not used
.
.
Not used
 
4076
Friction Coeff. Y
 
 
 
4077
Friction Coeff. Z
 
 
 
4078
Inertias 1,1
 
 
 
4079
Inertias 1,2
 
2042
Y Elastic Foundation Stiffness
 
4080
Inertias 2,2
 
2043
Z Elastic Foundation Stiffness
 
4081
Torsional Constants
 
2044
Elastic Foundation Stiffness
 
4082
Nonstructural Masses
 
2046
Empirical Convection Term Expone
 
4083
Shear Relief Y
 
2047
End I Releases
 
4084
Shear Relief Z
 
2048
End J Releases
 
4085
NSM Inertia @ Node 1
 
2049
Extra Shapes Option
 
4086
NSM Inertia @ Node 2
 
2050
Force
 
4087
Warp Coeff. @ Node 1
 
2051
Geometric Form Factor
 
4088
Warp Coeff. @ Node 2
 
2052
Gap Size
 
4089
Y of NSM @ Node 1
 
2053
Gap Size Opion
 
4090
Z of NSM @ Node 1
 
2054
Heat Rate
 
4091
Y of NSM @ Node 2
 
2055
Height
 
4092
Z of NSM @ Node 2
 
2056
Initial Displacement
 
4093
Y of NSM
 
2057
Initial Status
 
4094
Z of NSM
 
2058
Initial Strain
 
4095
Y of NA @ Node 1
 
2059
Layer Input Format
 
4096
Z of NA @ Node 1
 
2060
Torsional Moment of Inertia at I
 
4097
Y of NA @ Node 2
 
2061
Torsional Moment of Inertia at J
 
4098
Z of NA @ Node 2
 
2062
Y Moment of Inertia at I
 
4099
Y of Neut. Axis
 
2063
Y Moment of Inertia at J
 
4100
Z of Neut. Axis
 
2064
Z Moment of Inertia at I
 
4101
Center of Curvature
 
2065
Z Moment of Inertia at J
 
4102
Radial NA Offset
 
2066
Large Deflection Coordinate Opti
 
4103
Mean Pipe Radius
 
2067
Segment Point Y Location(s)
 
4104
Internal Pipe Press.
 
2068
Segment Point Z Location(s)
 
4105
Stress Intensific.
 
2069
Mass
 
4106
Symmetry Option
 
2070
Mass Distribution
 
4107
Ys of Lumped Areas
 
2071
Mass Matrix Options
 
4108
Zs of Lumped Areas
 
 
Not used
.
.
Not used
 
4109
Area Factors
 
 
 
 
Not used
 
 
 
4111
Plate Offset
 
 
 
4112
Membrane Material
 
2076
Bending Moment Of Inertia Ratio
 
4113
Bending Material
 
 
Not used
.
.
Not used
 
4114
Shear Material
 
 
 
4115
Coupling Material
 
 
 
4116
Bending Stiffness
 
 
 
4117
Thickness Ratio
 
2080
Node Location Options
 
4118
Fiber Dist. 1
 
2081
X Nodal Offset at I
 
4119
Fiber Dist. 2
 
2082
X Nodal Offset at J
 
 
Not used
 
2083
Normal Stiffness
 
4121
Extensional Stiff. 12
 
2084
Outer Diameter
 
4122
Extensional Stiff. 14
 
2085
Pressure Direction Options
 
 
Not used
 
2086
Pressure Loading Options
 
4124
Integration Network
 
2087
Pressure Sign Options
 
4125
Output Locations
 
2088
Radiation Equation Types
 
4126
Integration Scheme
 
2089
Radius
 
4127
Gap Orientation
 
 
Not used
.
.
Not used
 
4128
Axial Bar Offset
 
 
 
4129
Radial Bar Offset
 
 
 
 
 
 
 
 
 
 
 
2093
Shear Area at I
 
 
 
Example:
Please see list_filter_by_ep_value (p. 347) in the PCL Reference Manual Examples.
list_filter_by_fem_type
(input_list, fem_type_count, fem_type_name, return_list)
Description:
This function will create a list processor string of entities that match the specified FEM type.
Input:
STRING
input_list[]
This value specifies the list processor string of entities that will be filtered by this function.
INTEGER
fem_type_count
This value specifies the number of finite element type names.
STRING
fem_type_name[31](fem_type_count)
This array specifies the finite element types. See the remarks below for more information.
Output:
STRING
return_list[VIRTUAL]
This value returns a list processor string of entities.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate an error.
Error Conditions:
-1
This is an internal error status condition. There is no corresponding status message in the message database.
Remarks:
The input value fem_type_name can accept the following FEM type values:
Node
Elm
ElmPoint
ElmBar
ElmBar2
ElmBar3
ElmBar4
ElmTri
ElmTri3
ElmTri4
ElmTri6
ElmTri7
ElmTri9
ElmTri13
ElmQuad
ElmQuad4
ElmQuad5
ElmQuad8
ElmQuad9
ElmQuad12
ElmQuad16
ElmTet
ElmTet4
ElmTet5
ElmTet10
ElmTet11
ElmTet14
ElmTet15
ElmTet16
ElmTet40
ElmWed
ElmWed6
ElmWed7
ElmWed15
ElmWed16
ElmWed20
ElmWed21
ElmWed24
ElmWed52
ElmHex
ElmHex8
ElmHex9
ElmHex20
ElmHex21
ElmHex26
ElmHex27
ElmHex32
ElmHex64
MPC
MPC/Explicit
MPC/Rigid
MPC/RBAR
MPC/RBE1
MPC/RBE2
MPC/RBE3
MPC/RROD
MPC/RSPLINE
MPC/RTRPLT
MPC/CyclicSymmetry
MPC/Sliding Surface
 
 
Specific MPC types can be selected for other preferences by using the same names as those listed in the preference form and adding “MPC/” as a prefix to the name while being careful to include and spaces in the original name.
Memory is allocated for the return list output variable within this function. If memory was allocated prior to the call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need to release the memory of the output variable.
Example:
Please see list_filter_by_fem_type (p. 349) in the PCL Reference Manual Examples.
list_filter_by_lbc_type
(input_list, lbc_type_count, lbc_type_name, return_list)
Description:
This function will create a list processor string of entities that match the specified load and boundary condition type.
Input:
STRING
input_list[]
This value specifies the list processor string of entities that will be filtered by this function.
INTEGER
lbc_type_count
This value specifies the number of load and boundary condition type names.
STRING
lbc_type_name[31](lbc_type_count)
This array specifies the load and boundary condition type names. See the remarks below for more information.
Output:
STRING
return_list[VIRTUAL]
This value returns a list processor string of entities.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate an error.
Error Conditions:
-1
This is an internal error status condition. There is no corresponding status message in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need to release the memory of the output variable.
The input value lbc_type_name can accept a variety of values that are dependent on the type of preference currently loaded. Examples of these type names are “Temperature”, and “Pressure”. A complete of the values allowed under the current preference can be seen by selecting “Loads/BCs” on the tool bar of Patran and then setting the “Action” entry on the form to “Create”. The currently allowed lbc_type_name values are displayed when the “Object” list on the form is selected.
Example:
Please see list_filter_by_lbc_type (p. 351) in the PCL Reference Manual Examples.
 
list_filter_by_lbc_value
(input_list, load_case_name, lbc_var_name, component, minimum, maximum, evaluation_time, evaluation_frequency, sub_entity, return_list)
Description:
This function will create a list processor string of entities that match the specified load and boundary condition value range.
Input:
STRING
input_list[]
This value specifies the list processor string of entities that will be filtered by this function. Face and edge sub-entity ids are ignored.
STRING
load_case_name[]
This value specifies the load case name. The default load case is used if this value is set to ““.
STRING
lbc_var_name[]
This value specifies the load and boundary condition variable name. See the remarks below for more information.
INTEGER
component
This value specifies the component of data to extract. This value ranges from 1 to 3 and is ignored if the entities in the input value input_list are scalar values.
REAL
minimum
This value specifies the minimum value for the range of the load and boundary condition value.
REAL
maximum
This value specifies the maximum value for the range of the load and boundary condition value.
REAL
evaluation_time
This value specifies the time value used for field evaluation.
REAL
evaluation_frequency
This value specifies the frequency value used for field evaluation.
STRING
sub_entity[]
This value specifies, when set to “ANY”, that any sub-entity that corresponds to the input value lbc_var_name that has a value in the specified range be listed in the output value return_list. When this value is set to “ALL”, all sub-entities with values in the specified range are included in the output value return_list.
Output:
STRING
return_list[VIRTUAL]
This value returns a list processor string of entities.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate an error.
Error Conditions:
-1
This is an internal error status condition. There is no corresponding status message in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need to release the memory of the output variable.
If a load and boundary condition variable value cannot be evaluated because it is based on a field which cannot be evaluated, the corresponding load and boundary condition is skipped and the entities associated with the load and boundary condition are skipped. A field that is of the general field type is a typical cause of this behavior.
Examples of load and boundary condition variable names would look like the following strings. If the variable name is not found, the function will exit normally.
 ”Bot Surf Pressure”
“Translations <T1 T2 T3>”
“Temperature”
Example:
Please see list_filter_by_lbc_value (p. 353) in the PCL Reference Manual Examples.
list_filter_by_mat_name
(input_list, mat_count, mat_name, return_list)
 
Description:
This function will create a list processor string of entities that are associated to a material name.
Input:
STRING
input_list[]
This value specifies the list processor string of entities that will be filtered by this function.
INTEGER
mat_count
This value specifies the number of material names.
STRING
mat_name[31](mat_count)
This array specifies the material names.
Output:
STRING
return_list[VIRTUAL]
This value returns a list processor string of entities.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate an error.
Error Conditions:
-1
This is an internal error status condition. There is no corresponding status message in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need to release the memory of the output variable.
Example:
Please see list_filter_by_mat_name (p. 355) in the PCL Reference Manual Examples.
list_filter_by_mat_type
(input_list, mat_type_count, mat_type_name, return_list)
Description:
This function will create a list processor string of entities that are associated to a material type.
Input:
STRING
input_list[]
This value specifies the list processor string of entities that will be filtered by this function.
INTEGER
mat_type_count
This value specifies the number of material types.
STRING
mat_type_name[31](mat_type_count)
This array specifies the material type names. See the remarks below for more information.
Output:
STRING
return_list[VIRTUAL]
This value returns a list processor string of entities.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate an error.
Error Conditions:
-1
This is an internal error status condition. There is no corresponding status message in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need to release the memory of the output variable.
The input value mat_type_name can accept a variety of values that are dependent on the type of preference currently loaded. Examples of these type names are “Isotropic”, and “2d Orthotropic”. A complete of the values allowed under the current preference can be seen by selecting “Materials” on the tool bar of Patran and then setting the “Action” entry on the form to “Create”. The currently allowed mat_type_name values are displayed when the “Object” list on the form is selected.
Example:
Please see list_filter_by_mat_type (p. 356) in the PCL Reference Manual Examples.
list_filter_by_mat_value
(input_list, mat_prop_name, minimum, maximum, eval_at_temperature, evaluation_strain, evaluation_rate, evaluation_time, evaluation_frequency, return_list)
Description:
This function will create a list processor string of entities that match the specified material property value range.
Input:
STRING
input_list[]
This value specifies the list processor string of entities that will be filtered by this function.
STRING
mat_prop_name[]
This value specifies the material property word name. See the remarks below for more information.
REAL
minimum
This value specifies the minimum value for the range of the material value.
REAL
maximum
This value specifies the maximum value for the range of the material value.
REAL
evaluation_temperature
This value specifies the temperature value used for field evaluation.
REAL
evaluation_strain
This value specifies the strain, total strain, plastic strain, or stress value used for field evaluation.
REAL
evaluation_rate
This value specifies the strain rate value used for field evaluation.
REAL
evaluation_time
This value specifies the time value used for field evaluation.
REAL
evaluation_frequency
This value specifies the frequency value used for field evaluation.
Output:
STRING
return_list[VIRTUAL]
This value returns a list processor string of entities.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate an error.
Error Conditions:
-1
This is an internal error status condition. There is no corresponding status message in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need to release the memory of the output variable.
If a material property value cannot be evaluated because it is based on a field which cannot be evaluated, the corresponding material property is skipped and the entities associated with the material property are skipped. A field that is of the general field type is a typical cause of this behavior.
The input value mat_prop_name can have the following values:
Value
Name
Value
Name
 
 
 
 
1
Reference Temperature
144
Coefficient D
2
Elastic Modulus
145
Coefficient E
3
Elastic Modulus 22
146
Coefficient F
4
Elastic Modulus 33
147
Coefficient G
5
Poisson Ratio
148
Interaction Term 23
6
Poisson Ratio 23
149
Interaction Term 31
7
Poisson Ratio 31
150
Not used
8
Shear Modulus
.
.
9
Shear Modulus 23
.
.
10
Shear Modulus 31
.
.
11
Not used
502
Not used
12
Not used
503
Stress/Strain Curve
13
Poisson Ratio 13
504
Not used
14
Bulk Modulus
.
.
15
Lame Constant
.
.
16
Density
.
.
17
Conductivity
1000
Not used
18
Conductivity 12
1001
Mass Propornl Damping
19
Conductivity 13
1002
Stiffness Propornl Damping
20
Conductivity 22
1003
Fraction Critical Damping
21
Conductivity 23
1004
Not used
22
Conductivity 33
.
.
23
Specific Heat
.
.
24
Thermal Expansion Coeff
.
.
25
Thermal Expansion Coeff 22
1010
Not used
26
Thermal Expansion Coeff 33
1011
2nd. Yield Stress
27
Thermal Expansion Coeff 12
1012
Plastic Strain
28
Thermal Expansion Coeff 23
1013
Rate Dependent Param D
29
Thermal Expansion Coeff 31
1014
Rate Dependent Param p
30
Structural Damping Coeff
1016
Dilation Angle
31
Emissivity
1017
Ratio of Flow Stresses
32
Not used
1018
Absolute Plastic Strain
.
.
1019
Exponent
.
.
1020
Yield Offset
.
.
1021
Not used
36
Not used
1022
Not used
37
Composite Options Flag
1023
Material Cohesion
38
Positive Definite Flag
1024
Eccentricity Parameter
39
Total Laminate Thickness
1025
Yield Surface Transition
40
Number of Plies
1026
Surface Radius Parameter
41
Laminate Offset
1027
Hydrostatic Yield Stress
42
Moisture Expansion Coeff 11
1028
Volumetric Plastic Strain
43
Moisture Expansion Coeff 22
1029
Not used
44
Moisture Expansion Coeff 33
.
.
45
Moisture Expansion Coeff 12
.
.
46
Moisture Expansion Coeff 23
.
.
47
Moisture Expansion Coeff 31
1100
Not used
48
Force Resultant (N1) per Temp
1101
Real Part of g1
49
Force Resultant (N2) per Temp
1102
Imaginary Part of g1
50
Force Resultant (N12) per Temp
1103
Value of a
51
Moment Resultant (M1) per Temp
1104
Real Part of k1
52
Moment Resultant (M2) per Temp
1105
Imaginary Part of k1
53
Moment Resultant (M12) per Temp
1106
Value of b
54
Stiffness 11
1107
Not used
55
Stiffness 12
.
.
56
Stiffness 13
.
.
57
Stiffness 22
.
.
58
Stiffness 23
1200
Not used
59
Stiffness 33
1201
Value of A
60
Stiffness 44
1202
Value of B
61
Stiffness 45
1203
Value of n
62
Stiffness 46
1204
Value of m
63
Stiffness 55
1205
Value of delta_H
64
Stiffness 56
1206
Value of R
65
Stiffness 66
1207
Not used
66
Stiffness 14
.
.
67
Stiffness 15
.
.
.
Stiffness 16
 
.
68
Not used
1300
Not used
69
Stiffness 24
1301
Coefficient C10
70
Stiffness 25
1302
Coefficient C20
71
Stiffness 26
1303
Coefficient C30
72
Stiffness 34
1304
Coefficient C40
73
Stiffness 35
1305
Coefficient C50
74
Stiffness 36
1306
Coefficient C60
75
Stiffness 11
1307
Not used
76
Stiffness 12
1308
Not used
77
Stiffness 13
1309
Not used
78
Stiffness 22
1310
Not used
79
Stiffness 23
1311
Coefficient C01
80
Stiffness 33
1312
Coefficient C02
81
Membrane Stiffness 11
1313
Coefficient C03
82
Membrane Stiffness 12
1314
Coefficient C04
83
Membrane Stiffness 13
1315
Coefficient C05
84
Membrane Stiffness 22
1316
Coefficient C06
85
Membrane Stiffness 23
1317
Not used
86
Membrane Stiffness 33
1318
Not used
87
Bending Stiffness 11
1319
Not used
88
Bending Stiffness 12
1320
Not used
89
Bending Stiffness 13
1321
Coefficient C11
90
Bending Stiffness 22
1322
Coefficient C21
91
Bending Stiffness 23
1323
Coefficient C12
92
Bending Stiffness 33
1324
Coefficient C31
93
Coupling Stiffness 11
1325
Coefficient C22
94
Coupling Stiffness 12
1326
Coefficient C13
95
Coupling Stiffness 13
1327
Coefficient C41
96
Coupling Stiffness 22
1328
Coefficient C32
97
Coupling Stiffness 23
1329
Coefficient C23
98
Coupling Stiffness 33
1330
Coefficient C14
99
Tension Stress Limit
1331
Coefficient C51
100
Compression Stress Limit
1332
Coefficient C42
101
Shear Stress Limit
1333
Coefficient C33
102
Tension Stress Limit 22
1334
Coefficient C24
103
Compression Stress Limit 22
1335
Coefficient C15
104
Shear Stress Limit 23
1336
Not used
105
Tension Stress Limit 33
.
.
106
Compression Stress Limit 33
.
.
107
Shear Stress Limit 31
.
.
108
Tension Strain Limit
1400
Not used
109
Compression Strain Limit
1401
Coefficient MU1
110
Shear Strain Limit
1402
Coefficient MU2
111
Tension Strain Limit 22
1403
Coefficient MU3
112
Compression Strain Limit 22
1404
Coefficient MU4
113
Shear Strain Limit 23
1405
Coefficient MU5
114
Tension Strain Limit 33
1406
Coefficient MU6
115
Compression Strain Limit 33
1407
Not used
116
Shear Strain Limit 31
1408
Not used
117
Ht Ratio
1409
Not used
118
Not used
1410
Not used
119
Not used
1411
Coefficient ALPHA_1
120
Hardening Slope
1412
Coefficient ALPHA_2
121
Yield Point
1413
Coefficient ALPHA_3
122
Equivalent Yield Stress (J1=0)
1414
Coefficient ALPHA_4
123
Alpha
1415
Coefficient ALPHA_5
124
Beta
1416
Coefficient ALPHA_6
125
Stress 11 Yield Ratio
1417
Not used
126
Stress 22 Yield Ratio
1418
Not used
127
Stress 33 Yield Ratio
1419
Not used
128
Stress 12 Yield Ratio
1420
Not used
129
Stress 23 Yield Ratio
1421
Coefficient D1
130
Stress 31 Yield Ratio
1422
Coefficient D2
131
Internal Friction Angle
1423
Coefficient D3
132
Bonding Shear Stress Limit
1424
Coefficient D4
133
Interaction Term
1425
+Coefficient D5
134
Failure Index
1426
Coefficient D6
135
Creep Reference Temperature
1427
Not used
136
Creep Threshold Factor
.
.
137
Temperature Dependence Exponent
.
.
138
Primary Creep Stiffness
.
.
139
Primary Creep Damping
2001
Not used
140
Secondary Creep Damping
2002
SigmaYY/Strain Curve
141
Coefficient A
2003
SigmaZZ/Strain Curve
142
Coefficient B
2004
SigmaXY/Strain Curve
143
Coefficient C
2005
SigmaYZ/Strain Curve
 
 
2006
SigmaZX/Strain Curve
Example:
Please see list_filter_by_mat_value (p. 358) in the PCL Reference Manual Examples.
list_filter_by_presence
(input_list, acceptance_criteria, reference_list, return_list)
Description:
This function will create a list processor string of entities by using a specified acceptance criteria to compare to list processor strings.
Input:
STRING
input_list[]
This value specifies the list processor string of entities that will be filtered by this function.
STRING
acceptance_criteria[7]
This value specifies the acceptance criterion for a match. See the remarks below for more information.
STRING
reference_list[]
This value specifies the list processor string of entities that will be used as the reference input for the comparison operation.
Output:
STRING
return_list[VIRTUAL]
This value returns a list processor string of entities.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate an error.
Error Conditions:
-1
This is an internal error status condition. There is no corresponding status message in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need to release the memory of the output variable.
The input value acceptance_criteria can be set to the following values:
Value
Description
 
 
exact
Specifies that an accepted entity must match exactly in the two input lists.
parent
Specifies that an accepted entity in the input value input_list must be a parent of an entity in the input value reference_list.
id
Specifies that an accepted entity must have an id value that matches exactly in the two input lists.
s_id
Specifies that an accepted entity in the input value input_list must match an entity in the input value reference_list at the sub-id level.
ss_id
Specifies that an accepted entity in the input value input_list must match an entity in the input value reference_list at the sub-sub-id level.
sss_id
Specifies that an accepted entity in the input value input_list must match an entity in the input value reference_list at the sub-sub-sub-id level.
Example:
Please see list_filter_by_presence (p. 360) in the PCL Reference Manual Examples.
list_intersect
(input_list_1, input_list_2, return_list)
Description:
This function will get the intersection of entities by performing comparisons at the entity and up to third sub-entity level.
Input:
STRING
input_list_1[]
This value specifies the first list processor string of entities.
STRING
input_list_2[]
This value specifies the second list processor string of entities.
Output:
STRING
return_list[VIRTUAL]
This value returns a list processor string describing the intersecting entities.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate an error.
Error Conditions:
-1
This is an internal error status condition. There is no corresponding status message in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need to release the memory of the output variable.
Example:
Please see list_intersect (p. 361) in the PCL Reference Manual Examples.
list_rem_duplicate
(input_list, return_list)
Description:
This function will create a list processor string from which any duplicate entities have been removed.
Input:
STRING
input_list[]
This value specifies the list processor string of entities that will searched for duplicates.
Output:
STRING
return_list[VIRTUAL]
This value returns a list processor string of entities with an duplicate entities removed.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate an error.
Error Conditions:
-1
This is an internal error status condition. There is no corresponding status message in the message database.
Remarks:
Memory is allocated for the output variable within this function. If memory was allocated prior to the call, it is released prior to re-allocation. Therefore, if this function is used within a loop, there is no need to release the memory of the output variable.
This function will remove duplicate entities down to the third sub-entity level and will regroup entity keywords.
Example:
Please see list_rem_duplicate (p. 362) in the PCL Reference Manual Examples.
list_save_group
(target_list, group_name, update)
Description:
This function will add a list of entities stored in a global string variable into a group.
Input:
STRING
target[]
This value specifies which global string will be used for the storage of the results. This argument can have the following values: “lista”, “listb”, or “listc”.
STRING
group_name[]
This value specifies the name of the group to which the entities are stored.
LOGICAL
update
This value specifies, if set to TRUE, that the viewport that contains the newly updated group will be updated.
Output:
None.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
1000025
Error attempting to allocate virtual memory.
11000011
The entity is not contained in the specified group.
11000012
The entity is already contained in the specified group.
11000050
The group name is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000105
The specified group was not found in the database.
11000121
There is not a current group defined.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
13000008
Group not found
13000014
Viewport not found
48000001
*%A% * is not a valid target list!
Remarks:
If the group specified by the input value group_name does not exist, it will be created.
This function will display a warning popup form with the following message if the target input value is out of range:
 
48000001
*%A% * is not a valid target list!
This function uses a warning popup form to report any errors returned by call to the function ga_group_entity_add().
This function uses an acknowledgment popup form to report any error returned by a call to the function ga_group_exist_get().
Example:
Please see list_save_group (p. 363) in the PCL Reference Manual Examples.
  
uil_list_a.previous
()
 
Description:
This function will swap the contents of the global string variable lista with the contents of the global string variable lista_reset.
Input:
None.
Output:
None.
Error Conditions:
None.
Remarks:
None.
Example:
Please see uil_list_a.previous (p. 364) in the PCL Reference Manual Examples.
 
uil_list_b.previous
()
 
Description:
This function will swap the contents of the global string variable listb with the contents of the global string variable listb_reset.
Input:
None.
Output:
None.
Error Conditions:
None.
Remarks:
None.
Example:
Please see uil_list_b.previous (p. 366) in the PCL Reference Manual Examples.
  
uil_list_a.clear
()
 
Description:
This function sets the global string lista_reset to the contents of the global string lista and then sets lista to a single space.
Input:
None.
Output:
None.
Error Conditions:
None.
Remarks:
None.
Example:
Please see uil_list_a.clear (p. 367) in the PCL Reference Manual Examples.
 
uil_list_b.clear
()
 
Description:
This function sets the global string listb_reset to the contents of the global string listb and then sets listb to a single space.
Input:
None.
Output:
None.
Error Conditions:
None.
Remarks:
None.
Example:
Please see uil_list_b.clear (p. 368) in the PCL Reference Manual Examples.
 
uil_list_boolean.create
(boolean)
 
Description:
This function creates a list of entities by combining the contents of the global strings lista and listb using the type of operation specified by the input value boolean and placing the results in the global string listc.
Input:
STRING
boolean[7]
This value specifies the type of combination operation. See the remarks below for more information.
Output:
None.
Error Conditions:
None.
Remarks:
The input value boolean can have the following values used to specify the different types of combinational operations which combine the lists listed by the global string values lista and listb in the following manner:
Operational string value
Description:
“or”, “eval_or”
Combines the two global strings lista and listb, sorts them, and deletes any duplicate values.
“and”, “and_fg”
Combines the two global strings lista and listb, sorts them, and leaves any duplicate entries in place.
“a-b”
Removes all items in listb from lista, then sorts the results.
“b-a”
Removes all items in lista from listb, then sorts the results.
This function can display an information popup form with the following message:
 
48000013
Boolean listc is empty!
This function can display an information popup form with the following message:
48000002
*%A% * is not a valid boolean operator!
This function makes use of following documented functions:
list_create_boolean_list()
Example:
Please see uil_list_boolean.create (p. 369) in the PCL Reference Manual Examples
uil_list_a.replace
()
Description:
This function will set the contents of the global string variable lista_reset to equal the contents of the global string variable lista. It will then set the global string variable lista to equal the contents of the global string variable listc.
Input:
None.
Output:
None.
Error Conditions:
None.
Remarks:
None.
Example:
Please see uil_list_a.replace (p. 370) in the PCL Reference Manual Examples.
 
uil_list_b.replace
()
 
Description:
This function will set the contents of the global string variable listb_reset to equal the contents of the global string variable listb. It will then set the global string variable listb to equal the contents of the global string variable listc.
Input:
None.
Output:
None.
Error Conditions:
None.
Remarks:
None.
Example:
Please see uil_list_b.replace (p. 371) in the PCL Reference Manual Examples.
 
mass_prop_create
(analysis_model_type, all_or_group, include, number_of_groups, groups, coordinate_frame, density, thickness_or_area, axisymmetric_frame, axisymmetric_axis, other_axis, plot, aligned_frame, mass_properties, entity_list, length_entities, number_of_entities, reject_list, length_reject, number_of_rejects, segment_id, aligned_label, coordinate_label)
 
Description:
This function will calculate the mass properties of a set of finite element and geometric entities, can plot the principal axes of the inertia tensor at the center of gravity, and can create and post a coordinate frame that is aligned with the principal axes of the inertia tensor.
Input:
STRING
analysis_model_type[15]
This value specifies the analysis model type. This argument may have the value “3D”, “2D Axisymmetric”, “2D Plane Stress”, or “2D Plane Strain”.
STRING
all_or_group[5]
This value specifies the use of all entities in a model or to make use of a list of groups of entities for the mass property calculations. This value may be set to “All” or “Group”.
STRING
include[8]
This value specifies the selection of geometric or finite element entities or both types of entities. This value may be set to “Geometry”, “FEM”, or “Both”
INTEGER
number_of_groups
This value specifies the number of groups in the region to which this mass property applies. This value is ignored if the input value all_or_group is set to “All”.
STRING
groups[31](number_of_groups)
This value specifies an array of group names that will be used for mass property calculations. The number of offsets defined for this array should be equal to the value of the input value number_of_groups. This argument is ignored if the input value all_or_group is set to “All”.
STRING
coordinate_frame[]
This value specifies a list of entities used to define a coordinate frame against which the mass properties will be calculated. This argument is used only if the input value analysis_model_type is set to “3D”, “2D Plane Stress”, or “2D Plane Strain”. If the input value analysis_model_type is set to “2D Axisymmetric”, this value will not be used and the input value axisymmetric_frame will be used in its place. The coordinate frame that this value defines must be either Cartesian coordinate system only.
STRING
density[22]
This value specifies a selection between the mass properties defined with each element or the use of mass properties that have been set to a unity value. This argument can be set to either the value “Use Element Properties” or “Unity”.
STRING
thickness_or_area[22]
This value specifies the thickness and area used with one and two dimensional entities as either being the thickness or area defined by the entity or being a unit value. This argument may be set to a value of either “Use Element Properties” or “Unity”.
STRING
axisymmetric_frame[]
This value specifies information in the list processor format that defines the axisymmetric modeling coordinate frame against which the mass properties will be calculated. This argument is used only if the input value analysis_model_type is set to “2D Axisymmetric”. If the input value analysis_model_type is not set to “2D Axisymmetric”, the input value coordinate_frame will be used instead of the input value axisymmetric_frame. The coordinate frame that this argument defines must be either a Cartesian or a cylindrical coordinate system.
INTEGER
axisymmetric_axis
This value specifies the axis of symmetry for axisymmetric models. This argument may have a value of 1, 2, or 3 and is used only when the input value analysis_model_type is set to “2D Axisymmetric”.
INTEGER
other_axis
This value specifies an axis that along with the input value axisymmetric_axis defines the axisymmetric modeling plane. This argument may have a value of 1, 2, or 3 and is used only when the input value analysis_model_type is set to “2D Axisymmetric”.
LOGICAL
plot
This value specifies, when set to TRUE, that the principal axes of the inertia tensor to be plotted.
LOGICAL
aligned_frame
This value specifies, when set to TRUE, that a coordinate frame that is aligned with the principal axes of inertia be created.
Output:
REAL
mass_properties(VIRTUAL)
This value returns a 68 element array of mass properties. See the remarks below for more information.
STRING
entity_list[VIRTUAL]
This value returns a list of all entities passed to this function as a string in the list processor format.
INTEGER
length_entities
This value returns the length of the string in the return value entity_list.
INTEGER
number_of_entities
This value returns the number of entities in the list of entities returned by the output value entity_list.
STRING
reject_list[VIRTUAL]
This value returns list of entities that were not included in the mass property calculations.
INTEGER
length_reject
This value returns the length of the string in the output value reject_list.
INTEGER
number_of_rejects
This value returns the number of entities in the list of entities returned by the output value reject_list.
INTEGER
segment_id
This value returns the segment ID for the plot of the principal axes of the inertia tensor. This argument will be set to -1 if the input value plot is set to FALSE.
INTEGER
aligned_label
This value returns the label for a coordinate frame that has been created so that it is coincident with the principle axes of inertia. If the input value aligned_frame is set to FALSE, this output value will be set to 0.
INTEGER
coordinate_label
This value returns the label for the coordinate frame defined by the input value coordinate_frame.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
-1
This is an internal status condition. There is no corresponding status message in the message database.
1
This is an internal status condition. There is no corresponding status message in the message database.
2001083
A system error has occurred in the FEM C Applications Memory Manager.
2001084
Unable to acquire %I% bytes of virtual memory.
2001085
A programming error has resulted in an attempt to free unallocated memory.
2001086
A programming error has resulted in an attempt to reallocate unallocated memory.
2001087
A programming error has resulted in an attempt to acquire zero bytes of virtual memory.
8107002
Last command aborted.
13000002
Unrecoverable database error
13000004
Duplicate entry exists in table
13000006
Referenced item is missing
13000007
An unspecified database error occurred
13000008
Group not found
13000020
Node not found
13000021
Element not found
13000032
Point not found
13000041
Element not found
13000056
Coordinate frame not found
13000088
Preference not found
13000097
Curve input was not found
13000098
Solid input was not found
13000107
Vector input was not found
13000122
The surface requested was not found
13000126
The entity specified in the query was not labeled.
13000210
The system is out of virtual memory.
13000211
Virtual memory has been exhausted.
13000212
There is an error interacting with the PERSISTENT_MEMORY relation in the database.
13000215
Message 13000215 not found in message file(s
13000220
Plane input was not found
14000001
LpGetHeapSpace: Allocated heapspace is exhausted
14000003
LpSublistType: No sublist filter bits are set on invocation
14000004
LpSublistType: I am being invoked with a NULL list
14000005
LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006
LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007
LpSublistType: In the list being used, the current finite element sublist is uncalssifiable.
14000008
LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009
LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010
LpSublistType: In the list being used, the current sublist does not match the sublist filter.
14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000146
LpSublistFetch: The output area is too small to hold the sublist being fetched.
14000208
LpSublistAttributeGet: Curve evaluator error
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
14000211
LpSublistAttributeGet: Surface evaluator error
14000281
LpExpandPclVariables: Virtual memory is full.
14000295
LpSublistAttributeGet: The CAD native curve can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000296
LpSublistAttributeGet: The CAD native surface can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
16000105
A programming error has caused an invalid PCL symbol to be passed.
30001046
Storage Error. The selected term has no data stored. Please re-create this field.
30001401
Unable to allocate enough memory to evaluate the field.
30001402
No Evaluation method is defined for this field type.
30001404
Error occurred when evaluating the PCL expression.
30001413
Error in results dimension; should be 1 or 3
30001414
Unable to get element properties for specified elements.
30001415
Results table dimension not the expected 1 or 3.
30001416
Unable to allocate memory for interpolation.
30001417
Error creating connectivity array index.
30001418
Error finding Hpat coefficients for element.
30001421
Error getting EP node list.
30001422
Error making constraints from elements.
30001423
Number of independent dimensions of results fields not equal to 3.
30001431
Unable to Evaluate the specified element.
30001438
Unable to Evaluate the field.
30001435
Unable to evaluate the FEM field for this application because no valid elements were detected in the group which was used to define this field. At this time, only 2D and 3D elements are supported for FEM Field evaluation.
38000001
The allocated space for the blob is too small.
38000003
No blob provided.
53000001
The axisymmetric coordinate frame cannot be spherical.
53000002
The reference coordinate frame must be rectangular.
53000003
The specified axes for the axisymmetric modeling frame are unreasonable.
53000004
The specified axes for the axisymmetric modeling frame are both %I%. The axisymmetric frame is, therefore, not well-defined.
53000005
You have requested to specify your region by groups, but the group list is empty.
53000006
An unsupported widget value has been selected for the %A% widget.
53000007
Unable to obtain model definition data from the database.
53000008
The specified region contains no entities.
53000010
A database error occurred while attempting to fetch an element property region for %A%.
53000011
There is no default analysis code in the database. This is a problem with database template initialization.
53000012
A database error occurred while attempting to fetch the physical property ID’s for element property region %I% having entities of dimension %I%.
53000013
A database consistency error occurred while attempting to fetch physical property %I% of element property region %I%.
53000014
Unable to perform a database fetch of a coordinate frame (Internal ID = %I%).
53000015
Unable to fetch the definition data for element property region %I%.
53000016
Unable to fetch the properties of material %I%.
53000017
Unable to fetch the definition for %A% %I%.
53000018
Unable to perform a database fetch of a coordinate frame (Internal ID = %I%) referenced by a concentrated mass.
53000019
Unable to fetch the coordinates of a point to determine the location of a concentrated mass.
53000020
Unable to fetch the coordinates of a 0D element.
53000022
A programming error has occurred while attempting to process a solid entity in an axisymmetric model. An earlier filter should have prevented this. For a workaround, please do not specify any such entities for mass properties calculation.
53000026
No mass properties can be calculated for any of the entities in the specified region. The reasons are given in the ensuing warning messages. Check the History window for multiple warning messages.
53000027
None of the entities in the specified region is compatible with the requested analysis type.
53000028
The list of included entities could not be generated.
53000029
The list of rejected entities could not be generated.
53000043
Unable to calculate a normal for 2D element %I%.
53000044
Unable to process the geometric definition for %A% %I%.
53000046
The modeling plane cannot be uniquely determined from the entities specified.
53000048
A normal to the axisymmetric modeling plane cannot be determined.
53000050
Unable to evaluate a point relative to the 2D modeling plane.
53000051
Unable to evaluate a point of %A%.
53000063
Some of the referenced element properties define an offset. All offsets are ignored in the calculation of mass properties. This can cause the results to change substantially.
53000065
Unable to evaluate the area of %A%.
53000067
The specified axis of symmetry divides the specified model. Mass properties can only be calculated when all of the specified entities are on the same side of the symmetry axis.
53000068
A database error occurred while attempting to fetch the element property regions for the specified entities.
53000070
Zero-dimensional entities are not included in the mass property calculations if you do not specify that Element Properties are to be used to determine density and concentrated mass. Consequently there are no valid entities in the specified region.
Remarks:
The output values mass_properties, entity_list, and reject_list are all VIRTUAL data arrays that have memory space allocated by the called function. It is the responsibility of the calling function to free memory returned by these arguments in an appropriate manner.
The output value mass_properties returns an array whose offsets contain the following information.:
 
Array Offset
Description
 
 
1
This offset returns the volume of the entities used in the mass properties calculations.
2
This offset returns the mass of the entities used in the mass properties calculations.
3-5
These offsets are used to return the center of gravity coordinates for the entities used in the mass properties calculations in the specified coordinate frame. The specified coordinate frame is listed in the output value coordinate_label.
6-11
These offsets are used to return the inertia tensor in the specified coordinate frame. The specified coordinate frame is listed in the output value coordinate_label.
12-17
These offsets are used to return the inertia tensor at the center of gravity point in the specified coordinate frame. The specified coordinate frame is listed in the output value coordinate_label.
18-20
These offsets are used to return the principle axes of the moments of inertia at the center of gravity point in the specified coordinate frame. The specified coordinate frame is listed in the output value coordinate_label.
21-29
These offsets are used to return the direction for the principle axes of the moments of inertia in the specified coordinate frame. The specified coordinate frame is listed in the output value coordinate_label.
30-32
These offsets are used to return radii of gyration corresponding to the principal inertial axes.
33-35
These offsets are used to return the center of gravity in the reference Cartesian coordinate frame. The reference Cartesian coordinate frame is listed in the output value aligned_label.
36-41
These offsets are used to return the inertia tensor in the reference Cartesian coordinate frame. The reference Cartesian coordinate frame is listed in the output value aligned_label.
42-47
These offsets are used to return the inertia tensor at the center of gravity in the reference Cartesian coordinate frame. The reference Cartesian coordinate frame is listed in the output value aligned_label.
48-56
These offsets are used to return the direction for the principle axes of the moments of inertia in the reference Cartesian coordinate. The reference Cartesian coordinate frame is listed in the output value aligned_label.
57-59
These offsets are used to return the principal directions for the axes of the moments of inertia in the axes order 3-2-1 of the space fixed rotation angles from the specified coordinate system. The specified coordinate frame is listed in the output value coordinate_label.
60-62
These offsets are used to return the principal directions for the axes of the moments of inertia in the axes order 3-1-3 of the body fixed rotation angles from the specified coordinate system. The specified coordinate frame is listed in the output value coordinate_label.
63-65
These offsets are used to return the principal directions for the axes of the moments of inertia in the axes order 3-2-1 of the space fixed rotation angles from the reference Cartesian coordinate frame. The reference Cartesian coordinate frame is listed in the output value aligned_label.
66-68
These offsets are used to return the principal directions of the inertia tensors in the axes order 3-1-3 of the body fixed rotation angles from the reference Cartesian coordinate frame. These symmetric inertia tensors are in the axes order XX, XY, XZ, YY, YZ, ZZ. The reference Cartesian coordinate frame is listed in the output value aligned_label.
This function can display the following fatal popup forms:
2001083
A system error has occurred in the FEM C Applications Memory Manager.
2001084
Unable to acquire %I% bytes of virtual memory.
2001085
A programming error has resulted in an attempt to free unallocated memory.
2001086
A programming error has resulted in an attempt to reallocate unallocated memory.
2001087
A programming error has resulted in an attempt to acquire zero bytes of virtual memory.
14000001
LpGetHeapSpace: Allocated heapspace is exhausted
14000003
LpSublistType: No sublist filter bits are set on invocation
14000004
LpSublistType: I am being invoked with a NULL list
14000005
LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006
LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007
LpSublistType: In the list being used, the current finite element sublist is uncalssifiable.
14000008
LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009
LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010
LpSublistType: In the list being used, the current sublist does not match the sublist filter.
14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000208
LpSublistAttributeGet: Curve evaluator error
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
14000211
LpSublistAttributeGet: Surface evaluator error
14000281
LpExpandPclVariables: Virtual memory is full.
14000295
LpSublistAttributeGet: The CAD native curve can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000296
LpSublistAttributeGet: The CAD native surface can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
16000105
A programming error has caused an invalid PCL symbol to be passed.
16000501
Unable to allocate %I% bytes of virtual memory.
30001061
Field %A% is disassociated with geometry entity and unuseable unless a new geometry entity is provided.
30001401
Unable to allocate enough memory to evaluate the field.
30001413
Error in results dimension; should be 1 or 3
30001432
Unable to Evaluate the field.
30001433
Error converting Node ID reference to vector for discrete element field.
38000906
Unable to fetch definition data for solid %I%.
53000001
The axisymmetric coordinate frame cannot be spherical.
53000002
The reference coordinate frame must be rectangular.
53000003
The specified axes for the axisymmetric modeling frame are unreasonable.
53000004
The specified axes for the axisymmetric modeling frame are both %I%. The axisymmetric frame is, therefore, not well-defined.
53000005
You have requested to specify your region by groups, but the group list is empty.
53000006
An unsupported widget value has been selected for the %A% widget.
53000007
Unable to obtain model definition data from the database.
53000008
The specified region contains no entities.
53000009
Unable to fetch group %A% from the database.
53000010
A database error occurred while attempting to fetch an element property region for %A%.
53000011
There is no default analysis code in the database. This is a problem with database template initialization.
53000012
A database error occurred while attempting to fetch the physical property ID’s for element property region %I% having entities of dimension %I%.
53000013
A database consistency error occurred while attempting to fetch physical property %I% of element property region %I%.
53000014
Unable to perform a database fetch of a coordinate frame (Internal ID = %I%).
53000015
Unable to fetch the definition data for element property region %I%.
53000016
Unable to fetch the properties of material %I%.
53000017
Unable to fetch the definition for %A% %I%.
53000018
Unable to perform a database fetch of a coordinate frame (Internal ID = %I%) referenced by a concentrated mass.
53000019
Unable to fetch the coordinates of a point to determine the location of a concentrated mass.
53000020
Unable to fetch the coordinates of a 0D element.
53000021
Unable to initialize field %I% for evaluation.
53000022
A programming error has occurred while attempting to process a solid entity in an axisymmetric model. An earlier filter should have prevented this. For a workaround, please do not specify any such entities for mass properties calculation.
53000026
No mass properties can be calculated for any of the entities in the specified region. The reasons are given in the ensuing warning messages. Check the History window for multiple warning messages.
53000027
None of the entities in the specified region is compatible with the requested analysis type.
53000028
The list of included entities could not be generated.
53000043
Unable to calculate a normal for 2D element %I%.
53000044
Unable to process the geometric definition for %A% %I%.
53000046
The modeling plane cannot be uniquely determined from the entities specified.
53000048
A normal to the axisymmetric modeling plane cannot be determined.
53000050
Unable to evaluate a point relative to the 2D modeling plane.
53000051
Unable to evaluate a point of %A%.
53000065
Unable to evaluate the area of %A%.
53000067
The specified axis of symmetry divides the specified model. Mass properties can only be calculated when all of the specified entities are on the same side of the symmetry axis.
53000068
A database error occurred while attempting to fetch the element property regions for the specified entities.
53000070
Zero-dimensional entities are not included in the mass property calculations if you do not specify that Element Properties are to be used to determine density and concentrated mass. Consequently there are no valid entities in the specified region.
53000029
The list of rejected entities could not be generated.
This function can display the following warning popup forms:
 
30001424
Routine to locate points in elements did not converge for %I% interpolants.
30001434
0D and/or 1D Elements have been detected in the group which was used to define this FEM Field. These elements will be ignored during any evaluation of this field as FEM Field evaluators have not yet been implemented for these elements.
53000030
Some of the specified entities were excluded from the mass property calculations because no element property region has been specified for them.
53000031
Some of the specified entities were excluded from the mass property calculations because they are not consistent with the specified analysis model type.
53000032
Some of the specified entities were excluded from the mass property calculations because they have no material assigned to them in their element property records.
53000033
Some of the specified entities were excluded from the mass property calculations because some of their needed element properties are not found or represented using data types that are supported by the Mass Properties.
53000034
Some of the specified concentrated mass elements have inertia tensors specified in non-rectangular frames. These inertia tensors are assumed to be defined on a rectangular frame whose axes are coincident with the axes of the specified non-rectangular frame.
53000035
Some of the specified tapered beams were excluded from the mass property calculations because their element property records have non-constant cross-sectional areas.
53000036
Some of the specified entities were excluded from the mass property calculations because their element property definitions lack a needed physical property such as shell thickness or beam cross-sectional area.
53000037
Some of the specified entities were excluded from the mass property calculations because their material property definitions lack a needed property such as density.
53000038
Some of the specified point entities were excluded from the mass property calculations because they have no mass.
53000039
Some of the specified entities were excluded from the net mass property calculations because errors occurred in the numerical integration of their mass properties. This is often caused by a shortage of available virtual memory or a property defined by a field that cannot be integrated over the entity.
53000040
The coordinate frame aligned with the principal axes of inertia could not be generated. This is usually an indication of a corrupted database or a lack of available virtual memory.
53000042
The principal axes of inertia cannot be plotted.
53000047
Some of the specified entities were excluded from the mass property calculations because they are not planar.
53000049
Some of the specified entities were excluded from the mass property calculations because they are not in the modeling plane.
53000059
Some of the specified entities were excluded from the net mass property summation because their calculated mass is zero. This problem can occur when a property is defined by a field that cannot be integrated over the entity.
53000060
Some of the specified entities were excluded from the net mass property summation because their calculated volume is zero. The excluded entities are not point entities, so their calculated mass must also be zero. This problem can occur when the wrong modeling plane is specified for an axisymmetric model or when part of an entity crosses the axis of symmetry.
53000062
Some of the concentrated masses have the moments of inertia defined. This can cause counter-intuitive results to occur when the 2D Axisymmetric analysis type is selected. The input moments of inertia are treated as moment of inertia densities and are multiplied by 2*PI*radius to determine their contribution to the net inertia tensor of the concentrated mass.
53000063
Some of the referenced element properties define an offset. All offsets are ignored in the calculation of mass properties. This can cause the results to change substantially.
53000064
Not all of the principal axes of inertia can be plotted. Their lengths are determined by the three radii of gyration corresponding to the three principal inertias, and some of these are zero.
53000066
Some of the materials referenced by the specified entities have density defined by a field. Density fields are not supported for mass property calculations. Entities referencing a density field will be assigned a density of zero.
53000069
Unable to display newly created principal coordinate frame %I%.
53000071
The specified zero-dimensional entities were excluded from the mass property calculations because the Unity option for Density/Concentrated Mass was selected. Under these circumstances, zero-dimensional entities are ignored.
This function can display the following information popup forms:
 
11000007
The viewport name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
13000088
Preference not found
13000014
Viewport not found
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
13000056
Coordinate frame not found
13000074
Coordinate frame not posted
15000018
The specified viewport was not found in the database.
15000019
The specified group was not found in the database.
15000046
The specified segment id exceeded the maximum of 15 allowed. The segment was not created.
15000047
The specified segment id was not found in the Gm display list.
30001425
Notice: %I% interpolants lie off the field
30001437
An attempt was made to average nodal values for an element. All of the element nodes were not found for %I% elements.
53000056
Loading data from materials...
This function can display the following percent done popup forms:
53000054
Loading element properties into memory...
53000055
Performing mass property calculations...
Example:
Please see mass_prop_create (p. 373) in the PCL Reference Manual Examples.
 
mass_prop_create_detailed
( an_mod_typ, select_type, include, display, ngroups, groups, user_coord, density, thick_area, axy_coord, sym_axis, other_axis, plot, cord_frame, noutputs, entities, mass_props, entity_list, len_elist, num_ents, reject_list, len_rlist, num_rejects, cord_segment, cord_label, user_frame_id )
Description:
For a given set of FEM and/or Geometric entities, calculate the mass properties based on selecting Geometry, FEM, or Both and returning them as a summary, or on a per group or entity basis. If requested, plot the principal axes of the inertia tensor at the CG, and create and post a coordinate frame aligned with those axes. This function is typically used in conjunction with mass_prop.cleanup_detailed and mass_prop.gen_report_detailed.
Input:
 
 
STRING
an_mod_typ[]
Analysis model type. It may be either “3D”, “2D Axisymmetric”, “2D Plane Stress”, or “2D Plane Strain”.
STRING
select_type[]
This first region specifier, may be either “All” , “Group” or "Selected".
STRING
include[]
This second region specifier, may be either “Geometry”, “FEM”, or “Both”.
STRING
display[]
This determines how the results are displayed to the spreadsheet. Either "Summary", "Group", or "Entity". For display of “Summary”, duplicate entries will be filtered out to avoid counting entities more than once.
INTEGER
ngroups
Number of groups in the region for mass properties. If "select_type" is set to "Group" then this is the number of groups. If "select_type" is set to "Entity" or "All", then this value is ignored.
STRING
groups[32](VIRTUAL)
If "display" is set to "Group" or "All", then this is an array of group names in the region for mass properties. If "display" is set to "Entity", this value is ignored.
STRING
entities[VIRTUAL]
The list of entities specified if the select_type is set to "Selected". This value is ignored if the select_type is set to "All" or "Group".
STRING
user_coord[]
Select databox string defining the coordinate frame relative to which the mass properties are to be calculated.
STRING
density[]
Option used to define mass properties for the selected entities. It may be either “Use Element Properties” or “Unity”.
STRING
thick_area[]
Option used to define the thicknesses and areas for the selected 2D and 1D entities respectively. It may be either “Use Element Properties” or “Unity”.
STRING
axy_coord[]
Select databox string defining the axisymmetric modeling coordinate frame. It is used only if an_mod_type is “2D Axisymmetric”. The coordinate frame must be rectangular or cylindrical.
INTEGER
sym_axis
Axis of symmetry for axisymmetric models. It may be either 1, 2, or 3. This is used only if an_mod_type is “2D Axisymmetric”.
INTEGER
other_axis
’other_axis’ and sym_axis define the axisymmetric modeling plane. Acceptable values are 1, 2, or 3. This is used only if an_mod_type is “2D Axisymmetric”.
LOGICAL
plot
If TRUE, then the principal axes of the inertia tensor will be plotted.
LOGICAL
cord_frame
If TRUE, then a coordinate frame aligned with the principal axes will be generated.
Output
INTEGER
noutputs
If display is set to "Entity", this is the number of unique entities that have valid mass properties. If "display" is set to "Group", then noutputs is returned equal to the number of groups with valid mass properties. If the "display" is set to "Summary", this value is equal to "1".
STRING
group_names (noutputs)
Returned array of noutputs group names. This is only used for display mode of group.
INTEGER
entity_ids(noutputs)
If "display" is set to "Entity", this is an array of all selected entity ids that have valid mass properities. If "display" is set to "Group" or "All", this is ignored.
INTEGER
entity_types
(noutputs)
This will tell what type of entity is given in the entity_ids array above. Duplicate IDs may exist for an element & a surface for example. This array would give the corresponding lpenums.i value to determine the entity type.
REAL
mass_props_array(noutputs,VIRTUAL)
This data is returned on a per output (group or entity) basis. The order of this array matches the order of "entities" for "display" set to "Entity" or the order of "groups" when "display" is set to "Group". Array of mass properties, including, in this order: (1) volume, (2) mass, (3-5) CG in specified frame, (6-11) inertia tensor in specified frame, (12-17) inertia tensor at CG in specified frame, (18-20) principal inertias at CG, (21-29) principal directions in specified frame, (30-32) radii of gyration corresponding to the principal inertias, (33-35) CG in reference Cartesian frame, (36-41) inertia tensor in reference Cartesian frame, (42-47) inertia tensor at CG in reference Cartesian frame, (48-56) principal directions in reference Cartesian frame, (57-59) principal direction 3-2-1 space-fixed rotation angles from specified frame, (60-62) principal direction 3-1-3 body-fixed rotation angles from specified frame, (63-65) principal direction 3-2-1 space-fixed rotation angles from reference Cartesian frame, (66-68) principal direction 3-1-3 body-fixed rotation angles from reference Cartesian frame, (69) if bar then this is length, if shell this is surface area, and if solid element then this value is ignored. Symmetric tensors are in the order: XX, XY, XZ, YY, YZ, ZZ.
STRING
entity_list(VIRTUAL)
This is a List Processor-recognizable list of all entities specified. This is only valid if noutputs is 1 (such as display set to “Summary”).
INTEGER
len_elist
Length of string ’entity_list’. Only used if Display of Summary
INTEGER
num_ents
Number of entities in ’entity_list’.Only used if Display of Summary
STRING
reject_list(VIRTUAL)
List of input entities not included in mass property calculations.
INTEGER
len_rlist
Length of string ’reject_list’.Only used if Display of Summary
INTEGER
num_rejects
Number of entities in ’reject_list’.Only used if Display of Summary
INTEGER
cord_segment
Segment ID for graphics (-1 if none were generated)
INTEGER
cord_label
Label of coordinate frame created coincident with the principal directions
INTEGER
user_frame_id
ID of user-specified reference coordinate frame
INTEGER
<Return Value>
Error code (= 0 if successful)
Side Effects:
 
 
 
Messages:
If an error condition exists, then the diagnostics will be output and a reject list of the elements with invalid properties will be generated. Some of the warnings and error messages are suppressed for display by group and display by entity to avoid displaying a large number of duplicate error messages. These warnings and errors can be seen by selecting the rejected element list and displaying by summary.
Error Conditions:
Same as Error Conditions in mass_prop_create function
 
mass_prop.gen_report
(file_columns, mass_properties, coordinate_label, entity_list, number_of_entities, entity_list_length, reject_list, number_of_rejects, length_reject)
 
Description:
This function will write a set of mass properties and an entity list to a report file. The report file name can be set through the “Report...” item of the “File” menu bar selection in the main form of Patran.
Input:
INTEGER
file_columns
This value specifies the number of columns in the report. This value must be either 80 or 132.
REAL
mass_properties(68)
This value specifies the property information that will be listed in the report. See the remarks below for more information.
INTEGER
coordinate_label
This value specifies a label used to define a coordinate frame against which the mass properties were calculated.
STRING
entity_list[]
This value specifies a list of entities in the list processor format of all of the entities that are associated with the input value mass_properties being written to the report file.
INTEGER
number_of_entities
This value specifies the number of entities listed in the entity_list input value.
INTEGER
entity_list_length
This value specifies the length of the input value entity_list.
STRING
reject_list[]
This value specifies a list of entities in the list processor format that where rejected in the calculation of the input value mass_properties being written to the report file.
INTEGER
number_of_rejects
This value specifies the number of entities in the input value reject_list.
INTEGER
length_reject
This value specifies the length of the input value reject_list.
Output:
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
This is only a partial list of the error values that can be returned by this function.
1
This is an internal status condition. There is no corresponding status message in the message database.
53000057
Unable to complete the Mass Properties report file. Failure occurred while attempting to write: %A%
53000058
Unable to allocate virtual memory.
Remarks:
See the listing for the function mass_prop_create, 442 for further information on the inputs for this function.
The output value mass_properties returns an array whose offsets contain the following information:
 
Array Offset
Description
1
This offset returns the volume of the entities used in the mass properties calculations.
2
This offset returns the mass of the entities used in the mass properties calculations.
3-5
These offsets are used to return the center of gravity coordinates for the entities used in the mass properties calculations in the specified coordinate frame.
6-11
These offsets are used to return the inertia tensor in the specified coordinate frame.
12-17
These offsets are used to return the inertia tensor at the center of gravity point in the specified coordinate frame.
18-20
These offsets are used to return the principle axes of the moments of inertia at the center of gravity point in the specified coordinate frame.
21-29
These offsets are used to return the direction for the principle axes of the moments of inertia in the specified coordinate frame.
30-32
These offsets are used to return radii of gyration corresponding to the principal inertial axes.
33-35
These offsets are used to return the center of gravity in the reference Cartesian coordinate frame.
36-41
These offsets are used to return the inertia tensor in the reference Cartesian coordinate frame.
42-47
These offsets are used to return the inertia tensor at the center of gravity in the reference Cartesian coordinate frame.
48-56
These offsets are used to return the direction for the principle axes of the moments of inertia in the reference Cartesian coordinate.
57-59
These offsets are used to return the principal directions for the axes of the moments of inertia in the axes order 3-2-1 of the space fixed rotation angles from the specified coordinate system.
60-62
These offsets are used to return the principal directions for the axes of the moments of inertia in the axes order 3-1-3 of the body fixed rotation angles from the specified coordinate system.
63-65
These offsets are used to return the principal directions for the axes of the moments of inertia in the axes order 3-2-1 of the space fixed rotation angles from the reference Cartesian coordinate frame.
66-68
These offsets are used to return the principal directions of the inertia tensors in the axes order 3-1-3 of the body fixed rotation angles from the reference Cartesian coordinate frame. These symmetric inertia tensors are in the axes order XX, XY, XZ, YY, YZ, ZZ.
This function can display the following fatal popup forms:
Example:
Please see mass_prop.gen_report (p. 376) in the PCL Reference Manual Examples.
 
mass_prop.gen_report_detailed
( file_width, noutputs, display_method, includes, groups, entities, entity_types, mass_props_array, thick_area, user_frame_id, entity_list, num_ents, len_elist, reject_list, num_rejects, len_rlist )
Description:
Write the mass properties and the entity lists generated by mass_prop_create_detailed to a report file.
Input:
INTEGER
file_width
Width of report file. Input 80 or 132
INTEGER
noutputs
If display from mass_prop_create_detailed is set to "Entity", this is the number of unique entities that have mass. If "display" is set to "Group", then this is the number of groups. If the "display" is set to "Summary", this value is equal to "1".
STRING
display_method[]
This determines how the results are displayed to the spreadsheet. Either "Summary", "Group", or "Entity"
STRING
includes[]
This region specifier, may be either “Geometry”, “FEM”, or “Both”.
STRING
groups[32](noutputs)
If "display" is set to "Group", then this is an array of group names in the region for mass properties. If "display" is set to “All” or "Entity", this value is ignored.
INTEGER
entities(noutputs)
The list of entity ids (not applicable if display is set to “Summary").
INTEGER
entity_types(noutputs)
The entity type corresponding to the entity given in the “entities” array (not applicable if display is set to “Summary”). These types are given in the lpenums.i define file.
REAL
mass_props_array(noutputs, VIRTUAL)
Array of mass properties, including, in this order: (1) volume, (2) mass, (3-5) CG in specified frame, (6-11) inertia tensor in specified frame, (12-17) inertia tensor at CG in specified frame, (18-20) principal inertias at CG, (21-29) principal directions in specified frame, (30-32) radii of gyration corresponding to the principal inertias, (33-35) CG in reference Cartesian frame, (36-41) inertia tensor in reference Cartesian frame, (42-47) inertia tensor at CG in reference Cartesian frame, (48-56) principal directions in reference Cartesian frame, (57-59) principal direction 3-2-1 space-fixed rotation angles from specified frame, (60-62) principal direction 3-1-3 body-fixed rotation angles from specified frame, (63-65) principal direction 3-2-1 space-fixed rotation angles from reference Cartesian frame, (66-68) principal direction 3-1-3 body-fixed rotation angles from reference Cartesian frame, (69) if bar then this is length, if shell this is surface area, and if solid element then this value is ignored. Symmetric tensors are in the order: XX, XY, XZ, YY, YZ, ZZ. noutputs is the number of outputs returned from mass_prop_create_detailed (ie. number of entities or groups selected).
STRING
thick_area
Option used to define the thicknesses and areas for the selected 2D and 1D entities respectively. It may be either “Use Element Properties” or “Unity”.
INTEGER
user_frame_id
ID of user-specified reference coordinate frame
STRING
entity_list[VIRTUAL]
This is a List Processor-recognizable list of all entities specified. This is only valid if noutputs is 1 (such as display set to “Summary”).
INTEGER
num_ents
Number of entities in ’entity_list’
INTEGER
len_elist
Length of string ’entity_list’
STRING
reject_list[VIRTUAL]
List of input entities not included in mass property calculations
INTEGER
num_rejects
Number of entities in ’reject_list’. Only valid if “display” in mass_prop_create_detailed call is set to “Summary”
INTEGER
len_rlist
Length of string ’reject_list’. Only valid if “display” in mass_prop_create_detailed call is set to “Summary”
Output:
None
INTEGER
<Return Value>
= 0 Function was successful
Side Effects:
Files:
A Mass Properties report is written to the report file.
Error Conditions:
Error:
Unable to allocate virtual memory.
Error
Unable to write the Mass Properties report file. Failure occurred while attempting to write.
Example:
None.
 
mass_prop.cleanup
( mass_props, entity_list, reject_list, num_ents, num_rejects )
Description:
Free the mass properties arrays created by mass_prop_create.
Input:
REAL
mass_props(VIRTUAL)
Array of mass properties, including, in this order: (1) volume, (2) mass, (3-5) CG in specified frame, (6-11) inertia tensor in specified frame, (12-17) inertia tensor at CG in specified frame, (18-20) principal inertias at CG, (21-29) principal directions in specified frame, (30-32) radii of gyration corresponding to the principal inertias, (33-35) CG in reference Cartesian frame, (36-41) inertia tensor in reference Cartesian frame, (42-47) inertia tensor at CG in reference Cartesian frame, (48-56) principal directions in reference Cartesian frame, (57-59) principal direction 3-2-1 space-fixed rotation angles from specified frame, (60-62) principal direction 3-1-3 body-fixed rotation angles from specified frame, (63-65) principal direction 3-2-1 space-fixed rotation angles from reference Cartesian frame, (66-68) principal direction 3-1-3 body-fixed rotation angles from reference Cartesian frame. Symmetric tensors are in the order: XX, XY, XZ, YY, YZ, ZZ
STRING
entity_list(VIRTUAL)
This is a List Processor-recognizable list of all entities specified
STRING
reject_list(VIRTUAL)
List of input entities not included in mass property calculations
INTEGER
num_ents
Number of entities in ’entity_list’
INTEGER
num_rejects
Number of entities in ’reject_list’
Output:
None
Example:
None.
 
mass_prop.cleanup_detailed
( mass_props, entity_list, reject_list)
Description
Free the mass properties arrays created by mass_prop_create_detailed. This routine should be called before an additional call to mass_prop_create_detailed to free the arrays.
Input:
REAL
mass_props_array(noutputs,VIRTUAL)
Array of mass properties, including, in this order: (1) volume, (2) mass, (3-5) CG in specified frame, (6-11) inertia tensor in specified frame, (12-17) inertia tensor at CG in specified frame, (18-20) principal inertias at CG, (21-29) principal directions in specified frame, (30-32) radii of gyration corresponding to the principal inertias, (33-35) CG in reference Cartesian frame, (36-41) inertia tensor in reference Cartesian frame, (42-47) inertia tensor at CG in reference Cartesian frame, (48-56) principal directions in reference Cartesian frame, (57-59) principal direction 3-2-1 space-fixed rotation angles from specified frame, (60-62) principal direction 3-1-3 body-fixed rotation angles from specified frame, (63-65) principal direction 3-2-1 space-fixed rotation angles from reference Cartesian frame, (66-68) principal direction 3-1-3 body-fixed rotation angles from reference Cartesian frame, (69) if bar then this is length, if shell this is surface area, and if solid element then this value is ignored. Symmetric tensors are in the order: XX, XY, XZ, YY, YZ, ZZ. noutputs is the number of outputs returned from mass_prop_create_detailed (ie. number of entities or groups selected).
STRING
entity_list[VIRTUAL]
This is a List Processor-recognizable list of all entities specified
STRING
reject_list[VIRTUAL]
List of input entities not included in mass property calculations
Output:
None
Example:
None.