fracture.normal

Syntax

Vector Access

norm = fracture.normal(frac<,icomp>)
fracture.normal(frac<,icomp>) = norm

Get/set 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 (i.e., norm / | norm |).
Returns:

norm - normal vector or component
Accepts:

norm - normal vector or component
Arguments:

frac - fracture pointer

icomp - optional vector component

Component Access

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

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:fnorm - \(x\)-component of the fracture normal
Accepts:fnorm - \(x\)-component of the fracture normal
Arguments:frac - fracture pointer
fnorm = fracture.normal.y(frac)
fracture.normal.y(frac) = fnorm

Get/set the \(y\)-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:fnorm - \(y\)-component of the fracture normal
Accepts:fnorm - \(y\)-component of the fracture normal
Arguments:frac - fracture pointer
fnorm = fracture.normal.z(frac) (3D only)
fracture.normal.z(frac) = fnorm

Get/set the \(z\)-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 (\(z\)-component; in 3D) is less than 0.
  • The provided normal is normalized.
Returns:fnorm - \(z\)-component of the fracture normal
Accepts:fnorm - \(z\)-component of the fracture normal
Arguments:frac - fracture pointer