Source code for openpnm.models.geometry.throat_vector._funcs

from transforms3d import _gohlketransforms as tr
from openpnm.models.geometry import _geodocs


__all__ = ["pore_to_pore"]




@_geodocs
def pore_to_pore(network):
    r"""
    Calculates throat vector as straight path between connected pores.

    Parameters
    ----------
    %(network)s

    Returns
    -------
    unit_vec : ndarray
        A [Nt-by-3] numpy ndarray containing pore-to-pore unit vectors

    Notes
    -----
    There is an important impicit assumption here: the positive direction is
    taken as the direction from the pore with the lower index to the higher.
    This corresponds to the pores in the 1st and 2nd columns of the
    'throat.conns' array as stored on the network.

    """
    conns = network['throat.conns']
    P1 = conns[:, 0]
    P2 = conns[:, 1]
    coords = network['pore.coords']
    vec = coords[P2] - coords[P1]
    unit_vec = tr.unit_vector(vec, axis=1)
    return unit_vec