PCL Reference Manual > Property Assignment Functions > Load Cases
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
Load Cases
This section explains the functions that pertain to load cases.
  
loadcase_create
(load_case_name, load_case_type, load_case_desc, lbc_name, priorities, dynamic_name, dynamic_value, make_current)
Description:
 
 
This function creates a new load case.
Input:
 
 
STRING
load_case_name[80]
This value specifies the new load case name.
STRING
load_case_type[31]
This value specifies the load case type and can be set to either “Static” or “Time Dependent”.
STRING
load_case_desc[256]
This value specifies the load case description.
STRING
lbc_name[31]()
This value specifies the load/BC set names to be associated with this load case.
INTEGER
priorities()
This value specifies the load/BCs set priorities. The default is 0 or add otherwise. The priority value can range from 1 to the number of load/BC sets, where 1 indicates the highest or top priority.
STRING
dynamic_name[80]
This value specifies the dynamic load case name which was used to generate the static load case at the specified dynamic value.
REAL
dynamic_value
This value specifies the dynamic value used to evaluate this static load case.
LOGICAL
make_current
This value is set to TRUE, if this load case should be made the current load case. If this value is set to FALSE, this load case will not be made the current load case.
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.
Remarks:
This function writes load case information to the database.
If the new load case created is the current load case then modify the display of Load/BC in the graphics window.
This function can display a fatal popup message form with the following messages:
This function can display a query popup message form with the following message:
This function can display an information popup message form with the following message:
Example:
Please see loadcase_create.
   
loadcase_delete
(load_case_name, delete_assoc_lbcs)
Description:
 
 
This function deletes a load case and can optionally delete the loads and boundary conditions associated with the load case.
Input:
 
 
STRING
load_case_name[]
This value specifies the name of load case to be deleted.
LOGICAL
delete_assoc_lbcs
This value specifies, when set to TRUE, that any associated Load/BCs are to be deleted. If this value is set to FALSE, associated Load/BCs will not be deleted.
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.
Remarks:
If a Load/BC is deleted the graphical display of Load/BCs in the graphics window will be updated.
This function can display a fatal popup message form with the following messages:
This function can display an information popup message form with the following message:
This function can display a warning popup message form with the following message:
Example:
Please see loadcase_delete. 
  
loadcase_modify
(load_case_name, new_name, load_case_type, load_case_desc, lbc_name, priorities, dynamic_name, dynamic_value, make_current)
Description:
 
 
This function modifies a load case in the database.
Input:
 
 
STRING
load_case_name[80]
This value specifies an existing load case name.
STRING
new_name[80]
This value specifies the new load case name.
STRING
load_case_type[31]
This value specifies the load case type and can be set to either “Static” or “Time Dependent”.
STRING
load_case_desc[256]
This value specifies the load case description.
STRING
lbc_name[31]()
This value specifies the load/BC set name to be associated with this load case.
INTEGER
priorities()
This value specifies the load/BCs set priorities. The default is 0 or add otherwise. The priority value can range from 1 to the number of load/BC sets, where 1 indicates the highest or top priority.
STRING
dynamic_name[80]
This value specifies the dynamic load case name which was used to generate the static load case at the specified dynamic value. Not used in Release 1.
REAL
dynamic_value
This value specifies the dynamic value used to evaluate this static load case. Not used in Release 1.
LOGICAL
make_current
This value is set to TRUE, if this load case should be made the current load case. If this value is set to FALSE, this load case will not be made the current load case.
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.
Remarks:
Modifies load case data in the database.
If the current load case is modified, then updates the graphical display of Load/BC in the graphics window.
This function can display a fatal popup message form with the following messages:
This function can display an information popup message form with the following message:
Example:
Please see loadcase_modify.
.  
loadcase_show
(load_case_name)
Description:
 
 
This function shows the attributes of the selected load case.
Input:
 
 
STRING
load_case_name[80]
This value specifies the load case name to be shown.
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.
Remarks:
This function can display a fatal popup message form with the following messages:
Example:
Please see loadcase_show.