Source code for pyts.stressModels.main

from .base import stressModelBase, stressObj


class uniform(stressModelBase):

    """Uniform Reynold's stress model.

    In this model each component of the Reynold's stress can be
    specified explicitly, but the values are uniform in space.

    Parameters
    ----------
    upvp_ : float
            The u'v' component of Reynold's stress.
    upwp_ : float
            The u'w' component of Reynold's stress.
    vpwp_ : float
            The v'w' component of Reynold's stress.

    """

    def __init__(self, upvp_=0.0, upwp_=0.0, vpwp_=0.0):
        """
        Set the Reynold's stresses to be uniform over the rotor disk.
        """
        self.vals = [upvp_, upwp_, vpwp_]

    def _sumfile_string(self, tsrun, ):
        sumstring_format = """
        Stress model used                                =  {dat.model_desc}
        u'v'                                             =  {dat.vals[0]:0.4g} [m^2/s^2]
        u'w'                                             =  {dat.vals[1]:0.4g} [m^2/s^2]
        v'w'                                             =  {dat.vals[2]:0.4g} [m^2/s^2]
        """
        return sumstring_format.format(dat=self, )

    def __call__(self, tsrun):
        """
        Create and calculate the stress object for a `tsrun`
        instance.

        Parameters
        ----------
        tsrun :         :class:`.tsrun`
                        A TurbSim run object.

        Returns
        -------
        out :           :class:`.stressObj`
                        A stress object for the grid in `tsrun`.

        """
        out = stressObj(tsrun)
        out.upvp_[:] = self.vals[0]
        out.upwp_[:] = self.vals[1]
        out.vpwp_[:] = self.vals[2]
        return out