Tools Menu

PCL Reference Manual > Basic Functions > Tools Menu

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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	.