General

Tutorial Toolkit Function Descriptions > Element Properties > General

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">

General


bl_create_std_beam_section	(<shape>,<name>,<ndim>,<data_types>,<rvalues>,<field_ids>,<id>)


Description:
This function will create a standard beam section.
Input:
STRING	shape []	Standard shape of the beam section.
STRING	name []	Name for the beam section created.
INTEGER	ndim	Number of dimension required for corresponding beam section shape.
INTEGER	data_types()	Type of data for each dimension.
REAL	rvalues()	Dimension values for beam section
INTEGER	field_ids()	Field ids for beam section.
Output:
INTEGER	id	ID of beam section
INTEGER	<Return Value>	Returns 0 for success, otherwise returns the error code.
Error Conditions:
NONE

Example:

Please see bl_create_std_beam_section (p. 792) in the MSC Acumen Toolkit - Code Example.


bl_get_std_beam_section_data	(<id>,<ndim>,<data_types>,<rvalues>,<field_ids>)


Description:
This function will get standard beam section data.
Input:
INTEGER	id []	Id of the beam section for which data is required.
INTEGER	ndim	Number of dimension required for beam section shape.
Output:
INTEGER	data_types()	Type of data for each dimension.
REAL	rvalues()	Dimension values for beam section.
INTEGER	field_ids()	Field ids for beam section.
INTEGER	<Return Value>	Returns 0 for success, otherwise returns the error code.
Error Conditions:
NONE

Example:

Please see bl_get_std_beam_section_data (p. 794) in the MSC Acumen Toolkit - Code Example.


bl_modify_std_beam_section	(<new_shape>,<old_name>,<new_name>,<ndim>,<data_types>,<rvalues>,<field_ids>,<id>)


Description:
This function will modify the existing standard beam section.
Input:
STRING	new_shape []	Standard shape of the beam section.
STRING	old_name []	Name of the existing beam section .
STRING	new_name[]	Name for the modified beam section.
INTEGER	ndim	Number of dimension required for modified beam section shape.
INTEGER	data_types()	Type of data for each dimension.
REAL	rvalues()	Dimension values for modified beam section.
INTEGER	field_ids()	Field ids for modified beam section.
Output:
INTEGER	id	ID of the modified beam section.
INTEGER	<Return Value>	Returns 0 for success, otherwise returns the error code.
Error Conditions:
1		Invalid shape name

Example:

Please see bl_modify_std_beam_section (p. 796) in the MSC Acumen Toolkit - Code Example.


blcomputeprincaxespoints	(<alpha>,<npoints>,<points>,<centroid>,<princ_axis1>,<princ_axis2>)


Description:
This function calculates principal axes vectors for the beam section from the principal angle alpha. It also scales the axes based on the beam section points.
Input:
REAL	alpha	Principal angle for the beam section.
INTEGER	npoints	Number of points for beam section shape.
REAL	points()	Coordinates for each point
REAL	centroid(2)	Coordinates for centroid of beam section.
Output:
REAL	princ_axis1(2)	First principal axis
REAL	princ_axis2(2)	Second principal axis.
INTEGER	<Return Value>	Returns 0 for success.
Error Conditions:
NONE

Example:

Please see blcomputeprincaxespoints (p. 798) in the MSC Acumen Toolkit - Code Example.


blgetalpha	(<entype>,<prop>,<alpha>)


Description:
This function calculates principal angle for the beam section from the given properties of a beam section.
Input:
INTEGER	entype	Type of beam secion (1=Basic, 2=Advanced)
REAL	prop()	Properties of beam section.
Output:
REAL	alpha	Principal angle for the beam section.
INTEGER	<Return Value>	Returns 0 for success, otherwise returns the error code.
Error Conditions:
1	Invalid entype.
2	Extremely small Izz or Iyy in property definition.

Example:

Please see blgetalpha (p. 799) in the MSC Acumen Toolkit - Code Example.


blgetbuttonicon	(<shape>,<cdo>)


Description:
This function gets the file system location of the button icon bitmap for a shape.
Input:
STRING	shape	Shape of the beam section.
Output:
STRING	cdo[]	File system location of the button icon bitmap for a shape.
INTEGER	<Return Value>	Returns 0 for success,otherwise returns the error code.
Error Conditions:
1	Invalid shape name

Example:

Please see blgetbuttonicon (p. 801) in the MSC Acumen Toolkit - Code Example.


blgetcenters	(<enttype>,<shape>,<dim>,<prop>,<centroid>,<shear>)


Description:
This function calculates the centroid and sheare centre of the beam section.
Input:
INTEGER	enttype	Type of beam secion (1=Basic, 2=Advanced)
STRING	shape	Shape of the beam section.
REAL	dim()	Dimensions for the beam section shape.
REAL	prop()	Properties of beam section.
Output:
REAL	centroid()	Centroid of the beam section.
REAL	shear()	Shear center of the beam section.
INTEGER	<Return Value>	Returns 0 for success, otherwise returns the error code.
Error Conditions:
1	Invalid area in property definition

Example:

Please see blgetcenters (p. 802) in the MSC Acumen Toolkit - Code Example.


blgetdimfieldid	(<bsid>,<dim_loc>,<field_id>)


Description:
This function will get the field id at specified dimension location.
Input:
INTEGER	bsid	Beam section ID.
STRING	dim_loc	Dimension location.
Output:
INTEGER	field_id	Field id at specified dimension location.
INTEGER	<Return Value>	Returns 0 for success.
Error Conditions:
NONE

Example:

Please see blgetdimfieldid (p. 804) in the MSC Acumen Toolkit - Code Example.


blgetdimvalue	(<bsid>,<dim_loc>,<value>)


Description:
This function will get the value at the specified dimension location.
Input:
INTEGER	bsid	Beam section ID.
STRING	dim_loc	Dimension location.
Output:
REAL	value	Value at specified dimension location.
INTEGER	<Return Value>	Returns 0 for success, otherwise returns the error code.
Error Conditions:
NONE

Example:

Please see blgetdimvalue (p. 806) in the MSC Acumen Toolkit - Code Example.


blgetlabelicon	(<shape>,<cdo>)


Description:
This function gets the file system location of the label icon bitmap for a shape.
Input:
STRING	shape	Shape of the beam section.
Output:
STRING	cdo[]	File system location of the label icon bitmap for a shape.
INTEGER	<Return Value>	Returns 0 for success, otherwise returns the error code.
Error Conditions:
1	Invalid shape name.

Example:

Please see blgetlabelicon (p. 807) in the MSC Acumen Toolkit - Code Example.


blgetlabels	(<shape>,<cdo>)


Description:
This function gets the dimension labels for a given shape.
Input:
STRING	shape[]	Shape of the beam section.
Output:
STRING ARRAY	cdo[]()	String array of dimension labels for beam section shape.
INTEGER	<Return Value>	Returns 0 for success, otherwise returns the error code.
Error Conditions:
1	Invalid shape name.

Example:

Please see blgetlabels (p. 809) in the MSC Acumen Toolkit - Code Example.


blgetnumdimension	(<shape>)


Description:
This function gets the number of dimensions required to define a given shape completely.
Input:
STRING	shape[]	Shape of the beam section.
Output:
INTEGER	ndim	No. of dimensions required for beam section shape.
	<Return Value>
Error Conditions:
1	Invalid shape name.

Example:

Please see blgetnumdimension (p. 810) in the MSC Acumen Toolkit - Code Example.


blgetnumplotpoints	(<shape>,<chord_tol>,<npoints>,<nloops>)


Description:
This function will get the number of total plot points and loops used to draw a given shape.
Input:
STRING	shape[]	Beam section shape.
REAL	chord_tol	Chordal tolerance for rod and tube.
Output:
INTEGER	npoints	Number of total plot points.
INTEGER	nloops	Number of loops.
INTEGER	<Return Value>	Returns 0 for success, othewise returns the error code.
Error Conditions:
1	Invalid shape name

Example:

Please see blgetnumplotpoints (p. 811) in the MSC Acumen Toolkit - Code Example.


blgetnumplotpointsbyid	(<bsid>,<chord_tol>,<npoints>,<nloops>)


Description:
This function will get the number of total plot points and loops used to draw a shape of beam section.
Input:
INTEGER	bsid	ID of beam section.
REAL	chord_tol	Chordal tolerance for rod and tube.
Output:
INTEGER	npoints	Number of total plot points.
INTEGER	nloops	Number of loops.
INTEGER	<Return Value>	Returns 0 for success, otherwise returns the error code.
Error Conditions:
1	Invalid shape name

Example:

Please see blgetnumplotpointsbyid (p. 812) in the MSC Acumen Toolkit - Code Example.


blgetnumtypeinfo	(<nsect>,<ndimax>)


Description:
This function will get the number of section types available in MSC.Patran and the maximum number of dimensions for any section.
Input:

Output:
INTEGER	nsect	Number of different section types.
INTEGER	ndimax	Maximum number of dimensions for any section.
INTEGER	<Return Value>	Returns 0 for success, otherwise returns the error code.
Error Conditions:
NONE

Example:

Please see blgetnumtypeinfo (p. 814) in the MSC Acumen Toolkit - Code Example.


blgetperim	(<shape>,<dim>,<perim>)


Description:
This function calculates the exterior perimeter of a beam section.
Input:
STRING	shape[]	Beam section shape.
REAL ARRAY	dim()	Array of dimensions of the section.
Output:
REAL	perim	Perimeter of the beam section.
INTEGER	<Return Value>	Returns 0 for success, otherwise returns the error code.
Error Conditions:
1	Invalid shape name

Example;

Please see blgetperim (p. 815) in the MSC Acumen Toolkit - Code Example.


blgetplotpoints	(<shape>,<dim>,<npoints>,<nloops>,<points>,<nploops>)


Description:
This function gets the coordinates of plot points and the number of plot points on each loop for given section shape.
Input:
STRING	shape[]	Beam section shape.
REAL ARRAY	dim()	Array of dimensions of the section.
INTEGER	npoints	Number of total plot points.
INTEGER	nloops	Number of loops.
Output:
REAL ARRAY	points()	Coordinates of plot points for the section.
INTEGER ARRAY	nploops()	Array of number of plot points on each loop.
INTEGER	<Return Value>	Returns 0 for success, otherwise returns the error code.
Error Conditions:
1	Invalid shape name, npoints or nloops

Example:

Please see blgetplotpoints (p. 816) in the MSC Acumen Toolkit - Code Example.


blgetplotpointsbyid	(<bsid>,<bmtype>,<enttype>,<entid>,<nparloc>,<nrmflg>, <npoints>,<nloops>,<points>,<nploop>,<vec1s>,<vec2s>,<xyz>)


Description:
This function gets the coordinates of plot points and the number of plot points on each loop for given beam section id, entity type, entity id and entity parametric location. This function calls blgetplotpointsbyid2, and hardwires the displaymode argument in blgetplotpointsbyid2 to 1 (flag to process offsets).
Input:
INTEGER	bsid	Beam section id stored in db or region id for Abaqus beams.
INTEGER	bmtype	Beam type 1 = Bar , 2 = Beam, 3 for aero bodies. For Abaqus beams: 1001 = Box section 1002 = Circular section 1003 = I section 1004 = L section 1005 = Pipe section 1006 = Rectangular section 1007 = Hex section 1008 = Trapazoidal section 1009 = Arbitrary section
INTEGER	enttype	Entity type, currently only type 124 is supported.
INTEGER	entid	Entity id
INTEGER	nparloc	Number of parametric locations.
REAL	parloc(nparloc)	One dimensional parametric location on entity.
INTEGER	nrmflg	If =1, normal is calculated.
INTEGER	npoints	Number of total plot points for one parametric location.
INTEGER	nloop	Number of loops for one parametric location.
Output:
REAL	points(npoints*nparloc,nparloc)	Coordinates of plot points for the section. One set of points per parametric location.
INTEGER	nploops(nloop)	Array of number of plot points on each loop for one parametric location.
REAL	vec1s(nparloc,3)	Array of nparloc axis 1 orientation vectors.
REAL	vec2s(nparloc,3)	Array of nparloc axis 2 orientation vectors.
REAL	xyz(nparloc*3)	Array of evaluated xyz coordinates at the input parametric locations.
INTEGER	<Return Value>	Returns 0 for success, otherwise returns the error code.
Error Conditions:
See the Status Message (Ch 11) for information on any error values returned by this function.

Example:

Please see blgetplotpointsbyid2 (p. 821) in the MSC Acumen Toolkit - Code Example.


blgetplotpointsbyid2	(<bsid>,<bmtype>,<enttype>,<entid>,<nparloc>,<nrmflg>, <npoints>,<nloops>,<displaymode>,<points>,<nploop>, <vec1s>,<vec2s>,<xyz>)


Description:
This function gets the coordinates of plot points and the number of plot points on each loop for given beam section id, entity type, entity id and entity parametric location.
Input:
INTEGER	bsid	Beam section id stored in db or region id for Abaqus beams.
INTEGER	bmtype	Beam type 1 = Bar , 2 = Beam, 3 for aero bodies. For Abaqus beams: 1001 = Box section 1002 = Circular section 1003 = I section 1004 = L section 1005 = Pipe section 1006 = Rectangular section 1007 = Hex section 1008 = Trapazoidal section 1009 = Arbitrary section
INTEGER	enttype	Entity type, currently only type 124 is supported.
INTEGER	entid	Entity id
INTEGER	nparloc	Number of parametric locations.
REAL	parloc(nparloc)	One dimensional parametric locations on entity.
INTEGER	nrmflg	If =1, calculates normals.
INTEGER	npoints	Number of total plot points for one parametric location.
INTEGER	nloops	Number of loops for one parametric location
INTEGER	displaymode	If beam type = 1 or 2, this flag is whether to process offsets. 0 = do not process 1 = process If beam type = 3 this flag is whether slender only, interference only, both or none should display. 0 = None 1 = Slender 2 = Interference 3 = All
Output:
REAL	points(npoints*nparloc,nparloc)	Coordinates of plot points for the section. One set of points perparametric location.
INTEGER	nploop(nloop)	Array of number of plot points on each loop for one parametric location.
REAL	vec1s(nparloc,3)	Array of nparloc axis 1 orientation vectors
REAL	vec2s(nparloc,3)	Array of nparloc axis 2 orientation vectors
REAL	xyz(nparloc*3)	Array of evaluated xyz coordinates at the input parametric locations
INTEGER	<Return Value>	Returns 0 for success, otherwise returns the error code.
Error Conditions:
See the Status Message (Ch 11) for information on any error values returned by this function.

Example:

Please see blgetplotpointsbyid2 (p. 332) in the MSC Acumen Toolkit - Function Descriptions.


blgetprop	(<enttyp>,<shape>,<dim>,<ndim>,<prop>,<nprop>)


Description:
This function will get the all properties of beam section.
Input:
INTEGER	enttyp	Beam type (1 = Basic(Bar), 2 = Advanced(Beam))
STRING	shape[]	Beam section shape. See beam_section_create for valid beam sections.
REAL	dim(ndim)	Array of dimensions of the section.
INTEGER	ndim	Number of dimensions.
Output:
REAL	prop()	Properties of the beam section.
INTEGER	nprop	Number of properties
INTEGER	<Return Value>	Returns 0 for success, otherwise returns the error code.
Error Conditions:
See the Status Message(Ch 11) for information on any error values returned by this function.

Example:

Please see blgetprop (p. 825) in the MSC Acumen Toolkit - Code Example.


blgetproplabels	(<enttyp>,<cdo>)


Description:
This function will get the propery labels for given beam entity type.
Input:
INTEGER	enttyp	Beam type (1 = Basic(Bar), 2 = Advanced(Beam))
Output:
STRING	cdo[]()	Array of property label strings.
INTEGER	<Return Value>	Returns 0 for success, otherwise returns the error code.
Error Conditions:
1	Invalid Entity type.

Example:

Please see blgetproplabels (p. 826) in the MSC Acumen Toolkit - Code Example.


blgettypeinfo	(<entype>,<shapes>,<ndims>,<nconsts>)


Description:
This function will get the beam shape name, number of dimensions for each beam shape and the number of dimensional constraints for each beam shape available in the MSC.Patran library.
Input:
INTEGER	entype	Beam type(1=Basic(Bar), 2=Advanced(Beam))
Output:
STRING	shapes[]	Array of shape names
INTEGER	ndims[]	Array of the number of dimensions for each shape
INTEGER	nconsts[]	Array of the number of dimensional constraints
INTEGER	<Return Value>	Returns 0 for success, otherwise returns the error code.
Error Conditions:
1	Invalid entype

Example:

Please see blgettypeinfo (p. 827) in the MSC Acumen Toolkit - Code Example.


blmodifybeamdimension	(<bsid>,<dimid>,<value>,<fid>)


Description:
This function will modify the beam section dimension.
Input:
INTEGER	bsid	ID of beam section.
INTEGER	dimid	Dimension location.
REAL	value	New dimension value.
INTEGER	fid	Field id.
Output:
INTEGER	<Return Value>	Returns 0 for success, otherwise returns the error code.
Error Conditions:
See the Status Message(Ch 11) for information on any error values returned by this function.

Example:

Please see blmodifybeamdimension (p. 828) in the MSC Acumen Toolkit - Code Example.


db_create_selected_etype	(atid, acid, geopcd, copcd, fopcd, lopcd, etopid, dofsetid, mlcd, mdcd, etypid)


Description:
Create a selected element type entry in the database.
Input:
INTEGER	atid	The ID of the analysis type associated to the selected element type.
INTEGER	acid	The ID of the analysis code associated to the selected element type.
INTEGER	geopcd	The ID of the geometric option code associated with the selected element type.
INTEGER	copcd	The ID of the condense option code associated with the selected element type.
INTEGER	fopcd	The ID of the formulation option code associated with the selected element type.
INTEGER	lopcd	The ID of the laminate option code associated with the selected element type.
INTEGER	etopid	The ID of the element topology associated with the selected element type.
INTEGER	dofsetid	The ID of the degree of freedom associated with the selected element type.
INTEGER	mlcd	The ID of the material linearity code associated with the selected element type.
INTEGER	mdcd	The ID of the material directionality code associated with the selected element type.
INTEGER	etypid	The ID of the element type associated with the selected element type.
Output:
INTEGER	<Return Value>	Integer indicating success or failure of the routine. If the routine failed, this value contains an indication of the reason.
Error Conditions:
13000002	Unrecoverable database error.
External Dependencies and Side Effects:
Creates one record in the “selected_element_type” relation in the database. Verifies all input fields in their respective tables to verify their existence in the database before creating the entry.

Example:

Please see db_create_selected_etype (p. 859) in the MSC Acumen Toolkit - Code Example.


db_count_elem_type	(acid, atid, etcnt)


Description:
This function will return a count of the number of distinct element types for each element dimensionality for a specified analysis code and type.
Input:
INTEGER	acid	This value specifies the analysis code id.
INTEGER	atid	This value specifies the analysis type id.
Output:
INTEGER	etcnt(4)	This value returns the count of element types, one for each element dimensionality.
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 db_count_elem_type (p. 848) in the MSC Acumen Toolkit - Code Example.


db_count_etop_for_a_code	( acid, atid, count )


Description:
This function will return a count of element types for all element topologies for a specific analysis code and type.
Input:
INTEGER	acid	This value specifies the analysis code id.
INTEGER	atid	This value specifies the analysis type id.
Output:
INTEGER	count	This value returns the count of element types for all element topologies.
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:
13000002	Unrecoverable database error.
13000007	An unspecified database error occurred.

Example:

Please see db_count_etop_for_a_code (p. 851) in the MSC Acumen Toolkit - Code Example.


db_get_all_dof_set_names	( )


Description:
Sets db_get_next_dof_set_names to start at the beginning of a list of dof_set code names and ids from the database.
Input:
None.
Output:
INTEGER	<Return Value>	Integer indicating success or failure of the routine. If the routine failed, this value contains an indication of the reason.
Error Conditions:
13000002	Unrecoverable database error.
13000007	The query specified has completed.
13000117	An unspecified database error occurred.
External Dependencies and Side Effects:
Accesses all records in the “dof_set” table in the database.

Example:

See example for db_get_all_cond_opt_code_names, 426. See also db_get_all_dof_set_names (p. 868) in the MSC Acumen Toolkit - Code Example.


db_get_next_dof_set_names	( name, id )


Description:
Gets the next dof_set code names and id from the database.
Input:
None.
Output:
STRING	name[31]	The name retrieved from the database.
INTEGER	id	Id corresponding to the name retrieved.
INTEGER	<Return Value>	Integer indicating success or failure of the routine. If the routine failed, this value contains an indication of the reason.
Error Conditions:
13000002	Unrecoverable database error.
13000007	The query specified has completed.
13000117	An unspecified database error occurred.
External Dependencies and Side Effects:
Accesses all records in the “dof_set” table in the database.

Example:

See example for db_get_all_cond_opt_code_names, 426. See also db_get_next_dof_set_names (p. 885) in the MSC Acumen Toolkit - Code Example.


db_get_all_form_opt_code_names	( )


Description:
Gets the next dof_set code names and id from the database.
Input:
None.
Output:
INTEGER	<Return Value>	Integer indicating success or failure of the routine. If the routine failed, this value contains an indication of the reason.
Error Conditions:
13000002	Unrecoverable database error.
13000007	The query specified has completed.
13000117	An unspecified database error occurred.
External Dependencies and Side Effects:
Accesses all records in the “formulation_option” table in the database.

Example:

See example for db_get_all_cond_opt_code_names, 426. See also db_get_all_form_opt_code_names (p. 870) in the MSC Acumen Toolkit - Code Example.


db_get_next_form_opt_code_names	( name, id )


Description:
Gets the next formulation option code name from the database.
Input:
None.
Output:
STRING	name[31]	The name retrieved from the database.
INTEGER	id	The ID retrieved from the database.
INTEGER	<Return Value>	Integer indicating success or failure of the routine. If the routine failed, this value contains an indication of the reason.
Error Conditions:
13000002	Unrecoverable database error.
13000007	The query specified has completed.
13000117	An unspecified database error occurred.
External Dependencies and Side Effects:
Accesses all records in the “formulation_option” table in the database.

Example:

See example for db_get_all_cond_opt_code_names, 426. See also db_get_next_form_opt_code_names (p. 887) in the MSC Acumen Toolkit - Code Example.


db_get_all_geo_opt_code_names	( )


Description:
Sets the db_get_next_geo_opt_code_names to start at the beginning of a list of geometric option code names.
Input:
None.
Output:
INTEGER	<Return Value>	Integer indicating success or failure of the routine. If the routine failed, this value contains an indication of the reason.
Error Conditions:
13000002	Unrecoverable database error.
13000007	The query specified has completed.
13000117	An unspecified database error occurred.
External Dependencies and Side Effects:
Accesses all records in the “geometric_option” table in the database.

Example:

See example for db_get_all_cond_opt_code_names, 426. See also db_get_all_geo_opt_code_names (p. 871) in the MSC Acumen Toolkit - Code Example.


db_get_next_geo_opt_code_names	( name, id )


Description:
Gets the next formulation option code name from the database.
Input:
None.
Output:
STRING	name[31]	The name retrieved from the database.
INTEGER	id	The ID retrieved from the database.
INTEGER	<Return Value>	Integer indicating success or failure of the routine. If the routine failed, this value contains an indication of the reason.
Error Conditions:
13000002	Unrecoverable database error.
13000007	The query specified has completed.
13000117	An unspecified database error occurred.
External Dependencies and Side Effects:
Accesses all records in the “geometric_option” table in the database.

Example:

See example for db_get_all_cond_opt_code_names, 426. See also db_get_next_geo_opt_code_names (p. 888) in the MSC Acumen Toolkit - Code Example.


db_get_all_lam_opt_code_names	( )


Description:
Set db_get_next_lam_opt_code_names to start at the beginning of a list of laminate_option code names from the database.
Input:
None.
Output:
INTEGER	<Return Value>	Integer indicating success or failure of the routine. If the routine failed, this value contains an indication of the reason.
Error Conditions:
13000002	Unrecoverable database error.
13000007	The query specified has completed.
13000117	An unspecified database error occurred.
External Dependencies and Side Effects:
Accesses all records in the “laminate_option” table in the database.

Example:

See example for db_get_all_cond_opt_code_names, 426. See also db_get_all_lam_opt_code_names (p. 872) in the MSC Acumen Toolkit - Code Example.


db_get_next_lam_opt_code_names	( name, id )


Description:
Gets all laminate_option code names from the database, in get all, get next method.
Input:
None.
Output:
STRING	name[31]	The name retrieved from the database.
INTEGER	id	The ID retrieved from the database.
INTEGER	<Return Value>	Integer indicating success or failure of the routine. If the routine failed, this value contains an indication of the reason.
Error Conditions:
13000002	Unrecoverable database error.
13000007	The query specified has completed.
13000117	An unspecified database error occurred.
External Dependencies and Side Effects:
Accesses all records in the “laminate_option” table in the database.

Example:

See example for db_get_all_cond_opt_code_names, 426. See also db_get_next_lam_opt_code_names (p. 889) in the MSC Acumen Toolkit - Code Example.


db_get_region_for_geometry	( entity_type, entity_id, rid )


Description:
Returns the region id for the given entity type and entity id.
Input:
INTEGER	entity_type	The entity type.
INTEGER	entity_id	The entity ID.
Output:
INTEGER	rid	The region ID.
INTEGER	<Return Value>	Returns the success or failure of the routine.
External Dependencies and Side Effects:
This routine access the geometric_region_list table in the database.

Example:

Please see db_get_region_for_geometry (p. 893) in the MSC Acumen Toolkit - Code Example.


db_get_region_ids_and_names	( count, rid, name )


Description:
Gets all region ids from the database.
Input:
INTEGER	count	The number of region IDs for which storage has been allocated by the calling routine.
Output:
INTEGER	rid(count)	The region IDs.
STRING	name[31](count)	The region names.
INTEGER	<Return Value>	Returns the success or failure of the routine.
External Dependencies and Side Effects:
This routine accesses the phys_prop_region table in the database.

Example:

Please see db_get_region_ids_and_names (p. 894) in the MSC Acumen Toolkit - Code Example.


db_get_elements_in_region_exp	( count, rid, eid )


Description:
Gets all element ids for a specified region id from the database.
Input:
INTEGER	count	The number of region IDs for which storage has been allocated by the calling routine.
INTEGER	rid	The region ID for which the list of element IDs is requested.
Output:
INTEGER	eid()	The element IDs for the region.
INTEGER	<Return Value>	Integer indicating success or failure of the routine. If the routine failed, this value contains an indication of the reason.
Error Conditions:
13000002	Unrecoverable database error.
External Dependencies and Side Effects:
Accesses specified records in the “element_in__region” table.

Example:

Please see db_get_elements_in_region_exp (p. 880) in the MSC Acumen Toolkit - Code Example.


db_get_etop_for_a_code	( acid, atid, count, etids )


Description:
Retrieves a set of element_topology_ids based on analysis code id and analysis type id.
Input:
INTEGER	acid	The analysis code ID.
INTEGER	atid	The analysis type ID.
INTEGER	count	The count of element types, one for each element dimensionality.
Output:
INTEGER	etids()	The list of element type IDs retrieved.
INTEGER	<Return Value>	Returns the success or failure of the routine.
Error Conditions:
13000002	Unrecoverable database error.
13000007	An unspecified database error occurred.
External Dependencies and Side Effects:
Retrieves analysis_elements relationships.

Example:

See example for db_count_etop_for_a_code, 337. See also db_get_etop_for_a_code (p. 882) in the MSC Acumen Toolkit - Code Example.


db_get_a_phys_prop_w_nord	( acid, ppid, defid, alias, rflag, atypes, dtype, nord, aival, arval, acval )


Description:
Creates an allowable physical property entry in the database.
Input:
INTEGER	acid	The ID of the analysis code for which this physical property is to be allowed.
INTEGER	ppid	The ID of the physical property to be allowed.
INTEGER	defid	The ID of the physical property member set defn allowed.
Output:
STRING	alias[]	The alias to be used for this physical property from this analysis code.
INTEGER	rflag	Flag indicating whether or not this property is required.
INTEGER	atypes(10)	Allowable types for this physical property.
INTEGER	dtype	Default type for this physical prop.
INTEGER	nord	Neutral file order for this physical property from phys_prop_set_mbr_defn.
STRING	aival[]	PCL function to be used to validate integer values.
STRING	arval[]	PCL function to be used to validate real values.
STRING	acval[]	PCL function to be used to validate character values.
INTEGER	<Return Value>	Integer indicating success or failure of the routine. If the routine failed, this value contains an indication of the reason.
Error Conditions:
13000002	Unrecoverable database error.
13000004	Duplicate entry exists in table.
13000007	An unspecified database error occurred.
External Dependencies and Side Effects:
Creates one record in the “allowable_phys_prop” table in the database.

Example:

Please see db_get_a_phys_prop_w_nord (p. 866) in the MSC Acumen Toolkit - Code Example.


db_create_phys_prop_set_defn	( id, name, num, ppids )


Description:
Creates a physical property set entry in the database.
Input:
INTEGER	id	The ID of the physical property set to be created.
STRING	name[]	The name of the physical property set to be created.
INTEGER	num	The number of physical properties to be associated with this set.
INTEGER	ppids()	The IDs of the physical properties to be associated with this set defn.
Output:
INTEGER	<Return Value>	Integer indicating success or failure of the routine. If the routine failed, this value contains an indication of the reason.
Error Conditions:
13000002	Unrecoverable database error.
13000004	Duplicate entry exists in table.
13000007	An unspecified database error occurred.
External Dependencies and Side Effects:
Creates one record in the “phys_prop_set_defn” table in the database.

Example:

Please see db_create_phys_prop_set_defn (p. 857) in the MSC Acumen Toolkit - Code Example.


db_get_phys_prop_set_defn	( id, name, num, ppids )


Description:
Get physical property definition from the database.
Input:
INTEGER	id	The set ID for which the physical property IDs are requested.
Output:
STRING	name[]	The name of the physical property set.
INTEGER	num	The number of physical property values associated with this set.
INTEGER	ppids()	The IDs of the physical property values associated with this set.
INTEGER	<Return Value>	Integer indicating success or failure of the routine. If the routine failed, this value contains an indication of the reason.
Error Conditions:
13000002	Unrecoverable database error.
External Dependencies and Side Effects:
Specified.

Example:

See example for db_get_allowable_phys_prop, 347. See also db_get_phys_prop_set_defn (p. 892) in the MSC Acumen Toolkit - Code Example.


db_get_allowable_phys_prop	( acid, ppid, alias, rflag, atypes, dtype, nord, aival, arval, acval )


Description:
Creates an allowable physical property entry in the database.
Input:
INTEGER	acid	The ID of the analysis code for which this physical property is to be allowed.
INTEGER	ppid	The ID of the physical property to be allowed.
Output:
STRING	alias[]	The alias to be used for this physical property from this analysis code.
INTEGER	rflag	Flag indicating whether or not this property is required.
INTEGER	atypes(10)	Allowable types for this physical property.
INTEGER	dtype	Default type for this physical prop.
INTEGER	nord	Neutral file order for this physical property.
STRING	aival[]	PCL function to be used to validate integer values.
STRING	arval[]	PCL function to be used to validate real values.
STRING	acval[]	PCL function to be used to validate character values.
INTEGER	<Return Value>	Integer indicating success or failure of the routine. If the routine failed, this value contains an indication of the reason.
Error Conditions:
13000002	Unrecoverable database error.
13000004	Duplicate entry exists in table.
13000007	An unspecified database error occurred.
External Dependencies and Side Effects:
Creates one record in the “allowable_phys_prop” table in the database.

Example:

Please see db_get_allowable_phys_prop (p. 875) in the MSC Acumen Toolkit - Code Example.


db_get_selected_prop_set	( atid, acid, geopcd, copcd, fopcd, lopcd, etopid, dofsetid, physprop )


Description:
Gets a field in the database.
Input:
INTEGER	atid	The ID of the analysis type associated to the selected property set.
INTEGER	acid	The ID of the analysis code associated to the selected property set.
INTEGER	geopcd	The ID of the geometric option code associated with the selected property set.
INTEGER	copcd	The ID of the condense option code associated with the selected property set.
INTEGER	fopcd	The ID of the formulation option code associated with the selected property set.
INTEGER	lopcd	The ID of the laminate option code associated with the selected property set.
INTEGER	etopid	The ID of the element topology associated with the selected property set.
INTEGER	dofsetid	The ID of the physical property to be allowed.
Output:
STRING	physprop	The ID of the associated physical property set.
INTEGER	<Return Value>	Integer indicating success or failure of the routine. If the routine failed, this value contains an indication of the reason.
Error Conditions:
13000002	Unrecoverable database error.
External Dependencies and Side Effects:
Gets a record in the “selected_property_set” table.

Example:

See example for db_bulk_get_selected_etops_mat, 363. See also db_get_selected_prop_set (p. 895) in the MSC Acumen Toolkit - Code Example.


db_delete_phys_prop_region	( prop_reg_id )


Description:
This function will delete a physical property region from the database.
Input:
INTEGER	prop_reg_id	This value specifies the physical property region id.
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:
13000002	Unrecoverable database error.
13000125	The property entered does not exist.
13000007	An unspecified database error occurred.
External Dependencies and Side Effects:
Deletes one record in the “phys_prop_region”, and any record associated to the specified physical property in the “element_in_region” or “geometric_region_list” relations in the database.

Example:

Please see db_delete_phys_prop_region (p. 864) in the MSC Acumen Toolkit - Code Example.


db_associate_geo_to_region	( gid, gtype, gsid, rid )


Description:
Associates a specified region to a geometric entity in the database.
Input:
INTEGER	gid	The internal ID for the geometric entity to associate with the region.
INTEGER	gtype	The type of geometric entity to which the region is being associated.
INTEGER	gsid	The internal sub_id for the geometric entity to associate with the region.
INTEGER	rid	The internal ID of the region being associated to the geometric entity.
Output:
INTEGER	<Return Value>	Integer indicating success or failure of the routine. If the routine failed, this value contains an indication of the reason.
Error Conditions:
13000002	Unrecoverable database error.
13000004	Duplicate entry exists in table.
13000007	An unspecified database error occurred.
External Dependencies and Side Effects:
Creates one record associating a region to a geometric entity in the database for the region id passed to the routine.

Example:

Please see db_associate_geo_to_region (p. 830) in the MSC Acumen Toolkit - Code Example.


db_count_geo_in_region	( rid, count )


Description:
Retrieves the count of entities associated with a physical property region in the database.
Input:
INTEGER	rid	The physical property region ID for which information is requested.
Output:
INTEGER	count	The number of entities for the specified physical property region.
INTEGER	<Return Value>	Returns the success or failure of the routine.
Error Conditions:
13000002	Unrecoverable database error.
13000007	An unspecified database error occurred.
External Dependencies and Side Effects:
Counts all entities in the “phys_prop_region” relation in the database for a specified region id.

Example:

Please see db_count_geo_in_region (p. 852) in the MSC Acumen Toolkit - Code Example.


db_get_geo_in_region	( count, rid, gid, gtype, gsid )


Description:
Gets all geometric entities for a physical property region from the database.
Input:
INTEGER	count	The number of region IDs for which storage has been allocated by the calling routine.
INTEGER	rid	The physical property region for which the geometric entities are requested.
Output:
INTEGER	gid()	The IDs of the geometric entities associated with the specified physical property region.
INTEGER	gtype()	The type of the geometric entities associated with the specified physical property region.
INTEGER	gsid()	The sub-IDs of the geometric entities associated with the specified physical property region.
INTEGER	<Return Value>	Integer indicating success or failure of the routine. If the routine failed, this value contains an indication of the reason.
Error Conditions:
13000002	Unrecoverable database error.
External Dependencies and Side Effects:
Accesses records in the “geometric_region_list” relation by the physical property region id specified.

Example:

Please see db_get_geo_in_region (p. 883) in the MSC Acumen Toolkit - Code Example.


db_count_elements_in_region_exp	( rid, count )


Description:
Retrieves the number of elements in a specified region in the database.
Input:
INTEGER	rid	The region ID for which the element count is requested.
Output:
INTEGER	count	The number of physical_property_region items stored in the database.
INTEGER	<Return Value>	Returns the success or failure of the routine.
Error Conditions:
13000002	Unrecoverable database error.
13000007	An unspecified database error occurred.
External Dependencies and Side Effects:
Counts records in the “element_in_region” relation in the database for one specified region.

Example:

Please see db_count_elements_in_region_exp (p. 849) in the MSC Acumen Toolkit - Code Example.


db_create_anl_elm_summary	( acid, atid, etcnt )


Description:
Stores an analysis_element_summary relationship.
Input:
INTEGER	acid	The analysis code ID.
INTEGER	atid	The analysis type ID.
INTEGER	etcnt(4)	The count of element types, one for each element dimensionality.
Output:
INTEGER	<Return Value>	Returns the success or failure of the routine.
Error Conditions:
13000002	Unrecoverable database error.
13000007	An unspecified database error occurred.
External Dependencies and Side Effects:
Uses the analysis_element_summary relationship.

Example:

Please see db_create_anl_elm_summary (p. 856) in the MSC Acumen Toolkit - Code Example.


db_get_anl_elm_summary	( acid, atid, etcnt )


Description:
Retrieves an analysis_element_summary relationship
Input:
INTEGER	acid	The analysis code ID.
INTEGER	atid	The analysis type ID.
Output:
INTEGER	etcnt(4)	The count of element types, one for each element dimensionality.
INTEGER	<Return Value>	Returns the success or failure of the routine.
Error Conditions:
13000002	Unrecoverable database error.
13000007	An unspecified database error occurred.
External Dependencies and Side Effects:
Uses the analysis_element_summary relationship.

Example:

See example for db_create_anl_elm_summary, 352. See also db_get_anl_elm_summary (p. 878) in the MSC Acumen Toolkit - Code Example.


db_delete_anl_elm_summary	( acid, atid, etcnt )


Description:
Removes an analysis_element_summary relationship.
Input:
INTEGER	acid	The analysis code ID.
INTEGER	atid	The analysis type ID.
Output:
INTEGER	<Return Value>	Returns the success or failure of the routine.
Error Conditions:
13000002	Unrecoverable database error.
13000007	An unspecified database error occurred.
External Dependencies and Side Effects:
Deletes a analysis_element_summary relationship.

Example:

See example for db_create_anl_elm_summary, 352. See also db_delete_anl_elm_summary (p. 863) in the MSC Acumen Toolkit - Code Example.


db_create_analysis_elements	( acid, atid, etcnt, etids, etnames )


Description:
Stores a set of analysis_elements relationships.
Input:
INTEGER	acid	The analysis code ID.
INTEGER	atid	The analysis type ID.
INTEGER	etcnt	The count of element types to store.
INTEGER	etids()	The element type IDs to store.
STRING	etnames[]()	The element type names to go with the corresponding ID.
Output:
INTEGER	<Return Value>	Returns the success or failure of the routine.
Error Conditions:
13000002	Unrecoverable database error.
13000007	An unspecified database error occurred.
External Dependencies and Side Effects:
Set analysis_elements relationships. Note that the etnames values are actually a denormalized form of the element_type_name field in the element_type relationship, placed in the analysis_elements relationship for speed.

Example:

See example for db_create_anl_elm_summary, 352. See also db_create_analysis_elements (p. 853) in the MSC Acumen Toolkit - Code Example.


db_delete_analysis_elements	( acid, atid, etcnt, etids )


Description:
Removes a set of analysis_elements relationships.
Input:
INTEGER	acid	The analysis code ID.
INTEGER	atid	The analysis type ID.
INTEGER	etcnt	The count of element types to delete.
INTEGER	etids()	The element type IDs to delete.
Output:
INTEGER	<Return Value>	Returns the success or failure of the routine.
Error Conditions:
13000002	Unrecoverable database error.
13000007	An unspecified database error occurred.
External Dependencies and Side Effects:
Removes analysis_elements relationships.

Example:

See example for db_create_anl_elm_summary, 352. See also db_delete_analysis_elements (p. 861) in the MSC Acumen Toolkit - Code Example.


db_get_analysis_elements	( acid, atid, etcntMax, etcntFound, etids, etnames )


Description:
Retrieves a set of analysis_elements relationships.
Input:
INTEGER	acid	The analysis code ID.
INTEGER	atid	The analysis type ID.
INTEGER	etcntMax	The size that the receiving arrays are dimensioned for.
Output:
INTEGER	etcntFound	The number of element type IDs and element type names found. Only the first etcntMax values will actually be returned.
INTEGER	etids()	The element type IDs retrieved.
STRING	etnames[]()	The element type names related to the corresponding IDs.
INTEGER	<Return Value>	Returns the success or failure of the routine.
Error Conditions:
13000002	Unrecoverable database error.
13000007	An unspecified database error occurred.
External Dependencies and Side Effects:
Retrieves analysis_elements relationships. Note that the etnames values are actually a denormalized form of the element_type_name field in the element_type relationship, placed in the analysis_elements relationship for speed.

Example:

See example for db_create_anl_elm_summary, 352. See also db_get_analysis_elements (p. 876) in the MSC Acumen Toolkit - Code Example.


db_get_all_elem_defn	( acid, atid, eldim )


Description:
Gets all the definitions for all requested elements in get all, get next method.
Input:
INTEGER	acid	The analysis code ID for the requested element definition.
INTEGER	atid	The analysis type ID for the requested element definition.
INTEGER	eldim	The dimensionality for the requested element definition.
Output:
INTEGER	<Return Value>	Integer indicating success or failure of the routine. If the routine failed, this value contains an indication of the reason.
Error Conditions:
13000002	Unrecoverable database error.
13000007	An unspecified database error occurred.
13000117	The query specified has completed.
External Dependencies and Side Effects:
Accesses the “selected_element_type” and “element_type” table in the database.

Example:

See example for db_create_anl_elm_summary, 352. See also db_get_all_elem_defn (p. 869) in the MSC Acumen Toolkit - Code Example.


db_get_next_elem_defn	( etype_id, ename )


Description:
Gets all the definitions for all requested elements in get all, get next method.
Input:
None.
Output:
INTEGER	etype_id	The ID of the next element type.
STRING	ename[31]	The name of the next element type.
INTEGER	<Return Value>	Integer indicating success or failure of the routine. If the routine failed, this value contains an indication of the reason.
Error Conditions:
13000002	Unrecoverable database error.
13000007	An unspecified database error occurred.
13000117	The query specified has completed.
External Dependencies and Side Effects:
Accesses the “selected_element_type” and “element_type” table in the database.

Example:

See example for db_create_anl_elm_summary, 352. See also db_get_next_elem_defn (p. 886) in the MSC Acumen Toolkit - Code Example.


db_bulk_get_possible_dof_sets2	( etid, atid, acid, coc, goc, foc, loc, nbr, dsid )


Description:
This function will retrieve all possible values of the degrees of freedom sets for the specified input options.
Input:
INTEGER	etid	This value specifies the id value of the element type.
INTEGER	atid	This value specifies the id value of the analysis type.
INTEGER	acid	This value specifies the id value of the analysis code.
INTEGER	coc	This value specifies the id value of the condense option code.
INTEGER	goc	This value specifies the id value of the geometric option code.
INTEGER	foc	This value specifies the id value of the formulation option code.
INTEGER	loc	This value specifies the id value of the lamination option code.
Output:
INTEGER	nbr	This value returns the number of degrees of freedom set id values returned in the output value dsid.
INTEGER	dsid(nbr)	This value returns the unique degrees of freedom set id values.
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:
13000002	Unrecoverable database error.
13000007	An unspecified database error occurred.
External Dependencies and Side Effects:
Fetches all dof set ids for the input set of parameters.

Example:

Please see db_bulk_get_possible_dof_sets2 (p. 833) in the MSC Acumen Toolkit - Code Example.


db_bulk_get_possible_lam_opts2	( etid, atid, acid, goc, coc, nbr, loc )


Description:
Retrieves all possible values of the laminate option for the specified input options.
Input:
INTEGER	etid	The ID of the element type selected by the user.
INTEGER	atid	The ID of the analysis type currently selected.
INTEGER	acid	The ID of the analysis code currently selected.
INTEGER	goc	The ID of the geometric option code selected.
INTEGER	coc	The ID of the condense option code selected.
Output:
INTEGER	nbr	The number of laminate option codes that were found for the above specified set of parameters.
INTEGER	loc()	The unique laminate option code values that were found for the above specified set of values.
INTEGER	<Return Value>	Returns the success or failure of the routine.
Error Conditions:
13000002	Unrecoverable database error.
13000007	An unspecified database error occurred.
External Dependencies and Side Effects:
Fetches all laminate option codes for the input set of parameters.

Example:

See example for db_bulk_get_possible_dof_sets2, 358. See also db_bulk_get_possible_lam_opts2 (p. 840) in the MSC Acumen Toolkit - Code Example.


db_bulk_get_possible_form_opts2	( etid, atid, acid, goc, coc, loc, nbr, foc )


Description:
Retrieves all possible values of the formulation option for the specified input options.
Input:
INTEGER	etid	The ID of the element type selected by the user.
INTEGER	atid	The ID of the analysis type currently selected.
INTEGER	acid	The ID of the analysis code currently selected.
INTEGER	goc	The ID of the geometric option code selected.
INTEGER	coc	The ID of the condense option code selected.
INTEGER	loc	The ID of the location option code selected.
Output:
INTEGER	nbr	The number of formulation option codes found for the above specified set of parameters.
INTEGER	foc()	The unique formulation option code values that were found for the above specified set of values.
INTEGER	<Return Value>	Returns the success or failure of the routine.
Error Conditions:
13000002	Unrecoverable database error.
13000007	An unspecified database error occurred.
External Dependencies and Side Effects:
Fetches all formulation option codes for the input set of parameters.

Example:

See example for db_bulk_get_possible_dof_sets2, 358. See also db_bulk_get_possible_form_opts2 (p. 836) in the MSC Acumen Toolkit - Code Example.


db_bulk_get_possible_dof_sets1	( etid, atid, acid, nbr, dsid )


Description:
This function will retrieve all possible values of the degrees of freedom sets for the specified input options.
Input:
INTEGER	etid	This value specifies the id value of the element type.
INTEGER	atid	This value specifies the id value of the analysis type.
INTEGER	acid	This value specifies the id value of the analysis code.
Output:
INTEGER	nbr	This value returns the number of degrees of freedom set id values returned in the output value dsid.
INTEGER	dsid(nbr)	This value returns the unique degrees of freedom set id values.
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:
13000002	Unrecoverable database error.
13000007	An unspecified database error occurred.
External Dependencies and Side Effects:
Fetches all dof set ids for the input set of parameters.

Example:

Please see db_bulk_get_possible_dof_sets1 (p. 832) in the MSC Acumen Toolkit - Code Example.


db_bulk_get_possible_lam_opts1	( etid, atid, acid, nbr, loc )


Description:
Retrieves all possible values of the laminate option for the specified input options.
Input:
INTEGER	etid	The ID of the element type selected by the user.
INTEGER	atid	The ID of the analysis type currently selected.
INTEGER	acid	The ID of the analysis code currently selected.
Output:
INTEGER	nbr	The number of laminate option codes that were found for the above specified set of parameters.
INTEGER	loc()	The unique laminate option code values that were found for the above specified set of values.
INTEGER	<Return Value>	Returns the success or failure of the routine.
Error Conditions:
13000002	Unrecoverable database error.
13000007	An unspecified database error occurred.
External Dependencies and Side Effects:
Fetches all laminate option codes for the input set of parameters.

Example:

See example for db_bulk_get_possible_dof_sets1, 360. See also db_bulk_get_possible_lam_opts1 (p. 839) in the MSC Acumen Toolkit - Code Example.


db_bulk_get_possible_geo_opts1	( etid, atid, acid, nbr, goc )


Description:
Retrieves all possible values of the geometric option for the specified input options.
Input:
INTEGER	etid	The ID of the element type selected by the user.
INTEGER	atid	The ID of the analysis type currently selected.
INTEGER	acid	The ID of the analysis code currently selected.
Output:
INTEGER	nbr	The number of geometric option codes that were found for the above specified set of parameters.
INTEGER	goc()	The unique geometric option code values that were found for the above specified set of values.
INTEGER	<Return Value>	Returns the success or failure of the routine.
Error Conditions:
13000002	Unrecoverable database error.
13000007	An unspecified database error occurred.
External Dependencies and Side Effects:
Fetches all geometric option codes for the input set of parameters.

Example:

See example for db_bulk_get_possible_dof_sets1, 360. Please see db_bulk_get_possible_geo_opts1 (p. 838) in the MSC Acumen Toolkit - Code Example.


db_bulk_get_possible_form_opts1	( etid, atid, acid, nbr, foc )


Description:
Retrieves all possible values of the formulation option for the specified input options.
Input:
INTEGER	etid	The ID of the element type selected by the user.
INTEGER	atid	The ID of the analysis type currently selected.
INTEGER	acid	The ID of the analysis code currently selected.
Output:
INTEGER	nbr	The number of formulation option codes found for the above specified set of parameters.
INTEGER	foc()	The unique formulation option code values that were found for the above specified set of values.
INTEGER	<Return Value>	Returns the success or failure of the routine.
Error Conditions:
13000002	Unrecoverable database error.
13000007	An unspecified database error occurred.
External Dependencies and Side Effects:
Fetches all formulation option codes for the input set of parameters.

Example:

See example for db_bulk_get_possible_dof_sets1, 360. See alsodb_bulk_get_possible_form_opts1 (p. 835) in the MSC Acumen Toolkit - Code Example.


db_bulk_get_selected_etops_mat	( etid, atid, acid, goc, foc, loc, dsid, coc, nbr, etop )


Description:
Retrieves all possible values of element topology for the specified input options. All values must be input for this select.
Input:
INTEGER	etid	The ID of the element type selected by the user.
INTEGER	atid	The ID of the analysis type currently selected.
INTEGER	acid	The ID of the analysis code currently selected.
INTEGER	goc	The code for the geometric option if it has been uniquely determined at point. otherwise, zero.
INTEGER	foc	The code for the formulation option if it has been uniquely determined at point. otherwise, zero.
INTEGER	loc	The code for the laminate option if it has been uniquely determined at point. otherwise, zero.
INTEGER	dsid	The ID for the dof set if it has been uniquely determined at point. otherwise, zero.
Output:
INTEGER	nbr	The number of formulation option codes found for the above specified set of parameters.
INTEGER	etop()	The unique element topology values that were found for the above specified set of values.
INTEGER	<Return Value>	Returns the success or failure of the routine.
Error Conditions:
13000002	Unrecoverable database error.
13000007	An unspecified database error occurred.
External Dependencies and Side Effects:
Fetches all element topologies for the input set of parameters.

Example:

Please see db_bulk_get_selected_etops_mat (p. 846) in the MSC Acumen Toolkit - Code Example.


db_bulk_get_possible_matl_dirs	( etid, atid, acid, goc, foc, loc, dsid, coc, mlc, nbr, mdc )


Description:
Retrieves all possible values of the material directionality option for the specified input options. If an input option is 0, it does not have a uniquely assigned value yet. The first three parameters may not be zero.
Input:
INTEGER	etid	The ID of the element type selected by the user.
INTEGER	atid	The ID of the analysis type currently selected.
INTEGER	acid	The ID of the analysis code currently selected.
INTEGER	goc	The code for the geometric option if it has been uniquely determined at point. otherwise, zero.
INTEGER	foc	The code for the formulation option if it has been uniquely determined at point. otherwise, zero.
INTEGER	loc	The code for the laminate option if it has been uniquely determined at point. otherwise, zero.
INTEGER	dsid	The ID for the dof set if it has been uniquely determined at point. otherwise, zero.
INTEGER	coc	The ID for the condense option if it has been uniquely determined at point. otherwise, zero.
INTEGER	mlc	The code for the material linearity if it has been uniquely determined at point. otherwise, zero.
Output:
INTEGER	nbr	The number of material directionality codes that were found for the above specified set of parameters.
INTEGER	mdc()	The unique material directionality code value that were found for the above specified set of values.
INTEGER	<Return Value>	Returns the success or failure of the routine.
Error Conditions:
13000002	Unrecoverable database error.
13000007	An unspecified database error occurred.
External Dependencies and Side Effects:
Fetches all material directionality codes for the input set of parameters.

Example:

Please see db_bulk_get_possible_matl_dirs (p. 842) in the MSC Acumen Toolkit - Code Example.


db_bulk_get_possible_matl_lins	( etid, atid, acid, goc, foc, loc, dsid, coc, mdc, nbr, mlc )


Description:
Retrieves all possible values of the material linearity option for the specified input options. If an input option is 0, it does not have a uniquely assigned value yet. The first three parameters may not be zero.
Input:
INTEGER	etid	The ID of the element type selected by the user.
INTEGER	atid	The ID of the analysis type currently selected.
INTEGER	acid	The ID of the analysis code currently selected.
INTEGER	goc	The code for the geometric option if it has been uniquely determined at point. otherwise, zero.
INTEGER	foc	The code for the formulation option if it has been uniquely determined at point. otherwise, zero.
INTEGER	loc	The code for the laminate option if it has been uniquely determined at point. otherwise, zero.
INTEGER	dsid	The ID for the dof set if it has been uniquely determined at point. otherwise, zero.
INTEGER	coc	The ID for the condense option if it has been uniquely determined at point. otherwise, zero.
INTEGER	mdc	The code for the material directionality if it has been uniquely determined at point. otherwise, zero.
Output:
INTEGER	nbr	The number of material linearity codes that were found for the above specified set of parameters.
INTEGER	mlc()	The unique material linearity code value that were found for the above specified set of values.
INTEGER	<Return Value>	Returns the success or failure of the routine.
Error Conditions:
13000002	Unrecoverable database error.
13000007	An unspecified database error occurred.
External Dependencies and Side Effects:
Fetches all material linearity codes for the input set of parameters.

Example:

See example for db_bulk_get_possible_matl_dirs, 364. See also db_bulk_get_possible_matl_lins (p. 844) in the MSC Acumen Toolkit - Code Example.


db_get_all_pp_ids_and_names	( )


Description:
This function will set the cursor to the start of a list of physical property id, name and data type values.
Input:
None.
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.

Remarks:

This function must be called before the db_get_next_pp_ids_and_names, 367 function can be called.

Example:

Please see db_get_all_pp_ids_and_names (p. 873) in the MSC Acumen Toolkit - Code Example.


db_get_next_pp_ids_and_names	( pp_id, pp_name, datatype )


Description:
This function will get the next physical property id, name, and data type from the database.
Input:
None.
Output:
INTEGER	pp_id	This value returns the physical property id value.
STRING	pp_name[80]	This value returns the physical property name.
INTEGER	datatype	This value returns the physical property datatype.
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:
13000142	The MPC was not found in the database.
13000117	The query specified has completed.
External Dependencies and Side Effects:
Accesses records in the phys_prop table in the database.

Remarks:

The PCL function db_get_all_pp_ids_and_names, 366 must be called at least once to establish the list of physical property id, name, and data type values and to set the cursor to point to the start of the list. Calling the db_get_next_pp_ids_and_names() function in a loop will then allow the list entries to be retrieved.

Example:

Please see db_get_next_pp_ids_and_names (p. 890) in the MSC Acumen Toolkit - Code Example.


db_set_comp_lam	( mat_name, num_plies, ply_names, thicknesses, orientations, iconven, offset, offset_def )


Description:
This function will set laminate construction data in the laminate and laminate_layer tables in the database.
Input:
STRING	mat_name[31]	This value specifies the name of the material.
INTEGER	num_plies	This value specifies the number of plies.
STRING	ply_names[31*num_plies]	This value specifies a list of ply names. See the remarks below for details on the use of this value.
REAL	thicknesses(num_plies)	This value specifies a list of ply thicknesses.
REAL	orientations(num_plies)	This value specifies a list of ply orientations.
INTEGER	iconven	This value specifies the stacking sequence convention.
REAL	offset	This value specifies the offset.
LOGICAL	offset_def	This value specifes, when set to TRUE, that the input value offset is to be used. When set to FALSE, the input value offset will be ignored.
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.
Remarks:
The input value ply_names is a string that consists of the number of 32 character fields specified by the input value num_plies. If an individual ply name is less that 32 characters in length it must be padded by concatinating spaces so that the total name length is 32 characters.
Error Conditions:
13000002	Unrecoverable database error.
13000007	An unspecified database error occurred.
13000120	The material specified in the query was not found.
13000136	The specified material has an invalid directionality flag.
External Dependencies and Side Effects:
This routine access the material, laminate and laminate_layer tables.

Example:

Please see db_set_comp_lam (p. 897) in the MSC Acumen Toolkit - Code Example.