Skip to content

Commit

Permalink
More info in the Template Editor section
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelduchesne committed May 8, 2018
1 parent e370dbe commit d8d95df
Show file tree
Hide file tree
Showing 7 changed files with 69 additions and 1 deletion.
Binary file added docs/assets/energy-module-overview-sj4k38fd7.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/energy-module-overview-sley3j48.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/energy-module-overview-so3ur94u.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/template-info/Schedules/_schedules.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@


Schedules Tab
=============

Expand Down
26 changes: 25 additions & 1 deletion docs/template-info/Zone-Information/conditioning.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ Conditioning
Heating
```````

This checkbox field defines whether or not this component is available to operate. If this field is unchecked, the :ref:`cond_h_schedule` field will be forced to the generic schedule name *Off*.

.. index:: Heating setpoint
.. _cond_h_setpoint:

Expand All @@ -41,18 +43,24 @@ Schedule for when the heating system is available. Winter only enables the heati
Heating limit type
``````````````````

The input must be either **LimitFlowRate**, **LimitCapacity**, **LimitFlowRateAndCapacity** or **NoLimit**. LimitFlowRate means that the heating supply air flow rate will be limited to the value specified in the input field :ref:`cond_h_max_flow`. LimitCapacity means that the sensible heating capacity will be limited to the value specified in the :ref:`cond_h_max_cap` field. LimitFlowRateAndCapacity means that both flow rate and capacity will be limited. NoLimit (the default) means that there will not be any limit on the heating supply air flow rate or capacity and the subsequent two fields will be ignored.

.. index:: Max heating capacity
.. _cond_h_max_cap:

Max heating capacity
````````````````````

The maximum allowed sensible heating capacity in Watts if Heating Limit is set to LimitCapacity or LimitFlowRateAndCapacity. If blank, there is no limit. If Heating Limit is set to NoLimit or LimitFlowRate, this field is ignored.

.. index:: Max heat flow
.. _cond_h_max_flow:

Max heat flow
`````````````

The maximum heating supply air flow rate in cubic meters per second if heating limit is set to LimitFlowRate or LimitFlowRateAndCapacity. This field is ignored if heating limit is set to NoLimit or LimitCapacity. If blank, there is no limit.

.. index:: Heating CoP
.. _cond_h_cop:

Expand Down Expand Up @@ -89,6 +97,8 @@ Schedule for when the cooling system is available. Summer only enables the cooli
Cooling limit type
``````````````````

The input must be either **LimitFlowRate**, **LimitCapacity**, **LimitFlowRateAndCapacity** or **NoLimit**. LimitFlowrate means that the cooling supply air flow rate will be limited to the value specified :ref:`cond_c_max_flow` field. LimitCapacity means that the total cooling capacity will be limited to the value specified in the :ref:`cond_c_max_cap` field. LimitFlowRateAndCapacity means that both flow rate and capacity will be limited. NoLimit (the default) means that there will not be any limit on the cooling supply air flow rate or capacity and the subsequent two fields will be ignored.

.. index:: Max cooling capacity
.. _cond_c_max_cap:

Expand All @@ -101,6 +111,8 @@ Max cooling capacity
Max cool flow
`````````````

The maximum cooling supply air flow rate in cubic meters per second if Cooling Limit is set to LimitFlowRate or LimitFlowRateAndCapacity. This field is ignored if cooling limit is set to NoLimit or LimitCapacity. If blank, there is no limit. If Cooling Limit is set to NoLimit, this field is ignored. This field is required if Outdoor Air Control Type is TemperatureEconomizer in order to establish an upper limit on outdoor air flow when the economizer is active.

.. index:: Cooling CoP
.. _cond_c_cop:

Expand All @@ -127,7 +139,11 @@ Mechanical ventilation schedule
Min fresh air per area
``````````````````````

Constant outdoor fresh air supply relative to floor area.
The design outdoor air volume flow rate per square meter of floor area (units are m3/s-m2). This input is used if Outdoor Air Method is Flow/Area, Sum or Maximum. The default value for this field is 0.

.. Note::

Umi uses by default the *Sum* method which means that the flows calculated from the fields :ref:`cond_min_freshair_pers`, :ref:`cond_min_freshair_area`, Outdoor Air Flow per Zone, and Air Changes per Hour (using the associated conversions to m3/s for each field) will be added to obtain the zone outdoor air flow rate.

.. index:: Min fresh air per person
.. _cond_min_freshair_pers:
Expand All @@ -143,20 +159,28 @@ Outdoor fresh air supply relative to current occupancy.
Economizer type
```````````````

This field specifies if there is an outdoor air economizer. The choices are: NoEconomizer, DifferentialDryBulb, or DifferentialEnthalpy. The default is NoEconomizer. DifferentialDryBulb and DifferentialEnthalpy mean that the economizer will increase the outdoor air flow rate above the minimum outdoor air flow (see fields Design Specification Outdoor Air Object Name and Demand Controlled Ventilation Type) when there is a cooling load and the outdoor air temperature or enthalpy is below the zone exhaust air temperature or enthalpy. The DifferentialDryBulb and DifferentialEnthalpy options require that the :ref:`cond_c_max_flow` be specified which will be used as the limit for maximum outdoor air flow rate.

.. index:: Heat recovery type
.. _cond_hr_type:

Heat recovery type
``````````````````

Select from None, Sensible, or Enthalpy. None means that there is no heat recovery. Sensible means that there is sensible heat recovery whenever the zone exhaust air temperature is more favorable than the outdoor air temperature. Enthalpy means that there is latent and sensible heat recovery whenever the zone exhaust air enthalpy is more favorable than the outdoor air enthalpy. The default is None.

.. index:: Heat recovery efficiency (latent)
.. _cond_hr_eff_latent:

Heat recovery efficiency (latent)
`````````````````````````````````

The latent heat recovery effectiveness, where effectiveness is defined as the change in supply humidity ratio divided by the difference in entering supply and relief air humidity ratios. The default is 0.65.

.. index:: Heat recovery efficiency (sensible)
.. _cond_hr_eff_sensible:

Heat recovery efficiency (sensible)
```````````````````````````````````

The sensible heat recovery effectiveness, where effectiveness is defined as the change in supply temperature divided by the difference in entering supply and relief air temperatures. The default is 0.70.
35 changes: 35 additions & 0 deletions docs/template-info/Zone-Information/ventilation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ Ventilation
Infiltration
````````````

This field is the name of the schedule that modifies the maximum design volume flow rate (see Design Flow Rate Calculation Method field and related subsequent fields). This fraction between 0.0 and 1.0 is noted as in the above equation.

.. index:: Infiltration rate
.. _vent_infiltration_rate:

Expand All @@ -27,24 +29,40 @@ Infiltration rate
Natural ventilation
```````````````````

For this model, the ventilation air flow rate is a function of wind speed and thermal stack effect, along with the area of the opening being modeled. This object can be used alone or in combination with :ref:`vent_schduled`. This model is intended for simplified ventilation calculations as opposed to the more detailed ventilation investigations that can be performed with the AirflowNetwork model. Using the “Wind and Stack with Open Area” model, the natural ventilation flow rate can be controlled by a multiplier fraction schedule applied to the user-defined :ref:`windows_operable_area` and through the specification of minimum, maximum and delta temperatures. The temperatures can be either single constant values for the entire simulation or schedules which can vary over time.

.. Note::

Note that if :ref:`vent_nat` is used in combination with :ref:`vent_schduled`, the resulting ventilation rate for the zone will simply be the summation of the flow rates specified by the ventilation objects.

.. index:: Nat vent min outdoor air temp
.. _vent_nat_min_outdoor_temp:

Natural ventilation minimum outdoor air temperature
```````````````````````````````````````````````````

This is the outdoor temperature (in Celsius) below which ventilation is shut off. The minimum value for this field is -100.0°C and the maximum value is 100.0°C. The default value is -100.0°C if the field is left blank. This lower temperature limit is intended to avoid overcooling a space, which could result in a heating load.

.. index:: Natural ventilation maximum outdoor air temperature
.. _vent_nat_max_outdoor_temp:

Natural ventilation maximum outdoor air temperature
```````````````````````````````````````````````````

This is the outdoor temperature (in Celsius) above which ventilation is shut off. The minimum value for this field is -100.0°C and the maximum value is 100.0°C. The default value is 100.0°C if the field is left blank. This upper temperature limit is intended to avoid overheating a space, which could result in a cooling load.

.. index:: Natural ventilation maximum relative humidity
.. _vent_nat_max_rh:

Natural ventilation maximum relative humidity
`````````````````````````````````````````````

Defines the dehumidifying relative humidity setpoint, expressed as a percentage (0-100), for each timestep of the simulation.

.. Note::

The default value for the Minimum Relative Humidity is 20C.

.. index:: Natural ventilation schedule
.. _vent_nat_schedule:

Expand All @@ -63,24 +81,41 @@ Natural ventilation zone temperature setpoint
Scheduled ventilation
`````````````````````

Ventilation is the purposeful flow of air from the outdoor environment directly into a thermal zone in order to provide some amount of non-mechanical cooling. Scheduled Ventilation is intended to model “simple” ventilation as opposed to the more detailed ventilation investigations that can be performed with the AirflowNetwork model or with air systems that have outdoor air mixers. Zone ventilation can be controlled by a :ref:`vent_scheduled_schedule` and through the specification of :ref:`vent_scheduled_setpoint`, maximum and delta temperatures as described below. Note that maximum and delta temperatures are not supported yet in the Template Editor.

.. Note::

Natural ventilation is assumed as a result of openings in the building façade and will not consume any fan energy. Values for fan pressure and efficiency for natural ventilation are ignored. The conditions of the air entering the space are assumed to be equivalent to outside air conditions.

.. index:: Scheduled ventilation ACH
.. _vent_scheduled_ach:

Scheduled ventilation ACH
`````````````````````````

This factor, along with the Zone Volume, will be used to determine the Design Flow Rate.

.. index:: Scheduled ventilation schedule
.. _vent_scheduled_schedule:

Scheduled ventilation schedule
``````````````````````````````

This field is the name of the schedule (:ref:`Schedules Tab`) that modifies the maximum design volume flow rate. This fraction is between 0.0 and 1.0.

.. index:: Scheduled ventilation setpoint
.. _vent_scheduled_setpoint:

Scheduled ventilation setpoint
``````````````````````````````

This is the indoor temperature (in Celsius) below which ventilation is shutoff. The minimum value for this field is -100.0°C and the maximum value is 100.0°C. The default value is -100.0°C if the field is left blank. This lower temperature limit is intended to avoid overcooling a space and thus result in a heating load. For example, if the user specifies a minimum temperature of 20°C, ventilation is assumed to be available if the zone air temperature is above 20°C. If the zone air temperature drops below 20°C, then ventilation is automatically turned off.

.. Note::

Since the Template Editor does not support changing the values of the Maximum Indoor Temperature, the value will be left blank meaning that the default value is 100.0°C.


.. index:: Buoyancy
.. _vent_buoyancy:

Expand Down
8 changes: 8 additions & 0 deletions docs/template-info/Zone-Information/windows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,24 +61,32 @@ Shading system type
Zone mixing
```````````

ZoneMixing is intended to allow simplified treatment of air exchange between zones. Note that this statement only affects the energy balance of the “receiving” zone and that this statement will not produce any effect on the “source” zone. More advanced mixing calculations are possible using the AirflowNetwork model for multi-zone airflow with or without HVAC system operation.

.. index:: Zone mixing availability schedule
.. _windows_zone_mixing_schedule:

Zone mixing availability schedule
`````````````````````````````````

This field is the name of the schedule (:ref:`Schedules Tab`) that modifies the maximum design volume flow rate parameter (see next field). This fraction between 0.0 and 1.0 modifies the design level parameter.

.. index:: Zone mixing delta temperature
.. _windows_zone_mixing_schedule_delta_t:

Zone mixing delta temperature
`````````````````````````````

This number controls when mixing air from the source zone is sent to the receiving zone. This parameter is a temperature and is expressed in units of Celsius. If this field is positive, the temperature of the zone from which the air is being drawn (source zone) must be “Delta Temperature” warmer than the receiving zone air or else no mixing occurs. If this field is negative, the temperature of the source zone must be “Delta Temperature” cooler than the receiving zone air or else no mixing occurs. If this parameter is zero, mixing occurs regardless of the relative zone temperatures.

.. index:: Zone mixing flow rate
.. _windows_zone_mixing_flowrate:

Zone mixing flow rate
`````````````````````

This factor (m3/s-m2) is used, along with the Zone Area to determine the maximum Design Volume Flow Rate as described in the Design Volume Flow Rate field.

.. index:: Virtual partition
.. _windows_virtual_partition:

Expand Down

0 comments on commit d8d95df

Please sign in to comment.