reVX.setbacks.regulations.validate_setback_regulations_input

validate_setback_regulations_input(base_setback_dist=None, hub_height=None, rotor_diameter=None)[source]

Validate the setback regulations initialization input.

Specifically, this function raises an error unless exactly one of the following combinations of inputs are provided:

  • base_setback_dist

  • hub_height and rotor_diameter

Parameters:

  • base_setback_dist (float | int) – Base setback distance (m). This value will be used to calculate the setback distance when a multiplier is provided either via the regulations_fpath csv or the multiplier input. In these cases, the setbacks will be calculated using base_setback_dist * multiplier. By default, None.

  • hub_height (float | int) – Turbine hub height (m), used along with rotor diameter to compute blade tip-height which is used as the base setback distance. By default, None.

  • rotor_diameter (float | int) – Turbine rotor diameter (m), used along with hub height to compute blade tip-height which is used as the base setback distance. By default, None.

Raises:

RuntimeError – If not enough info is provided (all inputs are None), or too much info is given (all inputs are not None).