fields_create | (field_name, object_type, extrap_method, field_type, coord_type, coord_frame, geom_entity, definition_type, num_active_var, ind_variable_1, ind_variable_2, ind_variable_3, field_function_1, field_function_2, field_function_3, linear_definition, var1_values, var2_values, var3_values, field_values) |
Description: | ||
This function creates a new field in the database. | ||
Input: | ||
STRING | field_name[31] | This value specifies the new field name. |
STRING | object_type[31] | This value specifies the object type: “Spatial”, “Non-Spatial”, “Material”, or “Time Dependent”. |
INTEGER | extrap_method | This value specifies the extrapolation method: 1 = “Use closest table value, 2 = “Linear extrapolation,” and 3 = “Set value to zero”. |
STRING | field_type[31] | This value specifies the type: “Scalar”, “Vector”, or “Complex Scalar”. |
STRING | coord_type[31] | This value specifies the coordinate frame type: “Real” or “Parametric”. |
STRING | coord_frame[31] | This value specifies the coordinate frame. It is not used for spatial parametric fields. |
STRING | geom_entity[31] | This value specifies the geometric entity used for spatial parametric fields. |
STRING | definition_type[31] | This value specifies the definition: “Function” or “Table”. |
INTEGER | num_active_var | This value specifies the number of active independent variables or dimension. |
STRING | ind_variable_1[31] | This value specifies the independent variable 1. For Spatial: “X,” “R,” or “C1”. For Material: “T”. For Non-Spatial: “t”, “f”, “T”, “u”, “v”, “UD”, “fri”, “fmpd”, or “fmpr”. For Time Dependent: “t”. Note that “fri”, “fmpd”, or “fmpr” must be used for complex-valued functions of frequency. “fri” indicates that the complex terms are real-imaginary; “fmpd” indicates magnitude-phase (degrees), and “fmpr”, magnitude-phase (radians). |
STRING | ind_variable_2[31] | This value specifies the independent variable 2. For Spatial: “Y,” “T,” or “C2”. For Material: “e”. For Non-Spatial: “t”, “f”, “T”, “u”, “v”, “UD”, “fri”, “fmpd”, or “fmpr”. For Time Dependent: invalid. Note that “fri”, “fmpd”, or “fmpr” must be used for complex-valued functions of frequency. “fri” indicates that the complex terms are real-imaginary; “fmpd” indicates magnitude-phase (degrees), and “fmpr”, magnitude-phase (radians). |
STRING | ind_variable_3[31] | This value specifies the independent variable 3. For Spatial: “Z,” “P,” or “C3”. For Material: “er”. For Non-Spatial: “t”, “f”, “T”, “u”, “v”, “UD”, “fri”, “fmpd”, or “fmpr”. For Time Dependent: invalid. Note that “fri”, “fmpd”, or “fmpr” must be used for complex-valued functions of frequency. “fri” indicates that the complex terms are real-imaginary; “fmpd” indicates magnitude-phase (degrees), and “fmpr”, magnitude-phase (radians). |
STRING | field_function_1[] | This value specifies the first field function which can manipulate either scalar or vector values. |
STRING | field_function_2[] | This value specifies the second field function which can manipulate vector values. |
STRING | field_function_3[] | This value specifies the third field function which can manipulate vector values. |
LOGICAL | linear_definition | This value specifies, when set to TRUE, that spatial parametric tables be used. If this value is set to FALSE, spatial parametric tabular fields are not used. |
REAL | var1_values() | |
This value specifies a one-dimensional array of tabular “X”, “R”, or “C1” for Spatial, “T” for Material, “t”, “f”, “T, “u”, “v”, “UD”, “fri”, “fmpd”, or “fmpd” for Non-Spatial, or “t” for Time Dependent values. | ||
REAL | var2_values() | |
This value specifies a one-dimensional array of tabular “Y”, “T”, or “C2” for Spatial, “e” for Material values, or “t”, “f”, “T”, “u”, “v”, “UD”, “fri”, “fmpd”, or “fmpd” for Non-Spatial values. | ||
REAL | var3_values() | |
This value specifies a one-dimensional array of tabular “Z”, “P”, or “C3” for Spatial, “er” for Material values, or “t”, “f”, “T”, “u”, “v”, “UD”, “fri”, “fmpd”, or “fmpd” for Non-Spatial values. | ||
REAL | field_values() | |
This array contains the field values for all data points. It is only applicable for tabular fields. Use a single zero if not applicable. For real-valued fields its dimensions must be len1 x len2 x len3, where len1, len2, and len3 are the lengths of the arrays var1_values, var2_values, and var3_values, respectively. For complex-valued fields its dimensions must be 2 x len1 x len2 x len3, with all of the first complex component terms preceding all second component terms. That is, all reals precede all imaginaries and all magnitudes precede all phases. | ||
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. |
fields_create_dfem | (field_name, entity_type, type, num_entities, entities, value) |
Description: | ||
This function creates a new Load/BC field in the database. | ||
Input: | ||
STRING | field_name[31] | This value specifies the new field name. |
STRING | entity_type[31] | This value specifies the entity type: “Node” or “Element”. |
STRING | type[31] | This value specifies the type: “Scalar” or “Vector”. |
INTEGER | num_entities | This value specifies the number of entities in the field. |
STRING | entities[](num_entities) | |
This value specifies the names of the entities to be associated with the field. | ||
STRING | values[](num_entities) | |
This value specifies an array of scalars or vectors, depending on field type. If the <type> is “Vector”, either a vector or a node ID may be specified. | ||
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. |
fields_create_dfem_v2 | (field_name, object_type, entity_type, type, num_entities, entities, dynamic_var, extrap_method, num_steps, steps, values) |
Description: | ||
This function creates a new Load/BC field in the database. | ||
Input: | ||
STRING | field_name[31] | This value specifies the new field name. |
STRING | object_type[] | This value specifies the object type: “Spatial” or “Non-Spatial”. |
STRING | entity_type[31] | This value specifies the entity type: “Node” or “Element”. |
STRING | type[31] | This value specifies the type: “Scalar” or “Vector”. |
INTEGER | num_entities | This value specifies the number of entities in the field. |
STRING | entities[](num_entities) | |
This value specifies the names of the entities to be associated with the field. | ||
STRING | dynamic_var[] | This value specifies the dynamic variable: “t” for time,“f” for frequency or ““ for non-dynamic. |
INTEGER | extrap_method | This value specifies the extrapolation method: 1 = “Use closest table value, 2 = “Linear extrapolation,” and 3 = “Set value to zero”. |
INTEGER | num_steps | This value specifies the number of dynamic steps. For “Non-Spatial” only. |
REAL | steps(num_steps) | This value specifies an array of dynamic step values. For “Non-Spatial” only. |
STRING | values[](num_entities) | |
This value specifies an array of scalars or vectors, depending on field type. If the <type> is “Vector”, either a vector or a node ID may be specified. | ||
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. |
Note: | The interface limits the field_name[31] input to 31 characters. |
fields_create_general | (field_name, object_type, field_method, extrap_method, coord_type, coord_frame, geom_entity, num_active_var, ind_variable_1, ind_variable_2, ind_variable_3) |
Description: | ||
This function creates a new general field in the database. | ||
Input: | ||
STRING | field_name[31] | This value specifies the new field name. |
INTEGER | object_type | This value specifies the object type id: 1 = Spatial, 2 = Material, and 3 = Non-Spatial. |
INTEGER | field_method | This value specifies the field method type and should always be set to the value 5. |
INTEGER | extrap_method | This value specifies the extrapolation method: 1 = “Use closest table value”, 2 = “Linear extrapolation”, and 3 = “Set value to zero”. |
STRING | coord_type[31] | This value specifies the coordinate frame type: “Real” or “Parametric”. |
STRING | coord_frame[31] | This value specifies the coordinate frame. |
STRING | geom_entity[31] | This value specifies the geometric entity used for parametric field. |
INTEGER | num_active_var | This value specifies the number of active independent variables or dimension. |
INTEGER | ind_variable_1 | This value specifies the first independent variable. See the remarks below for more information. |
INTEGER | ind_variable_2 | This value specifies the second independent variable. See the remarks below for more information. |
INTEGER | ind_variable_3 | This value specifies the third independent variable. See the remarks below for more information. |
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. |
Independent Variable | Letter Designation | Integer ID | |
Spatial | “X” | 1 | |
Y Direction | “Y” | 2 | |
Z Direction | “Z” | 3 | |
R Direction | “R” | 4 | |
T Direction | “T” | 5 | |
P Direction | “P” | 6 | |
C1 Direction | “C1” | 7 | |
C2 Direction | “C2” | 8 | |
C3 Direction | “C3” | 9 | |
Temperature | “T” | 10 | |
Strain | “e” | 11 | |
Strain Rate | “er” | 12 | |
Time | “t” | 13 | |
Frequency | “f” | 14 | |
Radiosity | “RAD” | 15 |
Note: | The interface limits the field_name[31] input to 31 characters. |
fields_create_general_term | (field_name, term_field_id, term_type, term_id, data_length, data) |
Description: | ||
This function creates a term for a general field in the database. | ||
Input: | ||
STRING | field_name[31] | This value specifies an existing general field name. |
INTEGER | term_field_id | This value specifies the term field id. |
INTEGER | term_type | This value specifies the term type. |
INTEGER | term_id | This value specifies the term id. |
INTEGER | data_length | This value specifies the length of the data. |
STRING | data[] | This value specifies the expression data. |
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. |
Note: | The interface limits the field_name[31] input to 31 characters. |
fields_create_fem | (field_name, group, type, extrap_method, coord_frame, results_interp) |
Description: | ||
This function creates a new FEM field in the database. | ||
Input: | ||
STRING | field_name[31] | This value specifies the new field name. |
STRING | group[31] | This value specifies the name of the group that the results apply to. |
STRING | type[31] | This value specifies the type: “Scalar” or “Vector”. |
INTEGER | extrap_method | This value specifies the extrapolation method: 1 = “Use closest table value, 2 = “Linear extrapolation,” and 3 = “Set value to zero”. |
STRING | coord_frame[31] | This value specifies the name of the coordinate frame to be used. This value defaults to “Coord 0”. |
INTEGER | results_interp | This value specifies the 3D interpolation of 2D results flag: 0=interpolate points “as-is”, 1=apply 2D results uniformly in the “1” direction of the new model, 2=apply in “2” direction, and 3=apply in “3” direction. |
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. |
fields_create_lbc | (field_name, entity_type, type, num_entities, entities, value) |
Description: | ||
This function creates a new Load/BC field in the database. | ||
Input: | ||
STRING | field_name[31] | This value specifies the new field name. |
STRING | entity_type[31] | This value specifies the entity type: “Node” or “Element”. |
STRING | type[31] | This value specifies the type: “Scalar” or “Vector”. |
INTEGER | num_entities | This value specifies the number of entities in the field. |
STRING | entities[](num_entities) | |
This value specifies the names of the entities to be associated with the field. | ||
STRING | values[](num_entities) | |
This value specifies an array of scalars or vectors, depending on field type. | ||
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. |
Note: | The interface limits the field_name[31] input to 31 characters. |
fields_delete | (num_fields, field_name) |
Description: | ||
This function deletes an existing field from the database. | ||
Input: | ||
INTEGER | num_fields | This value specifies the number of fields to be deleted. |
STRING | field_name[31](num_fields) | |
This value specifies the names of the fields to 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: | ||
13000127 | The field entered does not exist. | |
13000184 | The field is in use and cannot be deleted. |
Note: | The interface limits the field_name[31] input to 31 characters. |
fields_modify | (field_name, new_name, object_type, extrap_method, type, coord_type, coord_frame, geom_entity, definition_type, num_active_var, ind_variable_1, ind_variable_2, ind_variable_3, field_function_1, field_function_2, field_function_3, linear_definition, var1_values, var2_values, var3_values, field_values) |
Description: | ||
This function modifies an existing field in the database. | ||
Input: | ||
STRING | field_name[31] | This value specifies the name of the existing field to be modified. |
STRING | new_name[31] | This value specifies the new field name. This value should be set to the same value specified as the input value load_case_name if the field name is not to be changed. |
STRING | object_type[31] | This value specifies the object type: “Spatial”, “Non-Spatial”, “Material”, or “Time Dependent” |
INTEGER | extrap_method | This value specifies the extrapolation method: 1 = use closest table value, 2 = linear extrapolation, and 3 = set value to zero. |
STRING | type[31] | This value specifies the type: “Scalar”, “Vector”, or “Complex Scalar”. |
STRING | coord_type[31] | This value specifies the coordinate frame type: “Real” or “Parametric”. |
STRING | coord_frame[31] | This value specifies the coordinate frame. |
STRING | geom_entity[31] | This value specifies the geometric entity used for spatial parametric field. |
STRING | definition_type[31] | This value specifies the definition: “Function” or “Table”. |
INTEGER | num_active_var | This value specifies the number of active independent variables or dimension. |
STRING | ind_variable_1[31] | This value specifies the independent variable 1. For Spatial: “X,” “R,” or “C1”. For Material: “T”. For Non-Spatial: “t”, “f”, “T”, “u”, “v”, “UD”, “fri”, “fmpd”, or “fmpr”. For Time Dependent: “t”. Note that “fri”, “fmpd”, or “fmpr” must be used for complex-valued functions of frequency. “fri” indicates that the complex terms are real-imaginary; “fmpd” indicates magnitude-phase (degrees), and “fmpr”, magnitude-phase (radians). |
STRING | ind_variable_2[31] | This value specifies the independent variable 2. For Spatial: “Y,” “T,” or “C2”. For Material: “e”. For Non-Spatial: “t”, “f”, “T”, “u”, “v”, “UD”, “fri”, “fmpd”, or “fmpr”. For Time Dependent: invalid. Note that “fri”, “fmpd”, or “fmpr” must be used for complex-valued functions of frequency. “fri” indicates that the complex terms are real-imaginary; “fmpd” indicates magnitude-phase (degrees), and “fmpr”, magnitude-phase (radians). |
STRING | ind_variable_3[31] | This value specifies the independent variable 3. For Spatial: “Z,” “P,” or “C3”. For Material: “er”. For Non-Spatial: “t”, “f”, “T”, “u”, “v”, “UD”, “fri”, “fmpd”, or “fmpr”. For Time Dependent: invalid. Note that “fri”, “fmpd”, or “fmpr” must be used for complex-valued functions of frequency. “fri” indicates that the complex terms are real-imaginary; “fmpd” indicates magnitude-phase (degrees), and “fmpr”, magnitude-phase (radians). |
STRING | field_function_1[] | This value specifies the first field function which can manipulate either scalar or vector values. |
STRING | field_function_2[] | This value specifies the second field function which can manipulate vector values. |
STRING | field_function_3[] | This value specifies the third field function which can manipulate vector values. |
LOGICAL | linear_definition | This value specifies, when set to TRUE, that spatial parametric tables be used. If this value is set to FALSE, spatial parametric tabular fields are not used. |
REAL | var1_values() | |
This value specifies a one-dimensional array of tabular “X”, “R”, or “C1” for Spatial, “T” for Material, “t”, “f”, “T, “u”, “v”, “UD”, “fri”, “fmpd”, or “fmpd” for Non-Spatial, or “t” for Time Dependent values. | ||
REAL | var2_values() | |
This value specifies a one-dimensional array of tabular “Y”, “T”, or “C2” for Spatial, “e” for Material values, or “t”, “f”, “T”, “u”, “v”, “UD”, “fri”, “fmpd”, or “fmpd” for Non-Spatial values. | ||
REAL | var3_values() | |
This value specifies a one-dimensional array of tabular “Z”, “P”, or “C3” for Spatial, “er” for Material values, or “t”, “f”, “T”, “u”, “v”, “UD”, “fri”, “fmpd”, or “fmpd” for Non-Spatial values. | ||
REAL | field_values() | |
This array contains the field values for all data points. It is only applicable for tabular fields. Use a single zero if not applicable. For real-valued fields its dimensions must be len1 x len2 x len3, where len1, len2, and len3 are the lengths of the arrays var1_values, var2_values, and var3_values, respectively. For complex-valued fields its dimensions must be 2 x len1 x len2 x len3, with all of the first complex component terms preceding all second component terms. That is, all reals precede all imaginaries and all magnitudes precede all phases. | ||
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. |
Note: | The interface limits the field_name[31] input to 31 characters. |
fields_modify_lbc | (field_name, new_name, entity_type, type, num_entities, entities, values) |
Description: | ||
This function modifies an existing Load/BC field in the database. | ||
Input: | ||
STRING | field_name[31] | This value specifies the name of existing field to be modified. |
STRING | new_name[31] | This value specifies the new field name. This value should be set to the same value specified as the input value load_case_name if the field name is not to be changed. |
STRING | entity_type[31] | This value specifies the entity type: “Node” or “Element”. |
STRING | type[31] | This value specifies the type: “Scalar” or “Vector”. |
INTEGER | num_entities | This value specifies the number of entities in the field. |
STRING | entities[](num_entities) | |
This value specifies the names of the entities in list processor format. | ||
STRING | values[](num_entities) | |
This value specifies the one or three dimensional array values depending on field type. | ||
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. |
Note: | The interface limits the field_name[31] input to 31 characters. |
fields_modify_fem | (field_name, new_name, group, type, extrap_method, coord_frame, results_interp) |
Description: | ||
This function modifies an existing FEM field in the database. | ||
Input: | ||
STRING | field_name[31] | This value specifies the name of existing field to be modified. |
STRING | new_name[31] | This value specifies the new field name. Same as the input value “old_name” if it is not to be changed. |
STRING | group[31] | This value specifies the name of the group that results apply to. |
STRING | type[31] | This value specifies the type: “Scalar” or “Vector”. |
INTEGER | extrap_method | This value specifies the extrapolation method: 1 = use closest table value, 2 = linear extrapolation, and 3 = set value to zero. |
STRING | coord_frame[31] | This value specifies the name of the coordinate frame to be used. This value defaults to “Coord 0”. |
INTEGER | results_interp | This value specifies the 3D interpolation of 2D results flag: 0=interpolate points “as-is”, 1=apply 2D results uniformly in the “1” direction of the new model, 2=apply in “2” direction, and 3=apply in “3” direction. |
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. |
Note: | The interface limits the field_name[31] input to 31 characters. |
fields_show | (field_name, ind_label, ind_min, ind_max, ind_num_points, fixed1_min, fixed1_max, fixed1_num_points, fixed2_min, fixed2_max, fixed2_num_points, existing_pts_flag, post_xy_flag, type_dep_val) |
Description: | ||
This function shows an existing field in tabular and XY Plot format. | ||
Input: | ||
STRING | field_name[31] | This value specifies the field name. |
STRING | ind_label[31] | This value specifies an independent variable. |
REAL | ind_min | This value specifies the minimum value of the independent variable. |
REAL | ind_max | This value specifies the maximum value of the independent variable. |
INTEGER | ind_num_points | This value specifies the number of points of the independent variable. |
REAL | fixed1_min | This value specifies the minimum value of the first fixed variable. |
REAL | fixed1_max | This value specifies the maximum value of the first fixed variable. |
INTEGER | fixed1_num_points | This value specifies the number of points of the first fixed variable. |
REAL | fixed2_min | This value specifies the minimum value of the second fixed variable. |
REAL | fixed2_max | This value specifies the maximum value of the second fixed variable. |
INTEGER | fixed2_num_points | This value specifies the number of points of the second fixed variable. |
LOGICAL | existing_pts_flag | This value uses the existing points flag. The value is set to TRUE if the existing points should be used, and to FALSE if the values are to be calculated from existing points. Always set this value to FALSE for function fields. |
LOGICAL | post_xy_flag | This value specifies the post XY plot flag. The value is set to TRUE if the XY plot window displaying data is desired. |
INTEGER | type_dep_val | The use of this value depends on the field type. For vector fields this value specifies the selected vector component- 1, 2, 3. For complex scalar fields this value specifies the tabular and XY Plot output type: 1 for real-imaginary, 2 for magnitude-phase (degrees), 3 for magnitude-phase (radians), and 4 for magnitude (db)-phase (degrees), i.e. Bode plot data. |
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. |
Note: | The interface limits the field_name[31] input to 31 characters. |
fields_show_lbc | (field_name) |
Description: | ||
This function shows an existing Load/BC field in tabular format in a spreadsheet form. | ||
Input: | ||
STRING | field_name[31] | This value specifies the field name. |
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. |
Note: | The interface limits the field_name[31] input to 31 characters. |