rblock.facet.closest

Syntax

v = rblock.facet.closest(p,if,vp)

Get the closest point on a facet. The closest point on facet if to the point in space vp is returned. if can take values from 1 to rblock.facet.num. The facets correspond to the entries returned by rblock.facet.map and rblock.vertex.map.

Returns:

v - closest point on facet to vp vector

Arguments:

p - rigid block pointer

if - facet number

vp - point

Component Access

f = rblock.facet.closest (p, if, vp)->x

f = rblock.facet.closest.x(p,if,vp)

Get the \(x\)-component of the closest point on a facet. The closest point on facet if to the point in space vp is returned. if can take values from 1 to rblock.facet.num. The facets correspond to the entries returned by rblock.facet.map and rblock.vertex.map.

Returns:

f - \(x\)-component of the closest point on facet to vp

Arguments:

p - rigid block pointer

if - facet number

vp - point

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 = rblock.facet.closest(p, 1, vp, 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 = rblock.facet.closest.y(p,if,vp)

f = rblock.facet.closest.z(p,if,vp) (3D ONLY)