Source code for pyleecan.Methods.Machine.Notch.is_outwards

# -*- coding: utf-8 -*-

from ....Methods import ParentMissingError


def is_outwards(self):
    """Return if the notch is outwards (on an external lamination) or inwards
    (on an internal lamination).
    (to make lam.notch[ii].notch_shape match lam.slot parent)

    Parameters
    ----------
    self : Notch
        A Notch object

    Returns
    -------
    is_outwards: bool
        True if the Lamination is not internal and false if not. For yoke notch,
        result is negated.
    """
    if self.parent is not None:
        return self.parent.is_outwards()
    else:
        raise ParentMissingError("Error: The notch is not inside a Lamination")