ladybug_comfort.parameter.adaptive module

Parameters for specifying acceptable thermal conditions using the Adaptive model.

class ladybug_comfort.parameter.adaptive.AdaptiveParameter(ashrae_or_en=None, neutral_offset=None, avg_month_or_running_mean=None, discrete_or_continuous_air_speed=None, cold_prevail_temp_limit=None, conditioning=None)[source]

Bases: ComfortParameter

Parameters of Adaptive comfort.

Parameters:
  • ashrae_or_en – A boolean to note whether to use the ASHRAE-55 neutral temperature function (True) or the european neutral function (False), which is consistent with both EN-15251 and EN-16798. Note that this input will also determine default values for many of the other properties of this object.

  • neutral_offset – The number of degrees Celsius from the neutral temperature where the input operative temperature is considered acceptable. The default is 2.5C when the neutral temperature function is ASHRAE-55 and 3C when the neutral temperature function is EN, which is consistent with comfort class II. You may want to use the set_neutral_offset_from_ppd() or the set_neutral_offset_from_comfort_class() methods on this object to set this value using ppd from the ASHRAE-55 standard or comfort classes from the EN standard respectively.

  • avg_month_or_running_mean – A boolean to note whether the prevailing outdoor temperature is computed from the average monthly temperature (True) or a weighted running mean of the last week (False). The default is True when the neutral temperature function is ASHRAE-55 and False when the neutral temperature function is EN.

  • discrete_or_continuous_air_speed – A boolean to note whether discrete categories should be used to assess the effect of elevated air speed (True) or whether a continuous function should be used (False). Note that continuous air speeds were only used in the older EN-15251 standard and are not a part of the more recent EN-16798 standard. When unassigned, this will be True for discrete air speeds.

  • cold_prevail_temp_limit – A number indicating the prevailing outdoor temperature below which acceptable indoor operative temperatures flat line. The default is 10C, which is consistent with both ASHRAE-55 and EN-16798. However, 15C was used for the older EN-15251 standard. This number cannot be greater than 22C and cannot be less than 10C.

  • conditioning

    A number between 0 and 1 that represents how “conditioned” vs. “free-running” the building is.

    • 0 = free-running (completely passive with no air conditioning)

    • 1 = conditioned (no operable windows and fully air conditioned)

    The default is 0 since both the ASHRAE-55 and EN standards prohibit the use of adaptive comfort methods when a cooling system is active.

Properties:
  • ashrae_or_en

  • neutral_offset

  • avg_month_or_running_mean

  • discrete_or_continuous_air_speed

  • cold_prevail_temp_limit

  • conditioning

  • standard

  • prevailing_temperature_method

  • minimum_operative

ToString()

Overwrite .NET ToString.

duplicate()

Get a copy of this object.

classmethod from_dict(data)[source]

Create a AdaptiveParameter object from a dictionary.

Parameters:

data – A AdaptiveParameter dictionary in following the format below.

{
'type': 'AdaptiveParameter',
'ashrae_or_en': True,
'neutral_offset': 2.5,
'avg_month_or_running_mean': False,
'discrete_or_continuous_air_speed': True,
'cold_prevail_temp_limit': 10,
'conditioning': 0
}
classmethod from_string(adaptive_parameter_string)[source]

Create an AdaptiveParameter object from an AdaptiveParameter string.

is_comfortable(comfort_result, cooling_effect=0)[source]

Determine if conditions are comfortable or not.

Values are one of the following:

  • 0 = uncomfortable

  • 1 = comfortable

Parameters:
  • comfort_result – An adaptive comfort result dictionary from the adaptive_comfort_ashrae55 or adaptive_comfort_en15251 functions.

  • cooling_effect – Cooling effect from elevated air speed.

set_neutral_offset_from_comfort_class(comfort_class)[source]

Set the offset from neutral temperature given the EN comfort class.

set_neutral_offset_from_ppd(ppd)[source]

Set the offset from neutral temperature given the ASHRAE-55 PPD limit.

thermal_condition(comfort_result, cooling_effect=0)[source]

Determine whether conditions are cold, neutral or hot.

Values are one of the following:

  • -1 = cold

  • 0 = neutral

  • +1 = hot

Parameters:
  • comfort_result – An adaptive comfort result dictionary from the adaptive_comfort_ashrae55 or adaptive_comfort_en15251 functions.

  • cooling_effect – Cooling effect from elevated air speed

to_dict()[source]

AdaptiveParameter dictionary representation.

property air_speed_method

Text denoting the type of function used for the cooling effect of air speed.

Either ‘Discrete’ or ‘Continuous’.

property ashrae_or_en

A boolean to note whether to use the ASHRAE-55 neutral temperature function (True) or the EN function (False).

property avg_month_or_running_mean

Boolean noting whether prevailing outdoor temperature is computed from the average monthly temperature (True) or a weighted running mean (False).

property cold_prevail_temp_limit

The prevailing outdoor temperature below which acceptable indoor operative temperatures flat line. [C]

property comfort_model

Return the name of the comfort model to which the parameters belong.

property conditioning

A decimal noting how conditioned(1) vs. free-running(0) the building is.

property discrete_or_continuous_air_speed

Boolean noting whether discrete categories are used to assess elevated air speed (True) or whether a continuous function is used (False).

property minimum_operative

Operative Temperature in C below which conditions cannot be comfortable.

property neutral_offset

The degrees Celsius from the neutral temperature where the operative temperature is considered acceptable.

property prevailing_temperature_method

Text denoting prevailing temperature method.

Either ‘Averaged Monthly’ or ‘Running Mean’.

property standard

Text denoting the standard.

Either ‘ASHRAE-55’ or ‘EN-16798’