Source code for compas_fea2.model.bcs

from __future__ import absolute_import
from __future__ import division
from __future__ import print_function

from compas_fea2.base import FEAData

docs = """
Note
----
BoundaryConditions are registered to a :class:`compas_fea2.model.Model`.

Warning
-------
The `axes` parameter is WIP. Currently only global axes can be used.

Parameters
----------
name : str, optional
    Uniqe identifier. If not provided it is automatically generated. Set a
    name if you want a more human-readable input file.
axes : str, optional
    The refernce axes.

Attributes
----------
name : str
    Uniqe identifier.
x : bool
    Restrain translations along the x axis.
y : bool
    Restrain translations along the y axis.
z : bool
    Restrain translations along the z axis.
xx : bool
    Restrain rotations around the x axis.
yy : bool
    Restrain rotations around the y axis.
zz : bool
    Restrain rotations around the z axis.
components : dict
    Dictionary with component-value pairs summarizing the boundary condition.
axes : str
    The refernce axes.
"""


[docs]class _BoundaryCondition(FEAData):
    """Base class for all zero-valued boundary conditions.
    """
    __doc__ += docs

    def __init__(self, axes='global', name=None, **kwargs):
        super(_BoundaryCondition, self).__init__(name=name, **kwargs)
        self._axes = axes
        self._x = False
        self._y = False
        self._z = False
        self._xx = False
        self._yy = False
        self._zz = False

    @property
    def x(self):
        return self._x

    @property
    def y(self):
        return self._y

    @property
    def z(self):
        return self._z

    @property
    def xx(self):
        return self._xx

    @property
    def yy(self):
        return self._yy

    @property
    def zz(self):
        return self._zz

    @property
    def axes(self):
        return self._axes

    @axes.setter
    def axes(self, value):
        self._axes = value

    @property
    def components(self):
        return {c: getattr(self, c) for c in ['x', 'y', 'z', 'xx', 'yy', 'zz']}


[docs]class GeneralBC(_BoundaryCondition):
    """Costumized boundary condition.
    """
    __doc__ += docs
    __doc__ += """
Additional Parameters
---------------------
x : bool
    Restrain translations along the x axis.
y : bool
    Restrain translations along the y axis.
z : bool
    Restrain translations along the z axis.
xx : bool
    Restrain rotations around the x axis.
yy : bool
    Restrain rotations around the y axis.
zz : bool
    Restrain rotations around the z axis.
    """

    def __init__(self, name=None, x=False, y=False, z=False, xx=False, yy=False, zz=False, **kwargs):
        super(GeneralBC, self).__init__(name=name, **kwargs)
        self._x = x
        self._y = y
        self._z = z
        self._xx = xx
        self._yy = yy
        self._zz = zz


[docs]class FixedBC(_BoundaryCondition):
    """A fixed nodal displacement boundary condition.
    """
    __doc__ += docs

    def __init__(self, name=None, **kwargs):
        super(FixedBC, self).__init__(name=name, **kwargs)
        self._x = True
        self._y = True
        self._z = True
        self._xx = True
        self._yy = True
        self._zz = True


[docs]class PinnedBC(_BoundaryCondition):
    """A pinned nodal displacement boundary condition.
    """
    __doc__ += docs

    def __init__(self, name=None, **kwargs):
        super(PinnedBC, self).__init__(name=name, **kwargs)
        self._x = True
        self._y = True
        self._z = True


[docs]class ClampBCXX(PinnedBC):
    """A pinned nodal displacement boundary condition clamped in XX.
    """
    __doc__ += docs

    def __init__(self, name=None, **kwargs):
        super(ClampBCXX, self).__init__(name=name, **kwargs)
        self._xx = True


[docs]class ClampBCYY(PinnedBC):
    """A pinned nodal displacement boundary condition clamped in YY.
    """
    __doc__ += docs

    def __init__(self, name=None, **kwargs):
        super(ClampBCYY, self).__init__(name=name, **kwargs)
        self._yy = True


[docs]class ClampBCZZ(PinnedBC):
    """A pinned nodal displacement boundary condition clamped in ZZ.
    """
    __doc__ += docs

    def __init__(self, name=None, **kwargs):
        super(ClampBCZZ, self).__init__(name=name, **kwargs)
        self._zz = True


[docs]class RollerBCX(PinnedBC):
    """A pinned nodal displacement boundary condition released in X.
    """
    __doc__ += docs

    def __init__(self, name=None, **kwargs):
        super(RollerBCX, self).__init__(name=name, **kwargs)
        self._x = False


[docs]class RollerBCY(PinnedBC):
    """A pinned nodal displacement boundary condition released in Y.
    """
    __doc__ += docs

    def __init__(self, name=None, **kwargs):
        super(RollerBCY, self).__init__(name=name, **kwargs)
        self._y = False


[docs]class RollerBCZ(PinnedBC):
    """A pinned nodal displacement boundary condition released in Z.
    """
    __doc__ += docs

    def __init__(self, name=None, **kwargs):
        super(RollerBCZ, self).__init__(name=name, **kwargs)
        self._z = False


[docs]class RollerBCXY(PinnedBC):
    """A pinned nodal displacement boundary condition released in X and Y.
    """
    __doc__ += docs

    def __init__(self, name=None, **kwargs):
        super(RollerBCXY, self).__init__(name=name, **kwargs)
        self._x = False
        self._y = False


[docs]class RollerBCYZ(PinnedBC):
    """A pinned nodal displacement boundary condition released in Y and Z.
    """
    __doc__ += docs

    def __init__(self, name=None, **kwargs):
        super(RollerBCYZ, self).__init__(name=name, **kwargs)
        self._y = False
        self._z = False


[docs]class RollerBCXZ(PinnedBC):
    """A pinned nodal displacement boundary condition released in X and Z.
    """
    __doc__ += docs

    def __init__(self, name=None, **kwargs):
        super(RollerBCXZ, self).__init__(name=name, **kwargs)
        self._x = False
        self._z = False