Tutorial Toolkit Function Descriptions > Loads and Boundary Conditions > General
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
General
 
lbc_create
(name, type_id, cat_id, dyn_flag, num_ar, ar_id, aplist1, aplist2, fem_flag, targ_elem, lbc_sf, cid_id, no_data_flag, num_dat, var_id, sv, null_flag, null_var, datatype, ivalue, rvalue, fldid, dyn_fldid, node_id)
 
Description:
Create the Loads and Boundary Condition Set ( i.e., for positionally dependent quantities field references are store not actual values).
Input:
STRING
name[]
Load/BC Set Name - user specified.
INTEGER
type_id
Load/BC Type -disp, force, etc.
INTEGER
cat_id
Category - Nodal, Elem Uni, Elem Var.
INTEGER
dyn_flag
Dynamic Flag = FA_TRUE if dynamic.
INTEGER
num_ar
Number of Application Regions.
INTEGER
ar_id (2)
Appl Region db ID.
STRING
aplist1[]
Application Region 1 list.
STRING
aplist2[]
Application Region 2 list.
INTEGER
fem_flag (5)
FEM Flag = FA_TRUE if FEM entities FEM Flag(4) = app-reg-couple, FEM Flag (5) = app‑reg-order.
INTEGER
targ_elem (3)
Target Element Dimension.
REAL
lbc_sf
Lbc Set Scale Factor.
INTEGER
cid_id
Coordinate System ID.
INTEGER
no_data_flag
No_Data_Flag = FA_TRUE if no data case is valid.
INTEGER
num_dat
Number of input data variables.
INTEGER
var_id (20)
Input Variable Data ID.
INTEGER
sv (20)
Indicates whether data is scalar or vector.
INTEGER
null_flag (20)
Null vector flag =1, if null allowed.
INTEGER
null_var (20, 3)
Flag indicating whether this vector comp is null null_var = -1 if null, 0 if not null.
INTEGER
datatype (20)
Indicates datatypes, (e.g. integer, real, field (see dbcodes.h); DbInt).
INTEGER
ivalue (20)
Integer value.
REAL
rvalue (20, 3)
Real value.
INTEGER
fldid (20, 3)
Field ID.
INTEGER
dyn_fldid (20, 3)
Dynamic Field ID.
INTEGER
node_id (20)
Node ID.
Output:
INTEGER
<Return Value>
See error returned.
Comments:
 
 
Entity types and ids will change based on topological description. Displays loads/bcs graphics. Currently only one application region is being processed.
Error Conditions:
26002020
Load/BC "%A%" already exists. Do you wish to overwrite?
26006004
Dynamic memory allocation error encountered.
Example:
Please see lbc_create (p. 963) in the MSC Acumen Toolkit - Code Example.
 
 
lbc_create_scalar_table
(type_name, type_id, dynamic_val, var_name, component, num_lbcs, lbc_ids, num_grps, grp_ids)
 
Description:
Main application routine for the Loads/BCs Show Plot Scalar option. A scalar graphics table is loaded with the specified load/BC and is assigned to the specified groups.
Input:
STRING
type_name
The Load/BC type name.
INTEGER
type_id
Load/BC Type Ids.
REAL
dynamic_val
The value of the dynamic field to evaluate
STRING
var_name
The name of the variable to be loaded into the scalar table.
STRING
component
The component of the variable to be loaded into the scalar table.
INTEGER
num_lbcs
The number of lbcs to contour.
INTEGER
lbc_ids
The IDs of the lbcs to contour.
INTEGER
num_grps
The number of groups to assign the scalar table to.
INTEGER
grp_ids
The IDs of the groups to assign the scalar table to.
Output:
INTEGER
table_id
ID of element scalar table created
INTEGER
<Return Value>
FA_NOERROR success; FA_ERROR Failure.
 
 
lbc_delete
( count, del_id, update_graph )
 
Description:
Delete the Loads and Boundary Condition Sets (and their related associations - application region, data, load case association.
Input:
INTEGER
count
Number of Load/BC Sets to delete.
INTEGER
del_id ( count)
Load/BC Set Ids.
LOGICAL
update_graph
If TRUE, then update graphics.
Output:
INTEGER
<Return Value>
FA_NOERROR success; FA_ERROR Failure.
Comments:
Removes the Load/BC sets from all applicable load cases.
Example:
Please see lbc_delete (p. 967) in the MSC Acumen Toolkit - Code Example.
  
lbc_eval_fem_by_lc
( lc_name )
 
Description:
Given a load case name, get all the lbcs associated with it and check to see if each lbc has any unevaluated fem_xx_lbcs. If it does then create the appropriate fem_xx_table in the db.
Input:
STRING
lc_name[]
Load Case Name.
Output:
INTEGER
<Return Value>
See error returned.
Error Conditions:
3001301
Load Case "%A%" has no Load/BC sets.
3001101
Load Case "%A%" does not exist.
Example:
Please see lbc_eval_fem_by_lc (p. 969) in the MSC Acumen Toolkit - Code Example.
  
lbc_eval_fem_lbc
( lbc_id )
Description:
Given an lbc id, check to see if it has any unevaluated fem_xx_lbcs. If it does then create the appropriate fem_xx_table in the db.
Input:
INTEGER
lbc_id
Load/BC ID.
Output:
INTEGER
<Return Value>
See error returned.
Error Conditions:
26002144
The application region for Load/BC Set "%A%" is empty.
Example:
Please see lbc_eval_fem_lbc (p. 970) in the MSC Acumen Toolkit - Code Example.
  
lbc_get_sdbx_datatype
( lbc_id, obj_str, meth_str, targ_str, geo_group, sdbx_type, sdbx_label )
 
Description:
Given lbc object, method, target element type, and geometry group return the select databox datatype and label.
Input:
INTEGER
lbc_id
Load/BC ID.
STRING
obj_str[]
Load/BC object, e.g., Displacement.
STRING
meth_str[]
Load/BC Category - Nodal, Element Uniform, Element Variable.
STRING
targ_str[]
Target Element Type - Beam, Shell, Solid, PTEAM.
STRING
geo_group[]
Geometry Group - Geometry or FEM.
Output:
STRING
sdbx_type[]
Select databox type.
STRING
sdbx_label[]
Select databox label.
INTEGER
<Return Value>
See error returned.
Error Conditions:
26002410
"%A%" is an invalid Load/BC target element type.
26002400
"%A%" is an invalid Load/BC type.
Example:
Please see lbc_get_sdbx_datatype (p. 971) in the MSC Acumen Toolkit - Code Example.
  
lbc_gm
( )
 
Description:
Loads/BCs Graphics Manager.
1. Gets the valid groups to which lbcs will be posted.
2. Gets the lbc_types which should be posted from pref form.
3. Filters out the lbc_ids in the current load case which should be posted.
4. Modifies the LBC_IN_GROUP relation as appropriate.
5. Creates the Group Vector Table.
6. Assigns the Group Vector Table to the valid groups.
Input:
none
Output:
INTEGER
<Return Value>
See error returned.
Error Conditions:
26006004
Dynamic memory allocation error encountered.
Example:
Please see lbc_gm (p. 972) in the MSC Acumen Toolkit - Code Example.
 
lbc_graphics_defn
( type_id, cat_id, targ_elem_id, nvar, varid, vector_flag, marker, color, anchor )
 
Description:
Given an lbc id, get the data in the ss_lbc, sv_lbc, ds_lbc, and/or dv_lbc table.
Input:
INTEGER
type_id
LBC Type Id - disp, force.
INTEGER
cat_id
Category - Nodal, Elem Uni, Elem Var.
INTEGER
targ_elem_id
Target Element Dimension.
Output:
INTEGER
nvar
Number of input variable (10 max).
INTEGER
varid ( )
Input data variable ID.
INTEGER
vector_flag ( )
Vector flag = 1, if vector.
INTEGER
marker ( )
Graphics symbol.
INTEGER
color ( )
Colorbox ID.
INTEGER
anchor ( )
Anchor style.
INTEGER
<Return Value>
Returns success or failure of the routine.
0 = success
-1 = Error occurred
Example:
Please see lbc_graphics_defn (p. 973) in the MSC Acumen Toolkit - Code Example.
  
lbc_lp_parse_sca
( data_string, data_type, field_id, null_flag, data_string_value )
 
Description:
This function will parse a loads and boundary condition data string, verify that it contains valid scalar or scalar field information, and return the value in the string.
Input:
STRING
data_string[]
This value specifies a loads and boundary condition property.
INTEGER
data_type
This value specifies the property data type.
This value should be set to either 1 to parse integers, 3 to parse real values, 4 to parse tokens, 5 to parse nodes, and 7 to parse field values.
If the "datatype" input value is not set to a value of 1 or 5, this function will attempt to parse the "dval" string as a character, node, or field values based on information obtained from the string itself.
Output:
INTEGER
field_id
This value returns the value of id for the scalar field specified by the input value data_string.
INTEGER
null_flag
This value returns a non zero value if the input value data_string represents a valid loads and boundary condition property that has no data.
REAL
data_string_value
This value returns the results of the parse of the input value data_string.
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:
14000004
LpSublistType: I am being invoked with a NULL list.
26005002
The data entered in databox %I% on the "Input Data" form is invalid.
26005003
Databox %I% on the "Input Data" form requires a Scalar field.
26005001
The data entered in databox %I% on the "Input Data" form cannot be parsed.
Example:
Please see lbc_lp_parse_sca (p. 975) in the MSC Acumen Toolkit - Code Example.
  
lbc_lp_parse_vec
( data_string, field_id, null_flag, data_string_value )
 
Description:
This function will parse a loads and boundary condition vector string, verify that it contains valid vector or vector field information, and return the value in the string.
Input:
STRING
data_string[]
This value specifies a loads and boundary condition property
Output:
INTEGER
field_id
This value returns the value of id for the scalar field specified by the input value data_string.
INTEGER
null_flag
This value returns a non zero value if the input value data_string represents a valid loads and boundary condition property that has no data.
REAL
data_string_value
This value returns the results of the parse of the input value data_string.
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:
14000011
LpSublistAttributeGet: Attempt to get attribute from NULL list.
26005004
Databox %I% on the "Input Data" form requires a Spatial Vector field.
26005001
The data entered in databox %I% on the "Input Data" form cannot be parsed.
Example:
Please see lbc_lp_parse_vec (p. 976) in the MSC Acumen Toolkit - Code Example.
 
lbc_plot_markers
( num_lbcs, lbc_ids, num_grps, grp_ids )
  
Description:
Creates graphics marker tables for display on groups.
- Filters out the lbc_ids in the current load case which should be posted.
- Modifies the LBC_IN_GROUP relation as appropriate.
- Creates or modifies the Group Vector Table.
- Assigns the Group Vector Table to the valid groups
Input:
INTEGER
num_lbcs
Number of lbc IDs.
INTEGER
lbc_ids ( )
LBC IDs to process.
INTEGER
num_grps
Number of groups .
INTEGER
grp_ids ( )
Group IDs to assign table to.
Output:
INTEGER
<Return Value>
See error returned.
FA_NOERROR = success
FA_ERROR = failure
Example:
Please see lbc_plot_markers (p. 977) in the MSC Acumen Toolkit - Code Example.
  
lbc_show_plot_scalar
(type_name, type_id, dynamic_val, var_name, component, num_lbcs, lbc_ids, num_grps, grp_ids)
 
Description:
Main application routine for the Loads/BCs Show Plot Scalar option. A scalar graphics table is loaded with the specified load/BC and is assigned to the specified groups.
Input:
STRING
type_name[]
The Load/BC type name.
INTEGER
type_id
Load/BC type ID.
REAL
dynamic_val
The value of the dynamic field to evaluate.
STRING
var_name[]
The name of the variable to be loaded into the scalar table.
STRING
component[]
The component of the variable to be loaded into the scalar table.
INTEGER
num_lbcs
The number of lbcs to contour.
INTEGER
lbc_ids (num_lbcs)
The IDs of the lbcs to contour.
INTEGER
num_grps
The number of groups to assign the scalar table to.
INTEGER
grp_ids (num_lbcs)
The IDs of the groups to assign the scalar table to.
Output:
INTEGER
<Return Value>
See error returned.
Error Conditions:
26004001
Unable to assign the scalar table to Group "%A%".
26004003
Invalid component "%A%" was specified. Valid component strings are "Resultant", "Component1", "Component2", and "Component3".
Example:
Please see lbc_show_plot_scalar (p. 979) in the MSC Acumen Toolkit - Code Example.
  
loadcase_create2
(load_case_name, load_case_type, load_case_desc, scale_factor, lbc_name, priorities, lbc_scales, dynamic_name, mv, make_current )
Description:
This function creates a new load case in the database.
Input:
STRING
load_case_name[]
New load case name
STRING
load_case_type[]
New load case type, can be set to either “Static” or “Time Dependent”.
STRING
load_case_desc[ ]
Load case description.
REAL
scale_factor
Load case scale factor.
STRING
lbc_name[]( )
Names of assigned lbcs.
INTEGER
priorities()
Array of priorities of assigned lbcs.
REAL
lbc_scales()
Array of lbc scale factors.
STRING
dynamic_name[]
Dynamic load case name.
REAL
mv
Flag to indicate if newly created.
LOGICAL
make_current
Load case should be made the current load case, TRUE if make current.
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:
-1
 
This is an internal status condition. There is no corresponding status message in the message database.
Example:
Please see loadcase_create2 (p. 981) in the MSC Acumen Toolkit - Code Example.
  
loadsbcs_get_appl_region_list
( id, region_id, ent_count, geo_str, app_list )
Description:
Gets the application region entities - types, ids, and sub ids (if applicable) from the database.
Input:
INTEGER
id
Load/BC ID.
INTEGER
region_id
App Region ID.
INTEGER
ent_count
Number of entities in appl region.
Output:
STRING
geo_str[]
Geometry group = Geometry or FEM
STRING
app_list[VIRTUAL]
Application list.
INTEGER
<Return Value>
See error returned.
Comments:
This routine can be used to return multiple lists by returning the array ARID, increasing the number of PCL string pointer arguments, and filling them out.
Error Conditions:
26006004
Dynamic memory allocation error encountered.
Example:
Please see loadsbcs_get_appl_region_list (p. 983) in the MSC Acumen Toolkit - Code Example.
  
loadsbcs_lp_coord
( cid_list, cid_id )
 
Description:
Returns the coordinate system id (Expects there to be only one Coordinate system in the list).
Input:
STRING
cid_list[]
Coordinate System List.
Output:
INTEGER
cid_id
Coordinate System ID.
INTEGER
<Return Value>
See error returned.
Error Conditions:
26002205
No Coordinate Frame chosen. Select one.
26002210
Only one coordinate system is allowed. %I% coordinate systems were input.
26002215
Coordinate Frame List %A% is invalid.
Example:
Please see loadsbcs_lp_coord (p. 985) in the MSC Acumen Toolkit - Code Example.