Tutorial Toolkit Function Descriptions > Loads and Boundary Conditions > Database
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
Database
  
db_bulk_get_lbc_ds
( lbc_id, max, nbr, vid, rv, sc_pos, sc_dyn, scale_factor )
Description:
Fetches unevaluated dynamic scalar lbc data attached to an LBC.
Input:
INTEGER
lbc_id
The ID of the lbc that this lbc data is attached to.
INTEGER
max
The max number of dynamic scalar data records that can be passed back to the caller.
Output:
INTEGER
nbr
The number of dynamic scalar data records retrieved from the database.
INTEGER
vid()
The ID of the definition variable that corresponds to this scalar data
REAL
rv()
Scalar data values (real).
INTEGER
sc_pos()
Field IDs for positional dependent scalars.
INTEGER
sc_dyn()
Field IDs for dynamic dependent scalars.
REAL
scale_factor()
LBC set scale factor.
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:
Fetches one or more entries in the “ds_lbc” relation in the database.
Example:
Please see db_bulk_get_lbc_ds (p. 902) in the MSC Acumen Toolkit - Code Example.
  
db_bulk_get_lbc_dv
( lbc_id, max, nbr, vid, rv, ve_pos, ve_dyn, nv, scale_factor )
Description:
Fetches unevaluated dynamic vector LBC data attached to an LBC.
Input:
INTEGER
lbc_id
The ID of the lbc that this lbc data is attached to.
INTEGER
max
The max number of dynamic vector data records that can be passed back to the caller.
Output:
INTEGER
nbr
The number of dynamic vector data records retrieved from the database.
INTEGER
vid()
The ID of the definition variable that corresponds to this vector data.
REAL
rv(j, 3)
Vector data values (real) {i = vector component;(3) j = vector number (row nbr)}
INTEGER
ve_pos(j, 3)
Field IDs for positional dependent vectors {i = vector component;(3) j = vector number (row nbr)}
INTEGER
ve_dyn(j, 3)
Field IDs for dynamic dependent vectors {i = vector component;(3) j = vector number (row nbr)}
INTEGER
nv(j, 3)
Flag indicating whether this vector component contains valid data. {i = vector component;(3) j = vector number (row nbr)}
a value of -1 denotes a missing value,
a value of 0 denotes not missing
REAL
scale_factor()
LBC set scale factor
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:
Fetches one or more entries in the “dv_lbc” relation in the database.
Example:
Please see db_bulk_get_lbc_dv (p. 904) in the MSC Acumen Toolkit - Code Example.
  
db_bulk_get_lbc_ss
( lbc_id, max, nbr, vid, rv, sc_pos, scale_factor )
Description:
Fetches unevaluated static scalar LBC data attached to an LBC.
Input:
INTEGER
lbc_id
The ID of the lbc that this lbc data is attached to.
INTEGER
max
The max number of static scalar data records that can be passed back to the caller.
Output:
INTEGER
nbr
The number of static scalar data records retrieved from the database.
INTEGER
vid()
The ID of the definition variable that corresponds to this scalar data.
REAL
rv()
Scalar data values (real).
INTEGER
sc_pos()
Field IDs for positional dependent scalars.
REAL
scale_factor()
LBC set scale factor.
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:
Fetches one or more entries in the “ss_lbc” relation in the database.
Example:
Please see db_bulk_get_lbc_ss (p. 907) in the MSC Acumen Toolkit - Code Example.
 
db_bulk_get_lbc_sv
( lbc_id, max, nbr, vid, rv, ve_pos, nv, scale_factor )
  
Description:
Fetches unevaluated static vector LBC data attached to an LBC.
Input:
INTEGER
lbc_id
The ID of the lbc that this lbc data is attached to.
INTEGER
max
The max number of static vector data records that can be passed back to the caller.
Output:
INTEGER
nbr
The number of static vector data records retrieved from the database.
INTEGER
vid()
The ID of the definition variable that corresponds to this vector data.
REAL
rv(j, 3)
Vector data values (real) {i = vector component (3); j = vector number (row nbr)}
INTEGER
ve_pos(j, 3)
Field IDs for positional dependent vectors {i = vector component (3); j = vector number (row nbr)}
INTEGER
nv(j, 3)
Flag indicating whether this vector component contains valid data. {i = vector component (3); j = vector number (row nbr)}
a value of -1 denotes a missing value,
a value of 0 denotes not missing
REAL
scale_factor()
LBC set scale factor.
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:
13000093
Too Many Values Returned for Space Allocated.
13000002
Unrecoverable database error.
External Dependencies and Side Effects:
Fetches one or more entries in the “sv_lbc” relation in the database.
Example:
Please see db_bulk_get_lbc_sv (p. 909) in the MSC Acumen Toolkit - Code Example.
  
db_count_appl_geo_region
( id, count )
Description:
Retrieves the number of appl_geo_regions stored in the database by lbc_type_id.
Input:
INTEGER
id
The id of the lbc_type_id with which the appl_geo_regions are associated
Output:
INTEGER
count
The number of appl_geo_regions 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 all records in the “appl_geo_region” relation in the database by lbc_type_id.
Example:
Please see db_count_appl_geo_region (p. 911) in the MSC Acumen Toolkit - Code Example.
  
db_count_lbc
( count )
Description:
Retrieves the number of lbcs stored in the database.
Input:
none
Output:
INTEGER
count
The number of appl_geo_regions 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 all records in the “lbc” relation in the database.
Example:
Please see db_count_lbc (p. 912) in the MSC Acumen Toolkit - Code Example.
  
db_count_lbc_appl_region_entity
( id, apprid, count )
Description:
Retrieves the count of entity in each application region, and the application region ids for each lbc stored in the database.
Input:
INTEGER
id
The lbc ID for which the region information is requested
Output:
INTEGER
apprid(2)
The IDs of the application regions stored in the database. At present two is the maximum.
INTEGER
count(2)
The number of entities for each appl_geo_regions stored in the database. at present there is a maximum of two corresponding to the application region 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:
Counts all entities in the “lbc_app_region” relation in the database for a specified lbc_id and app_region_id.
Example:
Please see db_count_lbc_appl_region_entity (p. 913) in the MSC Acumen Toolkit - Code Example.
  
db_count_lbc_types
( nbr_of_lbcs )
Description:
Returns the total number of distinct lbcs in the database.
Input:
none
Output:
INTEGER
nbr_of_lbcs
The number of lbc type IDs
INTEGER
<Return Value>
Integer indicating success or failure of the routine. If the routine failed, this value contains an indication of the reason.
External Dependencies and Side Effects:
Accesses records in the lbc_type table in the database.
Example:
Please see db_count_lbc_types (p. 914) in the MSC Acumen Toolkit - Code Example.
  
db_count_loads_for_element
( elem_id, nbr_of_lbcs )
Description:
Returns the number of loads and boundary conditions for an element.
Input:
INTEGER
elem_id
The element ID.
Output:
INTEGER
nbr_of_lbcs
The number of lbcs associated with the element.
INTEGER
<Return Value>
Returns the success or failure of the routine
External Dependencies and Side Effects:
This routine access the element, fem_ss_lbc, fem_sv_lbc, fem_ds_lbc and fem_dv_lbc tables.
Example:
Please see db_count_loads_for_element (p. 917) in the MSC Acumen Toolkit - Code Example.
  
db_count_load_cases_with_lbc
( lbc_id, num_loadcases )
Description:
Retrieves the number of load cases associated with a lbc.
Input:
INTEGER
lbc_id
The lbc ID
Output:
INTEGER
num_loadcases
The number of distinct load cases associated with the above lbc ID
INTEGER
<Return Value>
Returns the success or failure of the routine
External Dependencies and Side Effects:
Counts records in the “assigned_load_set” relation in the database.
Example:
Please see db_count_load_cases_with_lbc (p. 915) in the MSC Acumen Toolkit - Code Example.
  
db_delete_lbc
( lbc_id )
Description:
Deletes an lbc entry from the database.
Input:
INTEGER
lbc_id
Id of the lbc to be deleted.
Output:
INTEGER
<Return Value>
Integer indicating success or failure of the routine. If the routine failed, this value contains an indication of the reason.
External Dependencies and Side Effects:
Deletes one record in the “lbc” table in the database, and deletes from any associated lbc entity.
Example:
Please see db_delete_lbc (p. 919) in the MSC Acumen Toolkit - Code Example.
  
db_delete_lbc_defn
(<lbc_type_id>)
Description:
This function will delete the lbc type definition from the database.
Input:
INTEGER
lbc_type_id
ID of the lbc type in the database.
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 db_delete_lbc_defn (p. 920) in the MSC Acumen Toolkit - Code Example.
  
db_get_all_appl_geo_regions
( lbc_id )
Description:
Gets all records in the LbcAppRegion table relation for the specified lbc_id from the database, in get all, get next method. See also db_get_next_appl_geo_region, 390.
Input:
INTEGER
lbc_id
The ID of the lbc for the new records
Output:
INTEGER
<Return Value>
Integer indicating success or failure of the routine.
Example:
Please see db_get_all_appl_geo_regions (p. 921) in the MSC Acumen Toolkit - Code Example.
  
db_get_next_appl_geo_region
( ar_id, etype, eid, esid )
 
Description:
Gets next record in the lbcAppRegion table relation for the specified lbc id from the database. See also db_get_all_appl_geo_regions, 389.
Input:
none
Output:
INTEGER
ar_id
The sequential ID assigned to this application geometry region.
INTEGER
etype
The entity type to which this lbc has been applied.
INTEGER
eid
The entity ID to which this lbc has been applied.
INTEGER
esid
The entity sub_id to which this lbc has been applied (if appropriate).
INTEGER
<Return Value>
Integer indicating success or failure of the routine.
Error Conditions:
13000002
Unrecoverable database error.
13000117
The query specified has completed.
13000007
An unspecified database error occurred.
External Dependencies and Side Effects:
Accesses records in the “Appl Geo Region” table in the database.
Example:
See example for db_get_all_appl_geo_regions, 389. See also db_get_next_appl_geo_region (p. 944) in the MSC Acumen Toolkit - Code Example.
  
db_get_all_appl_reg_defns
( lbc_tid )
Description:
Gets all application geometry region definitions for an lbc type definition from the database, in get all, get next method. See also db_get_next_appl_reg_defn, 391
Input:
INTEGER
lbc_tid
The ID of the lbc type in the database.
Output:
INTEGER
<Return Value>
Integer indicating success or failure of the routine.
Example:
Please see db_get_all_appl_reg_defns (p. 923) in the MSC Acumen Toolkit - Code Example.
 
db_get_next_appl_reg_defn
( vid, label )
  
Description:
Gets next application geometry region definition for an lbc type definition from the database. See also db_get_all_appl_reg_defns, 390.
Input:
none
Output:
INTEGER
vid
The sequential ID assigned to this application geometry region.
INTEGER
label[31]
The label to be placed in front of the databox on the “Create LBC” form.
INTEGER
<Return Value>
Integer indicating success or failure of the routine.
Error Conditions:
13000002
Unrecoverable database error.
13000117
The query specified has completed.
13000007
An unspecified database error occurred.
Example:
See example for db_get_all_appl_reg_defns, 390. See also db_get_next_appl_reg_defn (p. 946) in the MSC Acumen Toolkit - Code Example.
 
db_get_all_lbcs_new
( )
 
Description:
This function will set up the data required to retrieve all of the information about all of the LBCs in the memory database.
Input:
none
Output:
INTEGER
<Return Value>
Integer indicating success or failure of the routine.
Example:
Please see db_get_all_lbcs_new (p. 932) in the MSC Acumen Toolkit - Code Example.
  
db_get_next_lbcs_new
( id, name, type, cat, eldim, cid, dyn_flag, scaleFactor, geo_fem, appRegCouple, appRegOrder, equivFlag, acidMod )
Description:
This function will retrieve all of the information about all of the LBCs in the memory database one structure at a time.
Input:
none
Output:
INTEGER
id
The ID of the LBC structure.
STRING
name[]
The name of this lbc table.
INTEGER
type
The type of the lbc this is.
INTEGER
cat
The category of lbc this is.
INTEGER
eldim(3)
The target element dimensionality values.
INTEGER
cid
The ID of the alternate coordinate frame if there is one.
INTEGER
dyn_flag
The dynamic/static flag value.
REAL
scaleFactor
The scale factor value.
INTEGER
geo_fem (3)
Specifies geo or fem as original lbc app region types.
INTEGER
appRegCouple
Multi app region coupling option.
INTEGER
appRegOrder
Multi app region order option.
INTEGER
equivFlag
The "don't equivalence nodes" flag.
INTEGER
acidMod
The flag which says that this lbc requires the acid frame for nodes to be modified.
INTEGER
<Return Value>
Integer indicating success or failure of the routine.
Example:
See Example for db_get_all_lbcs_new, 391. See also db_get_next_lbcs_new (p. 954) in the MSC Acumen Toolkit - Code Example.
  
db_get_all_lbc_names
( )
Description:
Gets all lbc names & types from the database, in get all, get next method. See also db_get_next_lbc_name, 393.
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.
13000117
The query specified has completed.
13000007
An unspecified database error occurred.
External Dependencies and Side Effects:
Accesses all records in the “lbc” table in the database.
Example:
Please see db_get_all_lbc_names (p. 924) in the MSC Acumen Toolkit - Code Example.
  
db_get_next_lbc_name
( id, name, type )
Description:
Gets next lbc name & type from the database.
Input:
none
Output:
INTEGER
id
The unique internal ID of the lbc type created in the database.
STRING
name[31]
The name of the lbc type being created in the database.
INTEGER
type
The type ID of the lbc (from the lbc_type table).
INTEGER
<Return Value>
Integer indicating success or failure of the routine.
Error Conditions:
13000002
Unrecoverable database error.
13000117
The query specified has completed.
13000007
An unspecified database error occurred.
External Dependencies and Side Effects:
Accesses all records in the “lbc” table in the database.
Example:
See example for db_get_all_lbc_names, 393. See also db_get_next_lbc_name (p. 947) in the MSC Acumen Toolkit - Code Example.
  
db_get_all_lbc_names_by_type
( lbc_typ_id )
Description:
Gets all lbc type names from the database, in get all next method. See also db_get_next_lbc_name_by_type, 395.
Input:
INTEGER
lbc_type_id
The lbc type ID for the row selected.
Output:
INTEGER
<Return Value>
Integer indicating success or failure of the routine.
Error Conditions:
13000002
Unrecoverable database error.
13000117
The query specified has completed.
13000007
An unspecified database error occurred.
External Dependencies and Side Effects:
Accesses all records in the “lbc” table in the database.
Example:
Please see db_get_all_lbc_names_by_type (p. 925) in the MSC Acumen Toolkit - Code Example.
  
db_get_next_lbc_name_by_type
( id, name )
 
Description:
Gets next lbc type name from the database. See also db_get_all_appl_reg_defns, 390.
Input:
none
Output:
INTEGER
id
The unique internal ID of the lbc in the database.
STRING
name[31]
The name of the lbc being in the database.
INTEGER
<Return Value>
Integer indicating success or failure of the routine.
Error Conditions:
13000002
Unrecoverable database error.
13000117
The query specified has completed.
13000007
An unspecified database error occurred.
External Dependencies and Side Effects:
Accesses all records for a specified type in the “lbc” table in the database.
Example:
See example for db_get_all_appl_reg_defns, 390. See also db_get_next_lbc_name_by_type (p. 948) in the MSC Acumen Toolkit - Code Example.
  
db_get_all_lbc_type_defns
( )
Description:
Gets all lbc type definitions from the database, in get all, get next method.See also db_get_next_lbc_type_defn, 396.
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.
13000117
The query specified has completed.
13000007
An unspecified database error occurred.
External Dependencies and Side Effects:
Accesses all records in the “load case” table in the database.
Example:
Please see db_get_all_lbc_type_defns (p. 927) in the MSC Acumen Toolkit - Code Example.
  
db_get_next_lbc_type_defn
( id, name, class, form, gbc, cid, g_sym, sv, nv, nbr_ac, an_code, defcol, cbid, anstyl )
Description:
Gets next lbc type definition from the database. See also db_get_all_lbc_type_defns, 395.
Input:
none
Output:
INTEGER
id
The unique internal ID of the lbc type created in the database.
STRING
name[31]
The name of the lbc type being created in the database.
INTEGER
class
The class of the lbc type to be created. (Structural, Thermal, Other)
INTEGER
form
The form of the lbc being created. (Body or Boundary)
INTEGER
gbc
Flag indicating whether this is a global boundary condition.
INTEGER
cid
Flag indicating whether the lbc can be defined in an alternate coord frame.
INTEGER
g_sym
The graphics symbol used to display this lbc.
INTEGER
sv
Flag indicating whether this lbc is a scalar or vector.
INTEGER
nv
Flag indicating whether (for vector lbcs) one (or more) of the components can be null.
INTEGER
nbr_ac
The number of analysis codes supplied.
INTEGER
an_code()
List of valid analysis code IDs for this lbc.
INTEGER
defcol
Default color of associated graphics.
INTEGER
cbid
Color box ID of associated graphics.
INTEGER
anstyl
Anchor style of associated graphics.
INTEGER
<Return Value>
Integer indicating success or failure of the routine.
Error Conditions:
13000002
Unrecoverable database error.
13000117
The query specified has completed.
13000007
An unspecified database error occurred.
External Dependencies and Side Effects:
Accesses all records in the “load case” table in the database.
Example:
See example for db_get_all_lbc_type_defns, 395. See also db_get_next_lbc_type_defn (p. 949) in the MSC Acumen Toolkit - Code Example.
  
db_get_all_lbc_type_names
( )
Description:
Gets all lbc type names from the database, in get all, get next method. See also db_get_next_lbc_type_name.
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.
13000117
The query specified has completed.
13000007
An unspecified database error occurred.
External Dependencies and Side Effects:
Accesses all records in the “lbc_type” table in the database.
Example:
Please see db_get_all_lbc_type_names (p. 928) in the MSC Acumen Toolkit - Code Example.
 
db_get_next_lbc_type_name
( id, name )
  
Description:
Gets next lbc type name from the database. See also db_get_all_lbc_type_names, 397.
Input:
none
Output:
INTEGER
id
The unique internal ID of the lbc type in the database.
STRING
name[31]
The name of the lbc type being in the database.
INTEGER
<Return Value>
Integer indicating success or failure of the routine.
Error Conditions:
13000002
Unrecoverable database error.
13000117
The query specified has completed.
13000007
An unspecified database error occurred.
External Dependencies and Side Effects:
Accesses all records in the “lbc_type” table in the database.
Example:
See example for db_get_all_lbc_type_names, 397. See also db_get_next_lbc_type_name (p. 951) in the MSC Acumen Toolkit - Code Example.
  
db_get_all_lbc_var_defns
( id )
Description:
Gets all the lbc variables for an lbc type definition from the database, in get all, get next method. See also db_get_next_lbc_var_defn, 399.
Input:
INTEGER
id
The lbc type ID for the row selected.
Output:
INTEGER
<Return Value>
Integer indicating success or failure of the routine.
Example:
Please see db_get_all_lbc_var_defns (p. 929) in the MSC Acumen Toolkit - Code Example
. 
db_get_next_lbc_var_defn
( cat, eldim )
 
Description:
Gets next lbc variable for an lbc type definition from the database. See also db_get_all_lbc_var_defns, 398.
Input:
none
Output:
INTEGER
cat
The category of this lbc type.
STRING
eldim
The element shape to get this label.
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.
13000117
The query specified has completed.
13000007
An unspecified database error occurred.
External Dependencies and Side Effects:
Accesses records in the “Lbc Variable Defn” table in the database.
Example:
See example under db_get_all_lbc_var_defns, 398. See also db_get_next_lbc_var_defn (p. 953) in the MSC Acumen Toolkit - Code Example.
  
db_get_lbc_id
( name, id )
Description:
Retrieves the lbc id associated with the specified lbc name.
Input:
STRING
name[31]
Pointer to a string containing the name of the lbc.
Output:
INTEGER
id
Location to receive the resulting value.
INTEGER
<Return Value>
Returns the success or failure of the routine.
Error Conditions:
13000002
Unrecoverable database error.
13000103
No LBC was found.
13000007
An unspecified database error occurred.
Example:
Please see db_get_lbc_id (p. 933) in the MSC Acumen Toolkit - Code Example.
  
db_get_lbc_name
( id, name )
Description:
Retrieves the lbc name associated with the specified lbc id.
Input:
INTEGER
id
Integer containing the ID of the lbc.
Output:
STRING
name[31]
Pointer to a string where the name of the lbc is to be placed.
INTEGER
<Return Value>
Returns the success or failure of the routine.
Example:
Please see db_get_lbc_name (p. 935) in the MSC Acumen Toolkit - Code Example.
 
db_get_lbc_type_defn
( name, id, class, form, gbc, cid, g_sym, sv, nv, nbr_ac, an_code, defcol, cbid, anstyl )
  
Description:
This function will get the attributes of an lbc type definition from the database.
Input:
STRING
name[31]
This value specifies the name of the lbc type.
Output:
INTEGER
id
This value returns the id value of the lbc type.
INTEGER
class
This value returns the class of the lbc type which can be either structural, thermal, or other.
INTEGER
form
This value returns the form of the lbc which can be either a body or a boundary.
INTEGER
gbc
This value returns an indication stating if the lbc is a global boundary condition.
INTEGER
cid
This value returns an indication stating if the lbc can be defined in an alternate coord frame.
INTEGER
g_sym
This value returns the graphics symbol used to display this lbc.
INTEGER
sv
This value returns an indication stating if this lbc is scalar or vector.
INTEGER
nv
This value indicates for vector lbcs whether one or more of the components can be null.
INTEGER
nbr_ac
The value returns the number of analysis codes applied to this lbc.
INTEGER
an_code(20)
This value returns the valid analysis code id values for this lbc.
INTEGER
defcol
This value returns the default color of the graphics associated with the lbc.
INTEGER
cbid
This value returns the color box id of the graphics associated with the lbc.
INTEGER
anstyl
This value returns the anchor style of the graphics associated with the lbc.
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.
13000101
No LBC Definition was found.
External Dependencies and Side Effects:
Accesses all records in the “lbc type” table in the database.
Example:
Please see db_get_lbc_type_defn (p. 936) in the MSC Acumen Toolkit - Code Example.
 
db_get_lbc_var_defn
( lbc_type_id, lbc_category, eldim, label, id )
  
Description:
Gets the lbc variable defn from the database.
Input:
INTEGER
lbc_type_id
The ID of the lbc type in the database.
INTEGER
lbc_category
The ID of the lbc type in the database
INTEGER
eldim
The dimensionality of the lbc type in the database.
STRING
label[]
The label of the variable in the database.
Output:
INTEGER
id
The unique internal ID of the lbc type variable in the database.
INTEGER
<Return Value>
Returns the success or failure of the routine.
Error Conditions:
13000002
Unrecoverable database error.
13000101
No LBC Definition was found.
13000007
An unspecified database error occurred.
External Dependencies and Side Effects:
Accesses all records in the “lbc_variable_defn” table in the database.
Example:
Please see db_get_lbc_var_defn (p. 938) in the MSC Acumen Toolkit - Code Example.
  
db_get_loads_for_element
( nbr_of_lbcs, elem_id, lbc )
Description:
Returns the loads and boundary conditions for an element.
Input:
INTEGER
nbr_of_lbcs
The amount of memory allocated for the lbc IDs.
INTEGER
elem_id
The element ID.
Output:
INTEGER
lbc()
The lbc IDs.
INTEGER
<Return Value>
Returns the success or failure of the routine.
Error Conditions:
13000093
Too Many Values Returned for Space Allocated.
13000157
Fewer values were returned than the amount requested.
External Dependencies and Side Effects:
This routine access the element, fem_ss_lbc, fem_sv_lbc, fem_ds_lbc and fem_dv_lbc tables.
Example:
Please see db_get_loads_for_element (p. 942) in the MSC Acumen Toolkit - Code Example.
 
db_get_load_cases_with_lbc
(lbc_id, num_loadcases, loadcase_ids, priority )
  
Description:
Retrieves the number of load cases associated with an lbc.
Input:
INTEGER
lbc_id
The ID of the lbcs to which the load cases are associated in the database.
INTEGER
num_loadcases
The input/output field containing the maximum number of load cases on input and the actual number of load cases retrieved from the database on output.
Output:
INTEGER
num_loadcases
The input/output field containing the maximum number of load cases on input and the actual number of load cases retrieved from the database on output.
INTEGER
loadcase_ids()
Array of the IDs of the load cases assigned to this lbc id.
INTEGER
priority()
Priority associated with the assigned load 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:
Retrieves multiple entries from the “assigned_load_case” relation.
Example:
Please see db_get_load_cases_with_lbc (p. 940) in the MSC Acumen Toolkit - Code Example.
  
db_get_valid_cat_by_type
( typid, cat )
Description:
Retrieves all valid categories from the database for a specified type. The maximum number of categories for a type is three.
Input:
INTEGER
typid
The specific lbc type for which the category is requested.
Output:
INTEGER
cat(3)
The categories associated with the specified lbc type.
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 the categories associated with specified type from the lbc_variable_defn relation.
Example:
Please see db_get_valid_cat_by_type (p. 956) in the MSC Acumen Toolkit - Code Example.
 
db_get_valid_eldim_by_type_cat
( typid, cat, eldim )
  
Description:
Retrieves all valid element dimensions for the specified types and categories in the database. The maximum number of element dimensions is five.
Input:
INTEGER
typid
The specific lbc type for which the element dimensionality is requested.
INTEGER
cat
The categories associated with the specified lbc type.
Output:
INTEGER
eldim(5)
The types of element dimensionality which correspond to the input type and category.
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 the element dimensionalities associated with specified type and category of lbc from the lbc_variable_defn relation.
Example:
See example for db_get_valid_cat_by_type, 403. See also db_get_valid_eldim_by_type_cat (p. 957) in the MSC Acumen Toolkit - Code Example.
 
db_get_valid_lbc_var_ids
( typid, cat, eldim, count, vid )
  
 
Description:
Retrieves all valid element variable ids for the specified combination pf type, category, and dimensionality specified from the database.
Input:
INTEGER
typid
The specific lbc type for which the element dimensionality is requested.
INTEGER
cat
The categories associated with the specified lbc type.
INTEGER
eldim
The types of element dimensionality for which the variable IDs are requested.
INTEGER
count
Input/Output field which specifies the maximum storage allocated by the calling routine, and outputs the actual number of variable IDs fetched if it is not greater than the count.
Output:
INTEGER
count
Input/Output field which specifies the maximum storage allocated by the calling routine, and outputs the actual number of variable IDs fetched if it is not greater than the count.
INTEGER
vid()
Array of variable IDs defined by the combination of items input.
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 the element dimensionalities associated with specified type and category of lbc from the lbc_variable_defn relation.
Example:
Please see db_get_valid_lbc_var_ids (p. 959) in the MSC Acumen Toolkit - Code Example.
 
db_modify_load_case
( id, name, type, desc, nbrlc, lbc, dlcname, mv, priority )
 
Description:
Modifies a load case in the database.
Input:
INTEGER
id
The unique internal ID of the load case being modified in the database.
STRING
name[80]
The new name of the load case being modified in the database.
INTEGER
type
The new type of the load case being modified.
STRING
desc[256]
The description of the load case being modified.
INTEGER
nbrlbc
The number of lbcs being attached to this load case.
INTEGER
lbc()
Array of the IDs of the load\bc set IDs assigned to this load case.
STRING
dlcname[80]
The name of the dynamic load case being used as a basis for this definition. (This field is only applicable if a static load case is being created from a dynamic load case.)
REAL
mv
Map variable.
INTEGER
priority()
The priority for the assigned load set.
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:
13000075
Load case name exists.
13000052
Load Case Not Found.
13000002
Unrecoverable database error.
External Dependencies and Side Effects:
Updates an entry in the “load_case” relation in the database and deletes and adds multiple entries to the “assigned_load_case” relation.
Example:
Please see db_modify_load_case (p. 960) in the MSC Acumen Toolkit - Code Example.