Tutorial Toolkit Function Descriptions > Obsolete, Modified, and Broken Functions > Fields (Chapter 14)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
Fields (Chapter 14)
 
Modified
The documentation implies that the variable ID will return a value as well as supply one for this call, but in reality the value of ID is only supposed to be an input argument.
Change the variable ID to be an input argument.
Original Description Information:
(id, name, object, type, etype, eid, extra_opt, cid_type, cid, defn_type, nvar, ivar1, ivar2, ivar3, fn1_size, fn2_size, fn3_size, fn1, fn2, fn3, lin_def, nxvals, nyvals, nzvals, xvals, yvals, zvals, vals)
Description:
Modifies a field in the database.
Input:
INTEGER
id
The unique internal ID identifying the field in the database.
STRING
name[]
The name of the field to be modified.
INTEGER
object
0 = spatial; 1 = material; 2 = time
INTEGER
type
0 = scalar; 1 = vector
INTEGER
etype
The entity type.
INTEGER
eid
The elem_edge to be associated with the field.
INTEGER
extra_opt
The node_pos to be associated with the field.
INTEGER
cid_type
The field values for this table field. The input type.
INTEGER
cid
The ID of the coordinate frame used to define this field.
INTEGER
defn_type
0 = Function; 1 = Table; 2 = Fem;
INTEGER
nvar
The number of functions used to define this field.
INTEGER
ivar1
Values 1-4
INTEGER
ivar2
Values 1-4
INTEGER
ivar3
Values 1-4
INTEGER
fn1_size
The size of the first function used to define this field.
INTEGER
fn2_size
The size of the second function used to define this field.
INTEGER
fn3_size
The size of the third function used to define this field.
STRING
fn1[fn1_size]
The first function that defines this field.
STRING
fn2[fn2_size]
The second function that defines this field.
STRING
fn3[fn3_size]
The third function that defines this field.
LOGICAL
lin_def
Flag indicating whether this was a linear definition.
INTEGER
nxvals
The number of x values for this field.
INTEGER
nyvals
The number of y values for this field.
INTEGER
nzvals
The number of z values for this field.
REAL
xvals(nxvals)
The x values for this field.
REAL
yvals(nyvals)
The y values for this field.
REAL
zvals(nzvals)
The z values for this field.
REAL
vals(nxvals, nyvals, nzvals)
The field values for this table field.
Output:
INTEGER
id
The unique internal ID identifying the field in the database.
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:
(id, name, object, type, etype, eid, extra_opt, cid_type, cid, defn_type, nvar, ivar1, ivar2, ivar3, fn1_size, fn2_size, fn3_size, fn1, fn2, fn3, lin_def, nxvals, nyvals, nzvals, xvals, yvals, zvals, vals)
Description:
Modifies a field in the database.
Input:
INTEGER
id
The unique internal ID identifying the field in the database.
STRING
name[]
The name of the field to be modified.
INTEGER
object
0 = spatial; 1 = material; 2 = time
INTEGER
type
0 = scalar; 1 = vector
INTEGER
etype
The entity type.
INTEGER
eid
The elem_edge to be associated with the field.
INTEGER
extra_opt
The node_pos to be associated with the field.
INTEGER
cid_type
The field values for this table field. The input type.
INTEGER
cid
The ID of the coordinate frame used to define this field.
INTEGER
defn_type
0 = Function; 1 = Table; 2 = Fem;
INTEGER
nvar
The number of functions used to define this field.
INTEGER
ivar1
Values 1-4
INTEGER
ivar2
Values 1-4
INTEGER
ivar3
Values 1-4
INTEGER
fn1_size
The size of the first function used to define this field.
INTEGER
fn2_size
The size of the second function used to define this field.
INTEGER
fn3_size
The size of the third function used to define this field.
STRING
fn1[fn1_size]
The first function that defines this field.
STRING
fn2[fn2_size]
The second function that defines this field.
STRING
fn3[fn3_size]
The third function that defines this field.
LOGICAL
lin_def
Flag indicating whether this was a linear definition.
INTEGER
nlin_defxvals
The number of x values for this field.
INTEGER
nyvals
The number of y values for this field.
INTEGER
nzvals
The number of z values for this field.
REAL
xvals(nxvals)
The x values for this field.
REAL
yvals(nyvals)
The y values for this field.
REAL
zvals(nzvals)
The z values for this field.
REAL
vals(nxvals, nyvals, nzvals)
The field values for this table field.
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_create_field_res
Obsolete
The call no longer exists.
 
Removed the call from the documentation.
Description:
Converts a field lbc in the database.
Input:
INTEGER
type
0 = scalar; 1 = vector; 2 = tensor;
INTEGER
etype
The entity type.
INTEGER
nvals
The number of field values to be created.
INTEGER
eid(nvals)
The entity ids to be associated with the field.
INTEGER
elem_face(nvals)
The elem_face to be associated with the field.
INTEGER
elem_edge(nvals)
The elem_edge to be associated with the field.
INTEGER
node_pos(nvals)
The node_pos to be associated with the field.
REAL
vals(nvals, type)
The field values for this table field. The input type.determines the size of the vals array;
0 = 1;
1 = 3;
2 = 6;
The values determine how many positions should be loaded from the input arrays and correspond to scalar, vector, or tensor.
Output:
INTEGER
id
The unique internal ID identifying the field in the database.
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.
 
Modified
Missing the db_get_field_dfem call in the original MSC.Acumen documentation.
Added this call to the documentation.
New Description Information:
(id, nvals, method, eid, elem_face, elem_edge, node_pos, nodeid, vals )
Description:
Gets an lbc field from the database.
Input:
INTEGER
id
The unique internal ID identifying the field in the database.
INTEGER
nvals
The number of values that the output arrays are present in the table.
Output:
INTEGER
nvals
The number of values that the output arrays are present in the table.
INTEGER
method(nvals)
The method used. 1 = vector 2 = nodeID
INTEGER
eid(nvals)
The entity id.
INTEGER
elem_face(nvals)
The elem face id.
INTEGER
elem_edge(nvals)
The elem edge id.
INTEGER
node_pos(nvals)
The node position.
INTEGER
nodeid(nvals)
The node ID if using method = 2
REAL
vals(nvals, type)
The scalar, vector, or tensor values of the field. If method = 1
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.
 
 
Modified
The documentation implies that the variable ID is only an input argument, but in reality the variable ID is an input/output argument. Also the variable VALTS in the argument list should really be VALS which is an input argument and not an output argument.
Change the variable ID to be an input/output argument. In the calling sequence change the variable VALTS to VALS and remove the variable VALTS from the output argument list.
Original Description Information:
(id, name, type, ent_type, nvals, eid, elem_face, elem_edge, node_pos, valts )
Description:
Create an LBC type field.
Input:
INTEGER
id
Field ID (ID nonzero, otherwise use next available field ID).
STRING
name[31]
Field name.
INTEGER
type
=1 scalar data, =3 vector data.
INTEGER
ent_type
Category - 123=Nodal or 124=Element.
INTEGER
nvals
Number of points defining the field.
INTEGER
eid(nvals)
Ids of the elements/nodes.
INTEGER
elem_face(nvals)
Id of the element faces.
INTEGER
elem_edge(nvals)
Id of the element edges.
INTEGER
node_pos(nvals)
Id of nodal position (for elem variable).
REAL
vals(nvals, type)
Values of the field
Output:
REAL
valts(nvals)
Values of the field
INTEGER
<Return Value>
0 success, otherwise an error.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
New Description Information:
(id, name, type, ent_type, nvals, eid, elem_face, elem_edge, node_pos, vals )
Description:
Create an LBC type field.
Input:
INTEGER
id
Field ID (ID nonzero, otherwise use next available field ID).
STRING
name[31]
Field name.
INTEGER
type
=1 scalar data, =3 vector data.
INTEGER
ent_type
Category - 123=Nodal or 124=Element.
INTEGER
nvals
Number of points defining the field.
INTEGER
eid(nvals)
Ids of the elements/nodes.
INTEGER
elem_face(nvals)
Id of the element faces.
INTEGER
elem_edge(nvals)
Id of the element edges.
INTEGER
node_pos(nvals)
Id of nodal position (for elem variable).
REAL
vals(nvals, type)
Values of the field
Output:
INTEGER
id
Field ID returned
INTEGER
<Return Value>
0 success, otherwise an error.
Error Conditions:
None.
Remarks:
None.
Examples:
None.
 
Modified
The documentation implies that the variable NVALS is only an input argument, but in reality it is an input/output argument
Changed the variable NVALS to be an input/output argument.
Original Description Information:
(d, nvals, eid, elem_face, elem_edge, node_pos, vals )
Description:
Gets an LBC field from the database.
Input:
INTEGER
id
The unique internal ID identifying the field in the database.
INTEGER
nvals
The number of values that the output arrays are dimensioned to handle.
Output:
INTEGER
eid(nvals)
The entity ID.
INTEGER
elem_face(nvals)
The elem face ID.
INTEGER
elem_edge(nvals)
The elem edge ID.
INTEGER
node_pos(nvals)
The node position.
REAL
vals(nvals, type)
The scalar, vector, or tensor values of the field.
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:
(d, nvals, eid, elem_face, elem_edge, node_pos, vals )
Description:
Gets an LBC field from the database.
Input:
INTEGER
id
The unique internal ID identifying the field in the database.
INTEGER
nvals
The number of values that the output arrays are dimensioned to handle.
Output:
INTEGER
nvals
The number of values that the output arrays are dimensioned to handle.
INTEGER
eid(nvals)
The entity ID.
INTEGER
elem_face(nvals)
The elem face ID.
INTEGER
elem_edge(nvals)
The elem edge ID.
INTEGER
node_pos(nvals)
The node position.
REAL
vals(nvals, type)
The scalar, vector, or tensor values of the field.
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.