fracture.normal

Syntax

vec = fracture.normal(frac)
fracture.normal(frac) = vec

Get/set the fracture normal.

Note

  • The fracture must fall completely within the model domain. of the normal is inverted if the {\(y\)-component in 2D; \(z\)-component, in 3D} is less than 0.

  • The provided normal is normalized (i.e., norm / | norm |).

Returns:

v - normal vector

Accepts:

v - normal vector

Arguments:

frac - fracture pointer

Component Access

f = fracture.normal (frac)->x
fracture.normal (frac)->x = f

f = fracture.normal.x(frac)
fracture.normal.x(frac) = f

Get/set the \(x\)-component of the fracture normal.

Note

  • The fracture must fall completely within the model domain.

  • The sign of the normal is inverted if the {\(y\)-component in 2D; \(z\)-component in 3D} is less than 0.

  • The provided normal is normalized.

Returns:

f - \(x\)-component of the fracture normal

Accepts:

f - \(x\)-component of the fracture normal

Arguments:

frac - fracture pointer

Access other vector components (\(y\), \(z\) (3D ONLY)) by substituting the component name where \(x\) appears above. See Member Access Operator for information about accessing members from data types using ->.

Deprecated Component Access

Component access by adding an optional integer in the function arguments (e.g., f = fracture.normal(frac, 3)) is deprecated. It remains available but will not be supported in future versions. See Component Access with Integers in FISH on the Deprecated Commands and FISH page for details.

This is hidden. Added to include remaining vector component access functions for inline help.

f = fracture.normal.y(frac)
f = fracture.normal.z(frac) (3D ONLY)