Source code for spawnwind.nrel.turbsim_spawner

# spawnwind
# Copyright (C) 2018-2019, Simmovation Ltd.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
"""Defines the turbsim spawner
"""
from os import path as os_path, makedirs
import copy

from ..spawners import WindGenerationSpawner
from .tasks import WindGenerationTask


class TurbsimSpawner(WindGenerationSpawner):
    """Spawns TurbSim wind generation tasks"""

    def __init__(self, turbsim_input):
        self._input = turbsim_input

    def spawn(self, path, metadata):
        wind_input_file = os_path.join(path, 'wind.ipt')
        if not os_path.isdir(os_path.dirname(wind_input_file)):
            makedirs(os_path.dirname(wind_input_file))
        self._input.to_file(wind_input_file)
        extension = '.wnd' if self.wind_type == 'bladed' else '.bts'
        wind_task = WindGenerationTask('wind ' + path,
                                       _input_file_path=wind_input_file,
                                       _metadata=metadata,
                                       _extension=extension)
        return wind_task

    def branch(self):
        branched_spawner = copy.copy(self)
        #pylint: disable=protected-access
        branched_spawner._input = copy.deepcopy(self._input)
        return branched_spawner

    def input_hash(self):
        """Get the hash of the input

        :returns: A hash of the input
        :rtype: str
        """
        return self._input.hash()

    @property
    def wind_type(self):
        # if multiple outputs are enabled, favour Bladed .wnd style
        """
        :return: Wind type generated by spawner ('bladed' for .wnd, 'turbsim' for .bts),
        """
        if self._input['WrBLFF'] == 'True':
            return 'bladed'
        elif self._input['WrADFF'] == 'True':
            return 'turbsim'
        else:
            raise ValueError('Turbsim wind file type not determined')

    @wind_type.setter
    def wind_type(self, wind_type):
        """
        Set wind type to single output method (Bladed or Turbsim). Disables other output method
        :param wind_type: {'bladed', 'turbsim'}
        """
        if wind_type == 'bladed':
            self._input['WrBLFF'] = 'True'
            self._input['WrADFF'] = 'False'
        elif wind_type == 'turbsim':
            self._input['WrADFF'] = 'True'
            self._input['WrBLFF'] = 'False'
        else:
            raise ValueError("Turbsim wind file type '{}' unrecognised".format(wind_type))

    #pylint: disable=missing-docstring
    def get_duration(self):
        return float(self._input['UsableTime'])

    #pylint: disable=missing-docstring
    def set_duration(self, duration):
        self._input['UsableTime'] = duration

    #pylint: disable=missing-docstring
    def get_analysis_time(self):
        return self._input['AnalysisTime']

    #pylint: disable=missing-docstring
    def set_analysis_time(self, time):
        self._input['AnalysisTime'] = time

    #pylint: disable=missing-docstring
    def get_wind_speed(self):
        return float(self._input['URef'])

    #pylint: disable=missing-docstring
    def set_wind_speed(self, value):
        self._input['URef'] = value

    #pylint: disable=missing-docstring
    def get_turbulence_intensity(self):
        return float(self._input['IECturbc'])

    #pylint: disable=missing-docstring
    def set_turbulence_intensity(self, turbulence_intensity):
        self._input['IECturbc'] = turbulence_intensity

    #pylint: disable=missing-docstring
    def get_turbulence_seed(self):
        return int(self._input['RandSeed1'])

    #pylint: disable=missing-docstring
    def set_turbulence_seed(self, seed):
        self._input['RandSeed1'] = seed

    #pylint: disable=missing-docstring
    def get_wind_shear(self):
        exponent = self._input['PLExp']
        return float('NaN') if exponent == 'default' else float(exponent)

    #pylint: disable=missing-docstring
    def set_wind_shear(self, exponent):
        self._input['PLExp'] = exponent

    #pylint: disable=missing-docstring
    def get_upflow(self):
        return float(self._input['VFlowAng'])

    #pylint: disable=missing-docstring
    def set_upflow(self, angle):
        self._input['VFlowAng'] = angle