Tutorial Toolkit Function Descriptions > Results > General
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
General
 
db_count_result_types_for_elem
(elementId, resultTypeCount)
Description:
Given an elementId, count all the unique result types used by it.
Input:
INTEGER
elementId
The element ID.
Output:
INTEGER
resultTypeCount
Count of all the unique result types used by the given element ID.
INTEGER
<Return Value>
.Integer indicating the success or failure of the routine.
Error Conditions:
None.
Remarks:
None.
Example:
Please see db_count_result_types_for_elem (p. 1320) in the MSC Acumen Toolkit - Code Example.
 
db_get_results_file_suffix
(name, suffix)
Description:
Retrieves the results file suffix associated with the named analysis code.
Input:
STRING
name[31]
Name of the analysis code for which the suffix is to be retrieved.
Output:
STRING
suffix[6]
Location into which the named suffix is to be retrieved.
INTEGER
<Return Value>
Success or failure of routine.
Error Conditions:
13000002
Unrecoverable database error
13000007
An unspecified database error occurred
Remarks:
None.
Example:
Please see db_get_results_file_suffix (p. 1323) in the MSC Acumen Toolkit - Code Example.
 
db_get_elem_scalar_name
(scalar_id, name)
 
Description:
This function retrieves the name of an element scalar table from the database.
Input:
INTEGER
scalar_id
This value specifies an identifier for an element scalar table in the database.
Output:
STRING
name[]
The value returns the name of the specified element scalar table. This name is used for display purposes only and is not a unique table identifier.
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
Remarks:
Accesses one record in the “graphics_elem_scalar” table in the database.
Example:
Please see db_get_elem_scalar_name (p. 1321) in the MSC Acumen Toolkit - Code Example.
 
jobfile.create_jobname
( )
 
Description:
This function creates a jobname for an analysis. It returns error conditions for the jobname creation as an output.
Input:
None
Output:
INTEGER
<Return Value>
The status of the execution. Returns 0 for successful completion and an error code in case of error.
Error Conditions:
13000002
 
Unrecoverable database error.
13000004
 
Duplicate entry for jobname.
13000007
 
An unspecified database error occured.
13000158
 
Jobname already exists in the database.
13000159
 
Jobname id not found in the database.
Example:
Please see jobfile.create_jobname (p. 1325) in the MSC Acumen Toolkit - Code Example.
 
jobfile.create_param
( <label>, <int_value >,<real_value>,<string_value>, <param_type>)
  
Description:
This function creates a parameter for the current parameter set of the type indicated. Every new jobname or subcase is referenced by a new param_set_id. All the parameters for the jobname or subcase can be accessed through this param_set_id. This function (jobfile.create_param) writes the parameter name and assigns its value, first in the jobfile and then in the database. The parameter can be of type string, integer or real. For example, if a string “Load_case” is passed in the first argument, it creates a new param_set_id. Subsequent functions will define the other parameters. This function also creates a new step when the load case parameter is encountered in the label string. It also increments the version of the file search path parameter when it is encountered.
Input:
STRING
label [ ]
The parameter name to create.
INTEGER
int_value
The integer value to be assigned to the parameter.
REAL
real_value
The real value to be assigned to the parameter.
STRING
string_value[ ]
The string value to be assigned to the parameter.
INTEGER
para_type
The type of parameter to be added.
1 -INTEGER
3 - REAL
4 - STRING.
Output:
INTEGER
<Return Value>
Returns 0 for successful execution, else returns the error code.
Error Conditions:
13000002
 
Unrecoverable database error.
13000007
 
An unspecified database error occured.
13000052
 
Load case not found.
13000204
 
The specified analysis step not found.
Example:
Please see jobfile.create_param (p. 1326) in the MSC Acumen Toolkit - Code Example.
  
jobfile.eval_list
( <list>, <sublist_filter>)
Description:
This function sorts the values in the string ‘list[ ]’in the form of a real or integer array. This function should be followed by function jobfile.write_array_as_list to write the array to the jobfile. Refer to file ‘lpenums.i’ for values of sublist filters.
Input:
STRING
list [ ]
The values of the array in string format.
INTEGER
sublist_filter
The type of array. Refer to file ‘lpenums.i’ for values.
512 - if the list contain nodes.
1024 - if the list contain elements.
16348 - if the list contain real values.
8192 - if the list contain integer values.
Output:
INTEGER
< Return_status>
Returns 0 on successful execution.
Error Conditions:
14000045
 
Improper input list.
Example:
Please see jobfile.eval_list (p. 1328) in the MSC Acumen Toolkit - Code Example.
  
jobfile.write_array_as_list
(<label>, <value_format>, <num_values_on_line>)
Description:
This function writes values of an array in string format to the jobfile. The array is specified by the function jobfile.eval_list(). ‘Value_format’ is a string to specify the format for the array as per the string input/output routines.
Input:
STRING
label [ ]
The label text to be written to the jobfile.
STRING
value_format [ ]
The format for the array values (i.e. “%I2.2%”, “%G2%”.)
INTEGER
num_values_on_line
The value to specify the number of values to be written on a single line in the jobfile.
Output:
INTEGER
< Return_status>
Returns a 0 on successful execution.
Error Conditions:
None
Example:
Please see jobfile.write_array_as_list (p. 1329) in the MSC Acumen Toolkit - Code Example.
  
jobfile.write_element_list
( <label>, <element_list>)
Description:
This function writes element numbers from the string in the databox as string format to the jobfile. The element_list[ ] should start with ‘elm’ or ‘Element’ for the function to get executed.
Input:
STRING
label [ ]
The label text to be written to the jobfile.
STRING
element_list [ ]
The element numbers in string format to be written to the jobfile.
Output:
None
Error Conditions:
None
Example:
Please see jobfile.write_element_list (p. 1331) in the MSC Acumen Toolkit - Code Example.
  
jobfile.write_integer_list
( <label>, <integer_value>)
Description:
This function writes integer values from the databox in string format to the jobfile.
Input:
STRING
label [ ]
The text to be written to the jobfile.
STRING
integer_value [ ]
The integer values in string format to be written to the jobfile.
Output:
None
Error Conditions:
None
Example:
Please see jobfile.write_integer_list (p. 1333) in the MSC Acumen Toolkit - Code Example.
  
jobfile.write_node_list
( <label>, <node_list>)
Description:
This function writes node numbers from the string in the databox in string format to the jobfile. The node_list[ ] should start with ‘node’ for the function to get executed.
Input:
STRING
label [ ]
The label text to be written to the jobfile.
STRING
node_list [ ]
The node list in string format to be written to the jobfile.
Output:
None
Error Conditions:
None
Example:
Please see jobfile.write_node_list (p. 1334) in the MSC Acumen Toolkit - Code Example.
  
jobfile.write_real_list
( <label>, <real_value>)
Description:
This function writes real values from the databox in string format to the jobfile.
Input:
STRING
label [ ]
The text to be written to the jobfile.
STRING
real_value[ ]
The real values in string format to be written to the jobfile.
Output:
None
Error Conditions:
None
Example:
Please see jobfile.write_real_list (p. 1336) in the MSC Acumen Toolkit - Code Example.
  
jobfile.write_stream
( <label>, <int_value >, <real_value>,<string_value>)
Description:
This function writes text (a formatted string) with the integer, real and string values (defined in the other arguments) to the jobfile. The format of the values is specified in the label argument. The function jobfile.write_stream() can be used in this way:
jobfile.write_stream("The values are : integer value : %I%, real value : %G% and string value:%A%",15, 5.5, "test string ")
This will write the following statement to the jobfile:
The values are : integer value : 15, real value : 5.5 and string value: test string.
%I%, %G%, %A% are formats to specify integer, real and string values respectively.
Input:
STRING
label [ ]
The text to be written to the jobfile.
INTEGER
int_value
The integer value to be written in the text to the jobfile.
REAL
real_value
The real value to be written in the text to the jobfile.
STRING
string_value[ ]
The string value to be written in the text to the jobfile.
Output:
None
Error Conditions:
None
Example:
Please see jobfile.write_stream (p. 1337) in the MSC Acumen Toolkit - Code Example.
  
jobfile.write_string
(<label>,<value>)
Description:
This function will write a statement “label” = “value” to the jobfile opened by the jobfile.open() function. For total text length exceeding 80 characters, it is written to the next line in the jobfile. For instance, if the user wants to specify that the output should be in the form of an .op2 file only, then the command is: jobfile.write_string(“DATA OUTPUT”,”OP2 ONLY”). This will write the following statement to the jobfile: DATA OUTPUT = OP2 ONLY.
Input:
STRING
label [ ]
The name of the parameter.
STRING
value [ ]
The value for the parameter.
Output:
INTEGER
<Return Value>
Returns 0 for success, else returns the error code.
Error Conditions:
6013024
 
The maximum number of characters that can be written to the control file for a parameter is 240.
Example:
Please see jobfile.write_string (p. 1339) in the MSC Acumen Toolkit - Code Example.
 
jobfile.writer
( <label>, <real_value>)
 
Description:
This function writes real values to the jobfile. The format is ‘label = real_value’.
Input:
STRING
label [ ]
The label to be written to the jobfile.
REAL
real_value
The real value to be written to the jobfile.
Output:
None
Error Conditions:
None
Example:
Please see jobfile.writer (p. 1340) in the MSC Acumen Toolkit - Code Example.
  
jobfile.writeS1
(<label>,<rl_val>)
Description:
This function will write an array of one real value to the jobfile opened by the jobfile.open() function.
Input:
STRING
label [ ]
The name of the parameter.
REAL
rl_val (1)
The array of one real value to be written.
Output:
None
Error Conditions:
None
Example:
Please see jobfile.writeS1 (p. 1341) in the MSC Acumen Toolkit - Code Example.
  
jobfile.writeS2
(<label>,<rl_val>)
 
Description:
This function will write an array of two real values to the jobfile opened by the jobfile.open() function.
Input:
STRING
label [ ]
The name of the parameter.
REAL
rl_val (2)
The array of two real values to be written
Output:
None
Error Conditions:
None
Example:
Please see jobfile.writeS2 (p. 1343) in the MSC Acumen Toolkit - Code Example.
 
jobfile.writeS3
(<label>,<rl_val>)
 
Description:
This function will write an array of three real values to the jobfile opened by the jobfile.open() function.
Input:
STRING
label [ ]
The name of the parameter.
REAL
rl_val (3)
The array of three real values to be written
Output:
None
Error Conditions:
None
Example:
Please see jobfile.writeS3 (p. 1344) in the MSC Acumen Toolkit - Code Example.
  
jobfile.writeS4
(<label>,<rl_val>)
Description:
This function will write an array of four real values to the jobfile opened by the jobfile.open() function.
Input:
STRING
label [ ]
The name of the parameter.
REAL
rl_val (4)
The array of four real values to be written
Output:
None
Error Conditions:
None
Example:
Please see jobfile.writeS4 (p. 1345) in the MSC Acumen Toolkit - Code Example.
  
jobfile.writeSS
(<label>,<int_val>)
Description:
This function will write an array of two integer values to the jobfile opened by the jobfile.open() function.
Input:
STRING
label [ ]
The name of the parameter.
INTEGER
int_val (2)
The array of two integer values to be written
Output:
None
Error Conditions:
None
Example:
Please see jobfile.writeSS (p. 1347) in the MSC Acumen Toolkit - Code Example.
 
 
rdm_result_minmax_get
( group_name, min, max)
 
Description:
This function obtains the minimum and maximum values from the current “active” result which is controlling the current viewport spectrum/range.
Input:
STRING
group_name[]
The current viewport spectrum range.
Output:
REAL
min
Minimum value of results.
REAL
max
Maximum value of results.
Error Conditions:
None.
Example:
Please see rdm_result_minmax_get (p. 1348) in the MSC Acumen Toolkit - Code Example.
  
res_db_cgetlayerposids
(<rescase_id>,<rt_id>,<nlayers>,<layerposids>)
Description:
This function will retrieve a list of layers of a result type in a given result case
Input:
INTEGER
rescase_id
Result case id
INTEGER
rt_id
Result type id
Output:
INTEGER
nlayers
Number of layers
INTEGER
layerposids()
Layer position ids
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 res_db_cgetlayerposids (p. 1351) in the MSC Acumen Toolkit - Code Example.
 
res_db_cgetrescases
(<num_ldcases>,<loadcase_id>,<subcase_id>,<rescase_id>)
  
Description:
This function will retrieve result case ids.
Input:
INTEGER
num_ldcases
Number of load cases
INTEGER
loadcase_id()
Load case ids
INTEGER
subcase_id()
Subcase ids
Output:
INTEGER
rescase_id()
Result case ids.
INTEGER
<Return Value>
Returns 0 for success, otherwise return the error code.
Error Conditions:
See the Status Message(Ch 11) for information on any error values returned by this function.
Example:
Please see res_db_cgetrescases (p. 1353) in the MSC Acumen Toolkit - Code Example.
 
res_utl_create_elem_result
( resultids, primary_title, secondary_title, cnt, ids, cidlist, datatype, location, nresults, results)
Description:
This function creates new result case and writes to the database. The new result case can be displayed in the viewport. The primary results id and secondary results ids are created newly by passing some input value to the function.
Input:
INTEGER
resultids(5)
Array of the results case ids i.e. load case id, subcase id, primary case id, secondary case id and layer case id.
The primary id and secondary id are not used as inputs by this function. This value is used as both as input and an outputs to the function and would be passed by the calling function as a single argument.
STRING
primary_title[]
This value specifies the primary result title.
STRING
secondary_title[]
This value specifies the secondary result title.
INTEGER
cnt
Number of Element results returned.
INTEGER
ids(VIRTUAL)
Array of the extracted elem ids.
STRING
cidlist[]
List format of a coordinate system for vector and tensor transformations. NULL string will be interpreted as no transformation.
INTEGER
datatype
This value returns the datatype i.e.
Scalar =1, Vector = 2, Tensor =3
STRING
location[]
This value specifies the location of the coordinate frame identifier. “A[sis]”, “C[entroid], “N[odal] or ““ = “A[sis]”
INTEGER
nresults(VIRTUAL)
Array of the results per element.
REAL
results(VIRTUAL)
Array of the extracted results.
Output:
INTEGER
resultids(5)
Array of the results case ids i.e. load case id, subcase id, primary case id, secondary case id and layer case id. The load case, sub case and layer ids are not used as output values by this function.
The primary id and secondary id are used as outputs by this function. This value is used as both as input and an outputs to the function and would be passed by the calling function as a single argument.
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:
None
Example:
Please see res_utl_create_elem_result (p. 1355) in the MSC Acumen Toolkit - Code Example.
 
res_utl_extract_elem_history2
(nrc, lcids, subids, resultids, elem_list, derivation, location, cidlist, avg_method, avg_domain, extrap_method, complex_form, complex_angle, datatype, resloc, cnt, ids, nresults, results, min_loc, max_loc)
Description:
This function will extract the specified results data from the database. Extrapolation and averaging will be performed as necessary when element based results are requested. The result datatype returned will be determined by the derivation method. This routine will return scalar, vector and tensor data. Apart from that it also gives an array index for each minimum and maximum element result component.
Input:
INTEGER
nrc
Number of input loadcases.
INTEGER
lcids(virtual)
Loadcase ids array.
INTEGER
subids(virtual)
Subcase id array.
INTEGER
resultids(3)
Primary id, secondary id and layer id.
STRING
elem_list[]
List of element ids
STRING
derivation[]
Derivation Specifier:
Tensor to Scalar: “VONM”, “OCT”, “HYDRO”, “INV1”, “INV2”, “INV3”, “MAXSHR”, “MAXCMP”, “MINCMP”, “P1”, “P2”, “P3”, “XX”, “YY”, “ZZ”, “XY”, “YZ”, “ZX”,
Tensor to Vector: “PV1”, “PV2”, “PV3”, any 3 component initials (“XXYYZZ”)
Vector to Scalar: “X”, “Y”, “Z”, “MAG”, “MINCMP”, “MAXCMP”, “AVG”
STRING
location[]
Location Specifier:
“A[sis]”, “C[entroid], “N[odal] or ““ = “A[sis]”
STRING
cidlist[]
List format of a coordinate frame.
NULL will be interpreted as no transformation.
STRING
avg_method[]
Average Method string (see below).
STRING
avg_domain[]
Average Domain string (see below).
STRING
extrap_method[]
Extrapolation Method string (see below).
STRING
complex_form[]
Complex form string (see below).
REAL
complex_angle
Used with complex results when complex form is “Angle”.
Output:
INTEGER
datatype
Scalar =1, Vector = 2, Tensor =3
INTEGER
resloc
Centroid =1, Nodal =2, Multiple =3
INTEGER
cnt
Number of nodal results returned .
INTEGER
ids(virtual)
Array of the extracted elem ids.
INTEGER
nresults(virtual)
Array of the results per element.
REAL
results(virtual)
Array of the extracted results.
INTEGER
min_loc(virtual)
Subcase ID for each elem min component.
INTEGER
max_loc(virtual)
Subcase ID for each elem max component.
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:
The input value avg_method can have the following values:
“DeriveAverage”, “AverageDerive”, “Difference”, “Sum”
The input value avg_domain can have the following values:
“All”, “Material”, “Property”, “EType”, “Target”, “Element”
The input value extrap_method can have the following values:
“ShapeFunc”, “Average”, “Centroid”, “Max”, “Min”, “AsIs”
The input value complex_form can have the following values:
“Real”, “Imaginary”, “Magnitude”, “Phase”, “Angle”
Example:
Please see res_utl_extract_elem_history2 (p. 1359) in the MSC Acumen Toolkit - Code Example.
res_utl_extract_elem_results2
(resultsids, elem_list, derivation, location, cidlist, avg_method, avg_domain, extrap_method, complex_form, complex_angle, datatype, resloc, cnt, ids, nresults, results, min_loc, max_loc)
Description:
This function extracts the specified results data from the database. Extrapolation and averaging will be performed as necessary when element based results are requested. The result datatype returned will be determined by the derivation method. This routine will return scalar, vector and tensor data. Apart from that it also gives an array index for each minimum and maximum element result component.
Input:
INTEGER
resultsids()
Array of the results case ids i.e. load case id, subcase id, primary case id, secondary case id and layer case id.
STRING
elem_list[]
List of element ids for which to extract results.
STRING
derivation[]
Derivation Specifier:
Tensor to Scalar: “VONM”, “OCT”, “HYDRO”, “INV1”, “INV2”, “INV3”, “MAXSHR”, “MAXCMP”, “MINCMP”, “P1”, “P2”, “P3”, “XX”, “YY”, “ZZ”, “XY”, “YZ”, “ZX”,
Tensor to Vector: “PV1”, “PV2”, “PV3”, any 3 component initials (“XXYYZZ”)
Vector to Scalar: “X”, “Y”, “Z”, “MAG”, “MINCMP”, “MAXCMP”, “AVG”
STRING
location[]
This value specifies the location of the coordinate frame identifier. “A[sis]”, “C[entroid], “N[odal] or ““ = “A[sis]”
STRING
cidlist[]
List format of a coordinate system for vector and tensor transformations. NULL string will be interpreted as no transformation.
STRING
avg_method[]
Average Method string (see below).
STRING
avg_domain[]
Average Domain string (see below).
STRING
extrap_method[]
Extrapolation Method string (see below).
STRING
complex_form[]
Complex form string (see below).
REAL
complex_angle
Used with complex results when complex form is “Angle”
Output:
INTEGER
datatype
This value returns the datatype i.e.
Scalar =1, Vector = 2, Tensor =3
INTEGER
resloc
This value returns the result location. Valid value are :
Centroid =1, Nodal =2, Multiple =3
INTEGER
cnt
Number of Element results returned.
INTEGER
ids()
Array of the extracted elem ids.
INTEGER
nresults()
Array of the results per element.
REAL
results()
Array of the extracted results.
INTEGER
min_loc()
Subcase ID for each elem minimum component.
INTEGER
max_loc()
Subcase ID for each elem maximum component.
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 database.
Remarks:
The input value avg_method can have the following values:
“DeriveAverage”, “AverageDerive”, “Difference”, “Sum”
The input value avg_domain can have the following values:
“All”, “Material”, “Property”, “EType”, “Target”, “Element”
The input value extrap_method can have the following values:
“ShapeFunc”, “Average”, “Centroid”, “Max”, “Min”, “AsIs”
The input value complex_form can have the following values:
“Real”, “Imaginary”, “Magnitude”, “Phase”, “Angle”
Example:
Please see res_utl_extract_elem_results2 (p. 1363) in the MSC Acumen Toolkit - Code Example.
res_utl_extract_nodal_history2
(nrc, lcids, subids, resultids, node_list, derivation, cidlist, avg_method, avg_domain, extrap_method, complex_form, complex_angle, datatype, cnt, ids, results, min_loc, max_loc)
Description:
This function will extract the specified results data from the database. Extrapolation and averaging will be performed as necessary when nodes based results are requested. The result datatype returned will be determined by the derivation method. This routine will return scalar, vector and tensor data. Apart from that it also gives an array index for each minimum and maximum nodal result component.
Input:
INTEGER
nrc
Number of result cases to be extracted.
INTEGER
lcids()
Loadcase ids array.
INTEGER
subids()
Subcase id array.
INTEGER
resultids()
Primary id, secondary id and layer id.
STRING
elem_list[]
List of nodes ids at which to extract results.
STRING
derivation[]
Derivation Specifier:
Tensor to Scalar: “VONM”, “OCT”, “HYDRO”, “INV1”, “INV2”, “INV3”, “MAXSHR”, “MAXCMP”, “MINCMP”, “P1”, “P2”, “P3”, “XX”, “YY”, “ZZ”, “XY”, “YZ”, “ZX”,
Tensor to Vector: “PV1”, “PV2”, “PV3”, any 3 component initials (“XXYYZZ”)
Vector to Scalar: “X”, “Y”, “Z”, “MAG”, “MINCMP”, “MAXCMP”, “AVG”
STRING
cidlist[]
List format of a coordinate system for vector/tensor transformations. NULL will be interpreted as no transformation.
STRING
avg_method[]
Average Method string (see below).
STRING
avg_domain[]
Average Domain string (see below).
STRING
extrap_method[]
Extrapolation Method string (see below).
STRING
complex_form[]
Complex form string (see below).
REAL
complex_angle
Used with complex results when complex form is “Angle”.
Output:
INTEGER
datatype
This value returns the data type. Valid values are:
Scalar =1, Vector = 2 and Tensor =3
INTEGER
cnt
Number of Nodal results returned
INTEGER
ids()
Array of the extracted nodes ids
REAL
results()
Array of the extracted results at all the specified nodes.
INTEGER
min_loc()
Subcase ID for each node as minimum component
INTEGER
max_loc()
Subcase ID for each node as maximum component
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:
The input value avg_method can have the following values:
“DeriveAverage”, “AverageDerive”, “Difference”, “Sum”
The input value avg_domain can have the following values:
“All”, “Material”, “Property”, “EType”, “Target”, “Element”
The input value extrap_method can have the following values:
“ShapeFunc”, “Average”, “Centroid”, “Max”, “Min”, “AsIs”
The input value complex_form can have the following values:
“Real”, “Imaginary”, “Magnitude”, “Phase”, “Angle”
Example:
Please see res_utl_extract_nodal_history2 (p. 1366) in the MSC Acumen Toolkit - Code Example.
res_utl_extract_nodal_results2
(resultsids, node_list, derivation, cidlist, avg_method, avg_domain, extrap_method, complex_form, complex_angle, datatype, cnt, ids, results, min_loc, max_loc)
Description:
This function extracts the specified results data from the database. Extrapolation and averaging will be performed as necessary when nodal based results are requested. The result datatype returned will be determined by the derivation method. This routine will return scalar, vector and tensor data. Apart from that it also gives an array index for each minimum and maximum nodes result component.
Input:
INTEGER
resultsids()
Array of the results case ids i.e. load case id, subcase id, primary case id, secondary case id and layer case id.
STRING
node_list[]
List of nodes ids for which to extract results.
STRING
derivation[]
Derivation Specifier:
Tensor to Scalar: “VONM”, “OCT”, “HYDRO”, “INV1”, “INV2”, “INV3”, “MAXSHR”, “MAXCMP”, “MINCMP”, “P1”, “P2”, “P3”, “XX”, “YY”, “ZZ”, “XY”, “YZ”, “ZX”,
Tensor to Vector: “PV1”, “PV2”, “PV3”, any 3 component initials (“XXYYZZ”)
Vector to Scalar: “X”, “Y”, “Z”, “MAG”, “MINCMP”, “MAXCMP”, “AVG”
STRING
cidlist[]
List format of a coordinate system for vector and tensor transformations. NULL string will be interpreted as no transformation.
STRING
avg_method[]
Average Method string (see below).
STRING
avg_domain[]
Average Domain string (see below).
STRING
extrap_method[]
Extrapolation Method string (see below).
STRING
complex_form[]
Complex form string (see below).
REAL
complex_angle
Used with complex results when complex form is “Angle”
Output:
INTEGER
datatype
This value returns the dta type i.e.
Scalar =1, Vector = 2, Tensor =3
INTEGER
cnt
Number of Nodal results returned.
INTEGER
ids()
Array of the extracted nodes ids.
REAL
results()
Array of the extracted results.
INTEGER
min_loc()
Subcase ID for each node minimum component.
INTEGER
max_loc()
Subcase ID for each node maximum component.
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 database.
Remarks:
The input value avg_method can have the following values:
“DeriveAverage”, “AverageDerive”, “Difference”, “Sum”
The input value avg_domain can have the following values:
“All”, “Material”, “Property”, “EType”, “Target”, “Element”
The input value extrap_method can have the following values:
“ShapeFunc”, “Average”, “Centroid”, “Max”, “Min”, “AsIs”
The input value complex_form can have the following values:
“Real”, “Imaginary”, “Magnitude”, “Phase”, “Angle”
Example:
Please see res_utl_extract_nodal_results2 (p. 1370) in the MSC Acumen Toolkit - Code Example.
 
res_utl_transform_nodal_results
(node_count, node_ids, cid, ncomp, resvals)
Description:
This function transforms the specified nodal results for specified coordinate system.
Input:
INTEGER
node_count
Number of nodal results returned.
INTEGER
node_ids()
Array of the extracted nodes ids.
INTEGER
cid
Coordinate frame identifier.
INTEGER
ncomp
This value specifies the number of component as 1, 3 or 6.
REAL
resvals()
Array of the specified results.
Output:
REAL
resvals()
Array of the transformed results.
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:
4500015
The Specified Cordinate Frame Id does not exist.
Example:
Please see res_utl_transform_nodal_results (p. 1374) in the MSC Acumen Toolkit - Code Example.
 
vki_db_getresid
(<rescase_id>,<prires_id>,<secres_id>)
 
Description:
This function will retrieve result type id from the database.
Input:
INTEGER
rescase_id
Result case id.
INTEGER
prires_id
Primary result id.
INTEGER
secres_id
Secondary result id.
Output:
INTEGER
rt_id <Return Value>
Result type id.
Error Conditions:
NONE
Example:
Please see vki_db_getresid (p. 1377) in the MSC Acumen Toolkit - Code Example.
  
xy_curve_results_set_wnd
( <window_name>, <num_points >, <curve_name>, <x_values>, <y_values> )
Description:
This function opens a window and draws a graph using given number of points and the array for coordinates of the points. The function internally sets the array size for the x and y values. It returns an integer with 0 as success condition or the error code in case of failure.
Input:
STRING
window_name[ ]
The name of the window to open the X-Y curve.
INTEGER
num_points
Number of points to decide the curve
STRING
curve_name[ ]
The name to be assigned to the curve
REAL ARRAY
x_values()
The array of real values of the x values of the points on the curve.
REAL ARRAY
y_values()
The array of real values of the y values of the points on the curve.
Output:
INTEGER
<Return Value>
0 for success or the error code for failure.
Error Conditions:
130000007
 
Database not open.
Example:
Please see xy_curve_results_set_wnd (p. 1379) in the MSC Acumen Toolkit - Code Example.