*Field()

Creates a field.

Syntax

*Field(field_name,"field_label",body_1, body_2, origin)

Arguments

field_name
The variable name of the field.
Data type: varname
field_label
The descriptive label of the field.
Data type: label
body_1
The first body constrained by the field.
Data type: Body
body_2
The second body constrained by the field.
Data type: Body
origin
The location of the field.
Data type: Point

Example

*BeginMDL(model, "Field Model")
 *Body(b_0, "Body 0")
 *Body(b_1, "Body 1")
 *Point(p_0, "Point 0")
 *Point(p_1, "Point 1")
 *Point(p_2, "Point 2")
 *Vector(v_1, "Vector 1")
 *Vector(v_2, "Vector 2")
 *Field(fi_0, "Field 0 - Single", b_0, b_1, p_0)
 *SetOrientation(fi_0, TWOAXES, XY, v_1, v_2)
 *SetOrientation(fi_0, TWOAXES, XY, p_1, p_2)
 *SetOrientation(fi_0, ONEAXIS, X, p_1)
 *SetOrientation(fi_0, ONEAXIS, X, v_1)
 *SetFieldStiffness(fi_0, 1, 2, 3...36)
 *SetFieldDamping(fi_0, CRATIO, .05)
 *SetFieldLength(fi_0, 5, 6, 7, 8, 9, 10)
 *SetFieldForce(fi_0, 21, 22, 23, 24, 25, 26)
*EndMDL()

Context

*BeginMdl()

*DefineAnalysis()

*DefineSystem()

Properties

Table 1.
Property Returns Data Type Description
align_meth1 The alignment method used to orient the first axis of the field.
align_meth2 The alignment method used to define the plane created by the first two axes of the field. Used only when the orientation method is Two Axes.
align_pt1 Point The point used to define the first axis of the field. Used when align_meth1 is of type Point.
align_pt2 Point The point used to define the plane for align_meth2. Used when the orientation method is Two Axes.
align_vec1 Vector The vector used to define the first axis of the field. Used when align_meth2 is of type Vector.
align_vec2 Vector The vector used to define the plane for align_meth2. Used when the orientation method is Two Axes
AX, AY, AZ real Shortcut notation for a curve independent variable when the independent variable is translational acceleration.
b1 Body The first body constrained by the field.
b2 Body The second body constrained by the field.
c1 - c36 real The damping coefficients of the 6x6 damping matrix.
DX, DY, DZ real Shortcut notation for a curve independent variable when the indepenent variable is translational displacement.
e1, e2, e3 real The Euler angles used if ornt_meth is Angles.
f1 - f6 real The force values for the six components (3 forces, 3 torques) at the corresponding lengths (length1 - length6). Zero force would mean a free length at the given lengths.
FM, FX, FY, FZ real Shortcut notation for a curve independent variable when the indepenent variable is translational force.
full_label string The descriptive label of the field, starting at "MODEL".
full_local_label string The label of the field that does not include "MODEL" and parent systems.
full_local_vaname string The variable name of the field that does not include "MODEL" and parent systems.
full_varname string The variable name of the field, starting at "MODEL".
i Marker The implicit marker on b1.
id long integer The solver ID of the field.
idstring string The solver ID represented as a string.
j Marker The implicit marker on b2.
jfloat Marker The implicit floating marker on b2.
k1 - k36 real Stiffness values of the 6x6 stiffness matrix.
label string The descriptive label of the field.
length 1 - length 6 real The reference lengths between the i marker and the j marker.
local_dll string The path and filename of the local DLL to be used. Applicable only if use_local_dll is set to TRUE.
note string The note on the field.
num integer The unique identification number within MDL.
origin Point The origin of the field entity.
ornt_dir1 The axis type that is being oriented for the first axis of the field.
ornt_dir2 The axis type that is being oriented to define the plane.
ornt_meth The type of orientation used for the field.
rm Marker The reference marker used when the orientation method is Angles.
state boolean Control state (TRUE or FALSE).
TM, TX, TY, TZ real Shortcut notation for a curve independent variable when the indepenent variable is torque.
_user_state boolean The state that can be set by the user (TRUE or FALSE).
use_local_dll boolean The flag for whether a DLL specific to an instance of the field entity will be used.
user boolean Set to TRUE if the field properties will be described by a user subroutine.
usr_sub string The solver expression that sets the arguments for the user-defined field.
usr_type string Indicates that the field will be described by a user subroutine. Valid settings include USER.
varname string The variable name of the field.
VX, VY, VZ real Shortcut notation for a curve independent variable when the indepenent variable is translational velocity.
WX, WY, WZ real Shortcut notation for a curve independent variable when the indepenent variable is rotational velocity.
x1, y1, z1 real The values for the components of a vector when align_meth1 is DxDyDz (not related to the DXDYDZ curve shortcut notation).
x2, y2, z2 real The values for the components of a vector when align_meth2 is DxDyDz (not related to the DXDYDZ curve shortcut notation).