Loads and Boundary Conditions (Chapter 11)

Tutorial Toolkit Function Descriptions > Obsolete, Modified, and Broken Functions > Loads and Boundary Conditions (Chapter 11)

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">


lbc_create Modified	The list of input and output arguments for this call have been changed. Changed list of input and output arguments in the documentation to correspond to those in the actual code.


Original Description Information:
lbc_create		(name, lbc_info, ar_id, sdbx_datatype, aplist1, aplist2, fem_flag, num_scl, data_id, lbc_sf, rsdat, scpos, scdyn, num_vec, null_flag, rvdat, null_var, vpos, vdyn, scmkr, scolor, vmkr, vcolor, nvslin, lbc_id )
Description:
Create the Loads and Boundary Condition Set (unevaluated, i.e., for positionally dependent quantities field references are store not actual values).
Input:
STRING	name[]	Load/BC Set Name - user specified.
INTEGER	lbc_info (8)	LBC info - type, cat, eldim, cid, dynflg, numar, anchor.
INTEGER	ar_id (2)	Appl Region db ID.
STRING	sdbx_datatype[]	Select databox datatype.
STRING	aplist1[]	Application Region 1 list.
STRING	aplist2[]	Application Region 2 list.
INTEGER	fem_flag	FEM Flag = FA_TRUE if FEM entities.
INTEGER	num_scl	Number of scalars.
INTEGER	data_id (10)	Variable Data db ID.
REAL	lbc_sf	LBC Set Scale Factor.
REAL	rsdat (10)	Real Scalar data.
INTEGER	scpos (10)	Pos Dep Scalar Data Field IDs.
INTEGER	scdyn (10)	Dyn Dep Scalar Data Field IDs.
INTEGER	num_vec	Number of vectors.
INTEGER	null_flag	Null vector flag = 1, if null allowed.
REAL	rvdat (10,3)	Real Vector data.
INTEGER	null_var (10,3)	Flag indicating whether this vector comp is null NULLV = -1 if null, 0 if not null.
INTEGER	vpos (10,3)	Pos Dep Vector Data Field IDs.
INTEGER	vdyn (10,3)	Dyn Dep Vector Data Field IDs.
INTEGER	scmkr (10)	Scalar marker types.
INTEGER	scolor (10)	Scalar colors (0-15).
INTEGER	vmkr (10)	Vector types.
INTEGER	vcolor (10)	Vector colors.
INTEGER	nvslin	Number of geometric visual lines.
Output:
INTEGER	lbc_id	Load/BC set ID.
INTEGER	<Return Value>	ISee error returned.
Error Conditions:
None.
Remarks:
None.
Examples:
None.


NewDescription Information:
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 (unevaluated, 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	Equals 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 NULLV = -1 if null, 0 if not null.
INTEGER	datatype (20)	Indicates datatype, 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>	ISee error returned.
Error Conditions:
None.
Remarks:
None.
Examples:
None.


lbc_get_sdbx_datatype Modified	The call is missing an input argument. Add the variable LBC_ID to the documentation for this call as the first input argument in the list.


Original Description Information:
lbc_get_sdbx_datatype		( 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:
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>	IReturns the success or failure of the routine.
Error Conditions:
None.
Remarks:
None.
Examples:
None.


New Description Information:
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>	IReturns the success or failure of the routine.
Error Conditions:
None.
Remarks:
None.
Examples:
None.


lbc_lp_parse_sca Modified	The call is missing an input argument. Add the variable DATATYPE to the documentation for this call as the second input argument in the list.


Original Description Information:
lbc_lp_parse_sca		(dval, fid, nulflg, rval )
Description:
Parse the data contained in the string DVAL. Verify that it is valid data (it is a real scalar or a scalar field).
Input:
STRING	dval[]	The string containing the property.
Output:
INTEGER	fid	Field ID.
INTEGER	nulflg	Flag Indicating if data is NULL.
REAL	rval	Value of DVAL.
INTEGER	<Return Value>	See error returned.
Error Conditions:
None.
Remarks:
None.
Examples:
None.


New Description Information:
lbc_lp_parse_sca		(dval, datatype, fid, nulflg, rval )
Description:
Parse the data contained in the string DVAL. Verify that it is valid data (it is a real scalar or a scalar field).
Input:
STRING	dval[]	The string containing the property.
INTEGER	datatype	Valid data type (app_lbc_defn_ids.i) (i.e., integer, real, node).
Output:
INTEGER	fid	Field ID.
INTEGER	nulflg	Flag Indicating if data is NULL.
REAL	rval	Value of DVAL.
INTEGER	<Return Value>	See error returned.
Error Conditions:
None.
Remarks:
None.
Examples:
None.


lbc_show_plot_marker Obsolete	The call no longer exists. It was replaced with the lbc_plot_markers call. Removed the call from the documentation.


Description:
Show the marker/vector plots for the given lbcs on the selected groups.
Input:
INTEGER	num_lbcs	Number of lbcs which should be displayed.
INTEGER	lbc_ids ( )	LBC ids.
INTEGER	num_grps	Number of groups to which graphics vector tables will be assigned.
INTEGER	grp_ids ( )	Group ids.
Output:
INTEGER	<Return Value>	See error returned.
Error Conditions:
None.
Remarks:
None.
Examples:
None.


lbc_plot_markers New	None. None.


lbc_show_plot_scalar Modified	The call is missing an input argument. Add the variable TYPE_ID to the documentation for this call as the second input argument in the list.


Original Description Information:
lbc_show_plot_scalar		(type_name, 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.
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:
None.
Remarks:
None.
Examples:
None.


New Description Information:
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	The 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:
None.
Remarks:
None.
Examples:
None.


loadsbcs_get_appl_region_list Modified	The list of input and output arguments for this call have been changed. Changed list of input and output arguments in the documentation to correspond to those in the actual code.


Original Description Information:
loadsbcs_get_appl_region_list		(id, num_ar, ent_count, ar_ids, geo_str, app_list, app_list2 )
Description:
Gets the application region entities - types, ids, and sub ids (if applicable) from the database.
Input:
INTEGER	id	Load/BC ID.
INTEGER	num_ar	Number of application regions.
INTEGER	ent_count ( )	Number of entities in appl region.
Output:
STRING	geo_str	Geometry group = Geometry or FEM.
STRING	app_list[VIRTUAL]	Application list.
STRING	app_list2[VIRTUAL]	Application list 2.
INTEGER	ar_ids ( )	IDs of the app regions.
INTEGER	<Return Value>	See error returned.
Error Conditions:
None.
Remarks:
None.
Example:
None.


New Description Information:
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.
Error Conditions:
None.
Remarks:
None.
Example:
None.


db_count_lbc_in_group Obsolete	The call no longer exists. Removed the call from the documentation.


Description:
Counts all lbcs in the specified group.
Input:
INTEGER	id	The ID of the group for which the count is requested.
Output:
INTEGER	count	The number of lbcs in the group.
INTEGER	<Return Value>	Returns the success or failure of the routine.
Error Conditions:
None.
Remarks:
None.
Examples:
None.


db_get_all_lbcs Obsolete	The call no longer exists. It was replaced with the db_get_all_lbcs_new call. Removed the call from the documentation.


Description:
Gets the LBC from the database.
Input:
None.
Output:
INTEGER	<Return Value>	Integer indicating success or failure of the routine.
Error Conditions:
None.
Remarks:
None.
Examples:
None.


db_get_all_lbcs_new New	None. None.


db_get_next_lbc Obsolete	The call no longer exists. It was replaced with the db_get_next_lbcs_new call. Removed the call from the documentation.


Description:
Gets next LBC from the database.
Input:
None.
Output:
INTEGER	id	The unique internal ID of the LBC type created in the database.
STRING	name[]	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	cat	The category of the LBC (nodal, element uniform or element variable).
INTEGER	ted	The target element dimensionality for this LBC.
INTEGER	cid	The cid of the alternate coordinate frame that was used to define this LBC (if any).
INTEGER	dflag	A flag indicating whether this is a dynamic or static LBC.
INTEGER	<Return Value>	Integer indicating success or failure of the routine.
Error Conditions:
None.
Remarks:
None.
Examples:
None.


db_get_next_lbcs_new New	None. None.


db_get_all_lbcs_in_group Obsolete	The call no longer exists. Removed the call from the documentation.


Description:
Gets all LBC entries in a specified group from the database in one array.
Input:
INTEGER	grpid	The group IDs to which the LBCs are to belong.
INTEGER	count	The storage that the calling routine has allocated for IDs.
Output:
INTEGER	id()	Array to contain the LBC IDs.
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:
None.
Remarks:
None.
Examples:
None.


db_get_all_lbc_var_defns Modified	The call is missing an input argument. Add the variable ID to the documentation for this call as the first input argument in the list.


Original Description Information:
db_get_all_lbc_var_defns		( )
Description:
Gets LBC variable for an LBC type definition 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:
None.
Remarks:
None.
Examples:
None.


New Description Information:
db_get_all_lbc_var_defns		( id )
Description:
Gets LBC variable for an LBC type definition from the database.
Input:
INTEGER	id	LBC ID.
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:
None.
Remarks:
None.
Examples:
None.


db_get_lbc_type_defn Modified	This call is missing its <Return Value> variable. Added the <Return Value> variable to the output argument list.


Original Description Information:
db_get_lbc_type_defn		(name, id, class, form, gbc, cid, g_sym, sv, nv, nbr_ac, an_code, defcol, cbid, anstyl )
Description:
Gets all LBC type definitions from the database, in get all, get next method.
Input:
STRING	name[]	The name of the LBC type in the database.
Output:
INTEGER	id	The unique internal ID of the LBC type in the database.
INTEGER	class	The class of the LBC type (Structural, Thermal, Other).
INTEGER	form	The form of the LBC (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 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.
Error Conditions:
None.
Remarks:
None.
Examples:
None.


New Description Information:
db_get_lbc_type_defn		(name, id, class, form, gbc, cid, g_sym, sv, nv, nbr_ac, an_code, defcol, cbid, anstyl )
Description:
Gets all LBC type definitions from the database, in get all, get next method.
Input:
STRING	name[]	The name of the LBC type in the database.
Output:
INTEGER	id	The unique internal ID of the LBC type in the database.
INTEGER	class	The class of the LBC type. (Structural, Thermal, Other)
INTEGER	form	The form of the LBC. (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:
None.
Remarks:
None.
Examples:
None.


db_get_lbc_var_defn Modified	This call is missing its <Return Value> variable. Added the <Return Value> variable to the output argument list.


Original Description Information:
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.
Error Conditions:
None.
Remarks:
None.
Examples:
None.


New Description Information:
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>	Integer indicating success or failure of the routine.
Error Conditions:
None.
Remarks:
None.
Examples:
None.