Source code for api.simulation.output_cases.output_setup

""" This is the base class for outputs setup objects. Particular implementations can be found in the
 :ref:`outputs setup implementations documentation <outputs>` """

import typing
from abc import ABC, abstractmethod




class OutputSetup(ABC):
    def __init__(self, item):
        self._output = item

    def _get_wrapped_object(self):
        return self._output

    def __enter__(self):
        return self

    def __exit__(self, exc_type, exc_val, exc_tb):
        pass





class DofSettable(ABC):
    @abstractmethod
    def set_dof_dict(self, dof_values_dict: typing.Dict[str, float]) -> OutputSetup:
        pass





class TranslationSettableMixin(DofSettable):
    @abstractmethod
    def set_u(self, value: float) -> OutputSetup:
        pass

    @abstractmethod
    def set_v(self, value: float) -> OutputSetup:
        pass

    @abstractmethod
    def set_w(self, value: float) -> OutputSetup:
        pass





class RotationSettableMixin(DofSettable):

    @abstractmethod
    def set_ru(self, value: float) -> OutputSetup:
        pass

    @abstractmethod
    def set_rv(self, value: float) -> OutputSetup:
        pass

    @abstractmethod
    def set_rw(self, value: float) -> OutputSetup:
        pass





class SourceTargetSettableMixin(DofSettable):
    @abstractmethod
    def set_target_value(self, value):
        pass

    @abstractmethod
    def set_source_value(self, value):
        pass