# Linear Dipole Model Properties

The properties of the Linear Dipole Model model are shown below for reference. More detailed information regarding these properties is presented here.

Note

Some properties are read only as stated below.

lineardipole
dipole_cap f

$$d_{cap}$$ - distance to cap the dipole force/moment contribution.

dipole_d f

$$d_d$$ - dipole distance used for contact activity.

dipole_f v

$$\mathbf{F^{di}}$$ - dipole force.

dipole_m1 v

$$\mathbf{M_1}$$ - moment applied to piece 1 due to the dipole. This is a read-only property.

dipole_m2 v

$$\mathbf{M_2}$$ - moment applied to piece 2 due to the dipole. This is a read-only property.

dipole_mo1 v

$$\mathbf{m_1}$$ - original dipole moment of piece 1.

dipole_mo2 v

$$\mathbf{m_2}$$ - original dipole moment on piece 2.

dp_force v

$$\mathbf{F^d}$$ - dashpot force in units force. Expressed in the contact plane coordinate system. This is a read-only property.

dp_mode i

$$M_d$$ - dashpot mode with default value 0.

dp_nratio f

$$\beta_n$$ - normal critical damping ratio with default value 0.0.

dp_sratio f

$$\beta_s$$ - shear critical damping ratio with default value 0.0.

emod f

$$E^*$$ - effective modulus in units force/area This is a read-only property.

fric f

$$\mu$$ - friction coefficient with default value 0.0.

kn f

$$k_n$$ - normal stiffness in units force/length with default value 0.0.

kratio f

$$\kappa^*$$ - normal-to-shear stiffness ratio. This is a read-only property.

ks f

$$k_s$$ - shear stiffness in units force/length with default value 0.0.

lin_force v

$$\mathbf{F^l}$$ - linear force in units force with default value $$\mathbf{0}$$. Expressed in the contact plane coordinate system.

lin_mode i

$$M_l$$ - normal-force update mode with default value 0 (absolute update mode). Incremental normal-force update mode is set with $$M_l$$ = 1.

lin_slip b

$$s$$ - slip state. This is a read only property.

rgap f

$$g_r$$ - reference gap in units length with default value 0.0.

user_area f

$$A$$ - set contact area to the constant value f.