Miscellaneous¶
94 object types from idfpy.models.misc · EnergyPlus 26.2 · groups: AirflowNetwork, Compliance Objects, Controllers, Detailed Ground Heat Transfer, Exterior Equipment, General Data Entry, Heat Recovery, Humidifiers and Dehumidifiers, Hybrid Model, Non-Zone Equipment, Parametrics, Performance Tables, Plant-Condenser Flow Control, Plant-Condenser Loops, Variable Refrigerant Flow Equipment
| Object | Summary |
|---|---|
| AirConditioner:VariableRefrigerantFlow | Variable refrigerant flow (VRF) air-to-air heat pump condensing unit (includes one or more electric … |
| AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl | This is a key object in the new physics based VRF model applicable for Fluid Temperature Control It describes … |
| AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl:HR | This is a key object in the new physics based VRF Heat Recovery (HR) model applicable for Fluid Temperature … |
| AirLoopHVAC:ControllerList | List controllers in order of control sequence |
| AirflowNetwork:Distribution:Component:Coil | This object defines the name of a coil used in an air loop. |
| AirflowNetwork:Distribution:Component:ConstantPressureDrop | This object defines the characteristics of a constant pressure drop component (e.g. |
| AirflowNetwork:Distribution:Component:Duct | This object defines the relationship between pressure and air flow through the duct. |
| AirflowNetwork:Distribution:Component:Fan | This object defines the name of the supply Air Fan used in an Air loop. |
| AirflowNetwork:Distribution:Component:HeatExchanger | This object defines the name of an air-to-air heat exchanger used in an air loop. |
| AirflowNetwork:Distribution:Component:Leak | This object defines the characteristics of a supply or return air leak. |
| AirflowNetwork:Distribution:Component:LeakageRatio | This object is used to define supply and return air leaks with respect to the fan's maximum air flow rate. |
| AirflowNetwork:Distribution:Component:OutdoorAirFlow | This object includes the outdoor air flow rate set by the Controller:OutdoorAir object in the airflow network. |
| AirflowNetwork:Distribution:Component:ReliefAirFlow | This object allows variation of air flow rate to perform pressure. |
| AirflowNetwork:Distribution:Component:TerminalUnit | This object defines the name of a terminal unit in an air loop. |
| AirflowNetwork:Distribution:DuctSizing | This object defines required parameters for duct sizing in an Airflow Network simulation. |
| AirflowNetwork:Distribution:DuctViewFactors | This object is used to allow user-defined view factors to be used for duct-surface radiation calculations. |
| AirflowNetwork:Distribution:Linkage | This object defines the connection between two nodes and a component. |
| AirflowNetwork:Distribution:Node | This object represents an air distribution node in the AirflowNetwork model. |
| AirflowNetwork:IntraZone:Linkage | This object defines the connection between two nodes and a component used in the combination of RoomAir and … |
| AirflowNetwork:IntraZone:Node | This object represents a node in a zone in the combination of RoomAir and AirflowNetwork model. |
| AirflowNetwork:MultiZone:Component:DetailedOpening | This object specifies the properties of airflow through windows and doors (window, door and glass door heat … |
| AirflowNetwork:MultiZone:Component:HorizontalOpening | This object specifies the properties of air flow through a horizontal opening |
| AirflowNetwork:MultiZone:Component:SimpleOpening | This object specifies the properties of air flow through windows and doors (window, door and glass door heat … |
| AirflowNetwork:MultiZone:Component:ZoneExhaustFan | This object specifies the additional properties for a zone exhaust fan to perform multizone airflow … |
| AirflowNetwork:MultiZone:ExternalNode | This object defines outdoor environmental conditions outside of the building. |
| AirflowNetwork:MultiZone:ReferenceCrackConditions | This object specifies the conditions under which the air mass flow coefficient was measured. |
| AirflowNetwork:MultiZone:SpecifiedFlowRate | This object is used to define specified flow through a linkage. |
| AirflowNetwork:MultiZone:Surface | This object specifies the properties of a surface linkage through which air flows. |
| AirflowNetwork:MultiZone:Surface:Crack | This object specifies the properties of airflow through a crack. |
| AirflowNetwork:MultiZone:Surface:EffectiveLeakageArea | This object is used to define surface air leakage. |
| AirflowNetwork:MultiZone:WindPressureCoefficientArray | Used only if Wind Pressure Coefficient (WPC) Type = Input in the AirflowNetwork:SimulationControl object. |
| AirflowNetwork:MultiZone:WindPressureCoefficientValues | Used only if Wind Pressure Coefficient (WPC) Type = INPUT in the AirflowNetwork:SimulationControl object. |
| AirflowNetwork:MultiZone:Zone | This object is used to simultaneously control a thermal zone's window and door openings, both exterior and … |
| AirflowNetwork:OccupantVentilationControl | This object is used to provide advanced thermal comfort control of window opening and closing for both … |
| AirflowNetwork:SimulationControl | This object defines the global parameters used in an Airflow Network simulation. |
| AirflowNetwork:ZoneControl:PressureController | This object is used to control a zone to a specified indoor pressure using the AirflowNetwork model. |
| Compliance:Building | Building level inputs related to compliance to building standards, building codes, and beyond energy code … |
| CondenserLoop | Defines a central plant condenser loop. |
| Controller:MechanicalVentilation | This object is used in conjunction with Controller:OutdoorAir to specify outdoor ventilation air based on … |
| Controller:OutdoorAir | Controller to set the outdoor air flow rate for an air loop. |
| Controller:WaterCoil | Controller for a water coil which is located directly in an air loop branch or outdoor air equipment list. |
| Dehumidifier:Desiccant:NoFans | This object models a solid desiccant dehumidifier. |
| Dehumidifier:Desiccant:System | This compound object models a desiccant heat exchanger, an optional heater, and associated fans. |
| Duct:Loss:Conduction | |
| Duct:Loss:Leakage | |
| Duct:Loss:MakeupAir | |
| Exterior:FuelEquipment | only used for Meter type reporting, does not affect building loads |
| Exterior:Lights | only used for Meter type reporting, does not affect building loads |
| Exterior:WaterEquipment | only used for Meter type reporting, does not affect building loads |
| GroundHeatTransfer:Basement:AutoGrid | AutoGrid only necessary when EquivSizing is false If the modeled building is not a rectangle or square, … |
| GroundHeatTransfer:Basement:BldgData | Specifies the surface and gravel thicknesses used for the Basement preprocessor ground heat transfer … |
| GroundHeatTransfer:Basement:ComBldg | ComBldg contains the monthly average temperatures (C) and possibility of daily variation amplitude |
| GroundHeatTransfer:Basement:EquivAutoGrid | EquivAutoGrid necessary when EquivSizing=TRUE, TRUE is is the normal case. |
| GroundHeatTransfer:Basement:EquivSlab | Using an equivalent slab allows non-rectangular shapes to be modeled accurately. |
| GroundHeatTransfer:Basement:Insulation | Describes the insulation used on an exterior basement wall for the Basement preprocessor ground heat transfer … |
| GroundHeatTransfer:Basement:Interior | Provides the information needed to simulate the inside boundary conditions for the Basement preprocessor … |
| GroundHeatTransfer:Basement:ManualGrid | Manual Grid only necessary using manual gridding (not recommended) |
| GroundHeatTransfer:Basement:MatlProps | Specifies the material properties for the Basement preprocessor ground heat transfer simulation. |
| GroundHeatTransfer:Basement:SimParameters | Specifies certain parameters that control the Basement preprocessor ground heat transfer simulation. |
| GroundHeatTransfer:Basement:SurfaceProps | Specifies the soil surface properties for the Basement preprocessor ground heat transfer simulation. |
| GroundHeatTransfer:Basement:XFACE | This is only needed when using manual gridding (not recommended) XFACE: X Direction cell face coordinates: m |
| GroundHeatTransfer:Basement:YFACE | This is only needed when using manual gridding (not recommended) YFACE: Y Direction cell face coordinates: m |
| GroundHeatTransfer:Basement:ZFACE | This is only needed when using manual gridding (not recommended) ZFACE: Z Direction cell face coordinates: m |
| GroundHeatTransfer:Control | Object determines if the Slab and Basement preprocessors are going to be executed. |
| GroundHeatTransfer:Slab:AutoGrid | AutoGrid only necessary when EquivalentSlab option not chosen. |
| GroundHeatTransfer:Slab:BldgProps | Object provides information about the building and its operating conditions Monthly Average Temperature … |
| GroundHeatTransfer:Slab:BoundConds | Supplies some of the boundary conditions used in the ground heat transfer calculations. |
| GroundHeatTransfer:Slab:EquivalentSlab | Using an equivalent slab allows non-rectangular shapes to be modeled accurately. |
| GroundHeatTransfer:Slab:Insulation | This object supplies the information about insulation used around the slab. |
| GroundHeatTransfer:Slab:ManualGrid | Manual Grid only necessary when using manual gridding (not recommended) Used only in special cases when … |
| GroundHeatTransfer:Slab:Materials | Object gives an overall description of the slab ground heat transfer model. |
| GroundHeatTransfer:Slab:MatlProps | This object contains the material properties for the materials used in the model. |
| GroundHeatTransfer:Slab:XFACE | This is only needed when using manual gridding (not recommended) XFACE: X Direction cell face coordinates: m |
| GroundHeatTransfer:Slab:YFACE | This is only needed when using manual gridding (not recommended) YFACE: Y Direction cell face coordinates: m, |
| GroundHeatTransfer:Slab:ZFACE | This is only needed when using manual gridding (not recommended) ZFACE: Z Direction cell face coordinates: m |
| HeatExchanger:AirToAir:FlatPlate | Flat plate air-to-air heat exchanger, typically used for exhaust or relief air heat recovery. |
| HeatExchanger:AirToAir:SensibleAndLatent | This object models an air-to-air heat exchanger using effectiveness relationships. |
| HeatExchanger:Desiccant:BalancedFlow | This object models a balanced desiccant heat exchanger. |
| HeatExchanger:Desiccant:BalancedFlow:PerformanceDataType1 | RTO = B1 + B2*RWI + B3*RTI + B4*(RWI/RTI) + B5*PWI + B6*PTI + B7*(PWI/PTI) + B8*RFV RWO = C1 + C2*RWI + … |
| Humidifier:Steam:Electric | Electrically heated steam humidifier with fan. |
| Humidifier:Steam:Gas | Natural gas fired steam humidifier with optional blower fan. |
| HybridModel:Zone | Zones with measured air temperature data and a range of dates. |
| LoadProfile:Plant | Used to simulate a scheduled plant loop demand profile. |
| Matrix:TwoDimension | matrix data in row-major order list each row keeping the columns in order number of values must equal N1 x N2 |
| Parametric:FileNameSuffix | Defines the suffixes to be appended to the idf and output file names for each parametric run. |
| Parametric:Logic | This object allows some types of objects to be included for some parametric cases and not for others. |
| Parametric:RunControl | Controls which parametric runs are simulated. |
| Parametric:SetValueForRun | Parametric objects allow a set of multiple simulations to be defined in a single idf file. |
| PlantLoop | Defines a central plant loop. |
| Table:IndependentVariable | An independent variable representing a single dimension of a Table:Lookup object. |
| Table:IndependentVariableList | A sorted list of independent variables used by one or more Table:Lookup objects. |
| Table:Lookup | Lookup tables are used in place of curves and can represent any number of independent variables (defined as … |
| TemperingValve | Temperature-controlled diversion valve used to divert flow around one or more plant components such as a hot … |
| ZoneTerminalUnitList | List of variable refrigerant flow (VRF) terminal units served by a given VRF condensing unit. |
AirConditioner:VariableRefrigerantFlow¶
from idfpy.models import AirConditionerVariableRefrigerantFlow
Variable refrigerant flow (VRF) air-to-air heat pump condensing unit (includes one or more electric compressors and outdoor fan). Serves one or more VRF zone terminal units. See ZoneHVAC:TerminalUnit:VariableRefrigerantFlow and ZoneTerminalUnitList.
| Field | Type | Default | Details |
|---|---|---|---|
nameHeat Pump Name |
string | Enter a unique name for this variable refrigerant flow heat pump. | |
availability_Availability Schedule Name |
reference | Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Enter the name of a schedule that defines the availability of the unit. Schedule values of 0 denote the unit is off. All other values denote the unit is available. If this field is left blank, the unit is available the entire simulation. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
gross_Gross Rated Total Cooling Capacity |
number or AutosizeW |
Enter the total cooling capacity in watts at rated conditions or set to autosize. Total cooling capacity not accounting for the effect of supply air fan heat | |
gross_Gross Rated Cooling COP |
number W/W |
3.3 |
Enter the coefficient of performance at rated conditions or leave blank to use default. COP includes compressor and condenser fan electrical energy input COP does not include supply fan heat or supply fan electric power input Range: > 0 |
minimum_Minimum Condenser Inlet Node Temperature in Cooling Mode |
number C |
-6.0 |
For cooling mode operation, enter the minimum inlet outdoor air dry-bulb temperature for air-cooled units or minimum inlet water temperature for water-cooled units. Cooling is disabled below this temperature. |
maximum_Maximum Condenser Inlet Node Temperature in Cooling Mode |
number C |
43.0 |
For cooling mode operation, enter the maximum inlet outdoor air dry-bulb temperature for air-cooled units or maximum inlet water temperature for water-cooled units. Cooling is disabled above this temperature. |
cooling_Cooling Capacity Ratio Modifier Function of Low Temperature Curve Name |
reference | Enter a curve name that represents full load cooling capacity ratio as a function of outdoor dry-bulb temperature and indoor wet-bulb temperature. Up to two curves are allowed if the performance cannot be represented by a single curve. The following two fields are used if two curves are required. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup |
|
cooling_Cooling Capacity Ratio Boundary Curve Name |
reference | This curve object is used to allow separate low and high cooling capacity ratio performance curves. This curve represents a line passing through the points where performance changes. The curve calculates outdoor dry-bulb temperature given weighted average indoor wet-bulb temperature. If a single performance curve is used, leave this field blank. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
cooling_Cooling Capacity Ratio Modifier Function of High Temperature Curve Name |
reference | This curve object is used to describe the high outdoor temperature performance curve used to describe cooling capacity ratio. This curve is used when a single performance curve does not accurately describe cooling capacity ratio as a function of temperature. If a single performance curve is used, leave this field blank. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup |
|
cooling_Cooling Energy Input Ratio Modifier Function of Low Temperature Curve Name |
reference | Enter a curve name that represents cooling energy ratio as a function of outdoor dry-bulb temperature and indoor wet-bulb temperature Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup |
|
cooling_Cooling Energy Input Ratio Boundary Curve Name |
reference | This curve object is used to allow separate low and high cooling energy input ratio performance curves. This curve represents a line passing through the points where performance changes. The curve calculates outdoor dry-bulb temperature given weighted average indoor wet-bulb temperature. If a single performance curve is used, leave this field blank. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
cooling_Cooling Energy Input Ratio Modifier Function of High Temperature Curve Name |
reference | This curve object is used to describe the high outdoor temperature performance curve used to describe cooling energy ratio. This curve is used when a single performance curve does not accurately describe cooling energy ratio as a function of temperature Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup |
|
cooling_Cooling Energy Input Ratio Modifier Function of Low Part-Load Ratio Curve Name |
reference | Enter a curve name that represents cooling energy ratio as a function of part-load ratio for part-load ratios less than or equal to 1. If this field is left blank, the model assumes energy is proportional to part-load ratio. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
cooling_Cooling Energy Input Ratio Modifier Function of High Part-Load Ratio Curve Name |
reference | Enter a curve name that represents cooling energy ratio as a function of part-load ratio for part-load ratios greater than 1. Part-load ratios can exceed 1 in variable speed compression systems. If this field is left blank, the model assumes energy is proportional to part-load ratio. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
cooling_Cooling Combination Ratio Correction Factor Curve Name |
reference | This curve defines how rated capacity changes when the total indoor terminal unit cooling capacity is greater than the Gross Rated Total Cooling Capacity defined in this object. If this field is left blank, the model assumes total indoor terminal unit cooling capacity is equal to the Gross Rated Total Cooling Capacity defined above. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
cooling_Cooling Part-Load Fraction Correlation Curve Name |
reference | This curve defines the cycling losses when the heat pump compressor cycles on and off below the Minimum Heat Pump Part-Load Ratio specified in the field below. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
gross_Gross Rated Heating Capacity |
number or AutosizeW |
Enter the heating capacity in watts at rated conditions or set to autosize. Heating capacity not accounting for the effect of supply air fan heat | |
rated_Rated Heating Capacity Sizing Ratio |
number W/W |
1.0 |
If the Gross Rated Heating Capacity is autosized, the heating capacity is sized to be equal to the cooling capacity multiplied by this sizing ratio. The zone terminal unit heating coils are also sized using this ratio unless the sizing ratio input in the ZoneHVAC:TerminalUnit:VariableRefrigerantFlow object is entered. Range: ≥ 1 |
gross_Gross Rated Heating COP |
number W/W |
3.4 |
COP includes compressor and condenser fan electrical energy input COP does not include supply fan heat or supply fan electrical energy input Range: > 0 |
minimum_Minimum Condenser Inlet Node Temperature in Heating Mode |
number C |
-20.0 |
For heating mode operation, enter the minimum inlet outdoor air dry-bulb temperature for air-cooled units or minimum inlet water temperature for water-cooled units. Heating is disabled below this temperature. |
maximum_Maximum Condenser Inlet Node Temperature in Heating Mode |
number C |
16.0 |
For heating mode operation, enter the maximum inlet outdoor air dry-bulb temperature for air-cooled units or maximum inlet water temperature for water-cooled units. Heating is disabled below this temperature. |
heating_Heating Capacity Ratio Modifier Function of Low Temperature Curve Name |
reference | Enter a curve name that represents full load heating capacity ratio as a function of outdoor wet-bulb temperature and indoor dry-bulb temperature. Outdoor dry-bulb temperature may be used if wet-bulb temperature data is unavailable. See Heating Performance Curve Outdoor Temperature Type input below to determine which outdoor temperature type to use. Up to two curves are allowed if the performance cannot be represented by a single curve. The following two fields are used if two curves are required. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup |
|
heating_Heating Capacity Ratio Boundary Curve Name |
reference | This curve object is used to allow separate low and high heating capacity ratio performance curves. This curve represents a line passing through the points where performance changes. The curve calculates outdoor dry-bulb or wet-bulb temperature given weighted average indoor dry-bulb temperature. See Heating Performance Curve Outdoor Temperature Type input below to determine which outdoor temperature type to use. If a single performance curve is used, leave this field blank. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
heating_Heating Capacity Ratio Modifier Function of High Temperature Curve Name |
reference | This curve object is used to describe the high outdoor temperature performance curve used to describe heating capacity ratio. This curve is used when a single performance curve does not accurately describe heating capacity ratio as a function of temperature. If a single performance curve is used, leave this field blank. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup |
|
heating_Heating Energy Input Ratio Modifier Function of Low Temperature Curve Name |
reference | Enter a curve name that represents heating energy ratio as a function of outdoor wet-bulb temperature and indoor dry-bulb temperature Outdoor dry-bulb temperature may be used if wet-bulb temperature data is unavailable. See Heating Performance Curve Outdoor Temperature Type input below to determine which outdoor temperature type to use. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup |
|
heating_Heating Energy Input Ratio Boundary Curve Name |
reference | This curve object is used to allow separate low and high heating energy input ratio performance curves. This curve represents a line passing through the points where performance changes. The curve calculates outdoor dry-bulb or wet-bulb temperature given weighted average indoor dry-bulb temperature. See Heating Performance Curve Outdoor Temperature Type input below to determine which outdoor temperature type to use. If a single performance curve is used, leave this field blank. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
heating_Heating Energy Input Ratio Modifier Function of High Temperature Curve Name |
reference | This curve object is used to allow separate performance curves for heating energy. If a single performance curve is used, leave this field blank. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup |
|
heating_Heating Performance Curve Outdoor Temperature Type |
choice | WetBulbTemperature |
Determines temperature type for heating capacity curves and heating energy curves. This input determines whether the outdoor air dry-bulb or wet-bulb temperature is used to evaluate these curves. One of DryBulbTemperature, WetBulbTemperature |
heating_Heating Energy Input Ratio Modifier Function of Low Part-Load Ratio Curve Name |
reference | This curve represents the heating energy input ratio for part-load ratios less than 1. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
heating_Heating Energy Input Ratio Modifier Function of High Part-Load Ratio Curve Name |
reference | This curve represents the heating energy input ratio for part-load ratios greater than 1. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
heating_Heating Combination Ratio Correction Factor Curve Name |
reference | This curve defines how rated capacity changes when the total indoor terminal unit heating capacity is greater than the Gross Rated Heating Capacity defined in this object. If this field is left blank, the model assumes total indoor terminal unit heating capacity is equal to the Gross Rated Heating Capacity defined above. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
heating_Heating Part-Load Fraction Correlation Curve Name |
reference | This curve defines the cycling losses when the heat pump compressor cycles on and off below the Minimum Heat Pump Part-Load Ratio specified in the following field. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
minimum_Minimum Heat Pump Part-Load Ratio |
number dimensionless |
0.15 |
Enter the minimum heat pump part-load ratio (PLR). When the cooling or heating PLR is below this value, the heat pump compressor will cycle to meet the cooling or heating demand. |
zone_Zone Name for Master Thermostat Location |
reference | Enter the name of the zone where the master thermostat is located. Names a Zone |
|
master_Master Thermostat Priority Control Type |
choice | MasterThermostatPriority |
Choose a thermostat control logic scheme. If these control types fail to control zone temperature within a reasonable limit, consider using multiple VRF systems. This field is not used when all terminal units are set point controlled. One of LoadPriority, MasterThermostatPriority, Scheduled, ThermostatOffsetPriority, ZonePriority |
thermostat_Thermostat Priority Schedule Name |
reference | this field is required if Master Thermostat Priority Control Type is Scheduled. Schedule values of 0 denote cooling, 1 for heating, and all other values disable the system. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
zone_Zone Terminal Unit List Name required |
reference | Enter the name of a ZoneTerminalUnitList. This list connects zone terminal units to this heat pump. Names a ZoneTerminalUnitList |
|
heat_Heat Pump Waste Heat Recovery |
choice | No |
This field enables heat recovery operation within this VRF outdoor unit. One of No, Yes |
equivalent_Equivalent Piping Length used for Piping Correction Factor in Cooling Mode |
number m |
Enter the equivalent length of the farthest terminal unit from the condenser | |
vertical_Vertical Height used for Piping Correction Factor |
number m |
Enter the height difference between the highest and lowest terminal unit | |
piping_Piping Correction Factor for Length in Cooling Mode Curve Name |
reference | PCF = a0 + a1*L + a2*L^2 + a3*L^3 + a4*H PCF = a0 + a1*L + a2*L^2 + a3*CR + a4*CR^2 + a5*(L)(CR) where L = length and CR = combination ratio specifies coefficients for a0, a1, a2, and a3 in the PCF equation Names a Curve:Bicubic, Curve:Biquadratic, Curve:Cubic, Curve:CubicLinear, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:FanPressureRise, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic and 6 more |
|
piping_Piping Correction Factor for Height in Cooling Mode Coefficient |
number 1/m |
0.0 |
PCF = a0 + a1*L + a2*L^2 + a3*L^3 + a4*H PCF = a0 + a1*L + a2*L^2 + a3*CR + a4*CR^2 + a5*(L)(CR) + a6*H where L = length, H = height, and CR = combination ratio specifies coefficient a4 (or a6 for biquadratic) in the PCF equation |
equivalent_Equivalent Piping Length used for Piping Correction Factor in Heating Mode |
number m |
Enter the equivalent length of the farthest terminal unit from the condenser | |
piping_Piping Correction Factor for Length in Heating Mode Curve Name |
reference | PCF = a0 + a1*L + a2*L^2 + a3*L^3 + a4*H PCF = a0 + a1*L + a2*L^2 + a3*CR + a4*CR^2 + a5*(L)(CR) + a6*H where L = length and CR = combination ratio specifies coefficients for a0, a1, a2, and a3 (or a0-a5 for biquadratic) in the PCF equation Names a Curve:Bicubic, Curve:Biquadratic, Curve:Cubic, Curve:CubicLinear, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:FanPressureRise, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic and 6 more |
|
piping_Piping Correction Factor for Height in Heating Mode Coefficient |
number 1/m |
0.0 |
PCF = a0 + a1*L + a2*L^2 + a3*L^3 + a4*H PCF = a0 + a1*L + a2*L^2 + a3*CR + a4*CR^2 + a5*(L)(CR) + a6*H where L = length, H = height, and CR = combination ratio specifies coefficient a4 (or a6 for biquadratic) in the PCF equation |
crankcase_Crankcase Heater Power per Compressor |
number W |
33.0 |
Enter the value of the resistive heater located in the compressor(s). This heater is used to warm the refrigerant and oil when the compressor is off. |
number_Number of Compressors |
integer dimensionless |
2 |
Enter the total number of compressor. This input is used only for crankcase heater calculations. |
ratio_Ratio of Compressor Size to Total Compressor Capacity |
number W/W |
0.5 |
Enter the ratio of the first stage compressor to total compressor capacity. All other compressors are assumed to be equally sized. This inputs is used only for crankcase heater calculations. |
maximum_Maximum Outdoor Dry-Bulb Temperature for Crankcase Heater |
number C |
5.0 |
Enter the maximum outdoor temperature above which the crankcase heaters are disabled. |
defrost_Defrost Strategy |
choice | Resistive |
Select a defrost strategy. Reverse cycle reverses the operating mode from heating to cooling to melt frost formation on the condenser coil. The resistive strategy uses a resistive heater to melt the frost. One of Resistive, ReverseCycle |
defrost_Defrost Control |
choice | Timed |
Choose a defrost control type. Either use a fixed Timed defrost period or select OnDemand to defrost only when necessary. One of OnDemand, Timed |
defrost_Defrost Energy Input Ratio Modifier Function of Temperature Curve Name |
reference | A valid performance curve must be used if reversecycle defrost strategy is selected. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup |
|
defrost_Defrost Time Period Fraction |
number dimensionless |
0.058333 |
Fraction of time in defrost mode. Only applicable if timed defrost control is specified. Range: ≥ 0 |
resistive_Resistive Defrost Heater Capacity |
number or AutosizeW |
0.0 |
Enter the size of the resistive defrost heating element. Only applicable if resistive defrost strategy is specified |
maximum_Maximum Outdoor Dry-bulb Temperature for Defrost Operation |
number C |
5.0 |
Enter the maximum outdoor temperature above which defrost operation is disabled. |
condenser_Condenser Type |
choice | AirCooled |
Select either an air-cooled, evaporatively-cooled or water-cooled condenser. One of AirCooled, EvaporativelyCooled, WaterCooled |
condenser_Condenser Inlet Node Name |
string | Choose an outside air node name or leave this field blank to use weather data. If this field is blank, the Condenser Type is assumed to be AirCooled. This input must be specified if Condenser Type = WaterCooled. | |
condenser_Condenser Outlet Node Name |
string | Enter a water outlet node name if Condenser Type = WaterCooled. Leave this field blank if Condenser Type = Air or EvaporativelyCooled. | |
water_Water Condenser Volume Flow Rate |
number or Autosizem3/s |
Only used when Condenser Type = WaterCooled. | |
evaporative_Evaporative Condenser Effectiveness |
number dimensionless |
0.9 |
Enter the effectiveness of the evaporatively cooled condenser. This field is only used when the Condenser Type = EvaporativelyCooled. Range: ≥ 0, ≤ 1 |
evaporative_Evaporative Condenser Air Flow Rate |
number or Autosizem3/s |
Used to calculate evaporative condenser water use. This field is only used when the Condenser Type = EvaporativelyCooled. | |
evaporative_Evaporative Condenser Pump Rated Power Consumption |
number or AutosizeW |
0.0 |
Rated power consumed by the evaporative condenser's water pump. This field is only used when the Condenser Type = EvaporativelyCooled. |
supply_Supply Water Storage Tank Name |
reference | A separate storage tank may be used to supply an evaporatively cooled condenser. Names a WaterUse:Storage |
|
basin_Basin Heater Capacity |
number W/K |
0.0 |
This field is only used for Condenser Type = EvaporativelyCooled and for periods when the basin heater is available (field Basin Heater Operating Schedule Name). For this situation, the heater maintains the basin water temperature at the basin heater setpoint temperature when the outdoor air temperature falls below the setpoint temperature. The basin heater only operates when the DX coil is off. Range: ≥ 0 |
basin_Basin Heater Setpoint Temperature |
number C |
2.0 |
This field is only used for Condenser Type = EvaporativelyCooled. Enter the outdoor dry-bulb temperature when the basin heater turns on. Range: ≥ 2 |
basin_Basin Heater Operating Schedule Name |
reference | This field is only used for Condenser Type = EvaporativelyCooled. Schedule values greater than 0 allow the basin heater to operate whenever the outdoor air dry-bulb temperature is below the basin heater setpoint temperature. If a schedule name is not entered, the basin heater is allowed to operate throughout the entire simulation. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
fuel_Fuel Type |
choice | Electricity |
One of Diesel, Electricity, FuelOilNo1, FuelOilNo2, Gasoline, NaturalGas, OtherFuel1, OtherFuel2, Propane |
minimum_Minimum Condenser Inlet Node Temperature in Heat Recovery Mode |
number C |
For heat recovery mode operation, enter the minimum inlet outdoor air dry-bulb temperature for air-cooled units or minimum inlet water temperature for water-cooled units. Heat recovery is disabled below this temperature. | |
maximum_Maximum Condenser Inlet Node Temperature in Heat Recovery Mode |
number C |
For heat recovery mode operation, enter the maximum inlet outdoor air dry-bulb temperature for air-cooled units or maximum inlet water temperature for water-cooled units. Heat recovery is disabled above this temperature. | |
heat_Heat Recovery Cooling Capacity Modifier Curve Name |
reference | Enter the name of a performance curve which represents the change in cooling capacity when heat recovery is active A default constant of 0.9 is used if this input is blank Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup |
|
initial_Initial Heat Recovery Cooling Capacity Fraction |
number W/W |
0.5 |
Enter the fractional capacity available at the start of heat recovery mode. The capacity exponentially approaches the steady-state value according to the inputs for Heat Recovery Cooling Capacity Modifier and Heat Recovery Cooling Capacity Time Constant |
heat_Heat Recovery Cooling Capacity Time Constant |
number hr |
0.15 |
Enter the time constant used to model the transition from cooling only mode to heat recovery mode |
heat_Heat Recovery Cooling Energy Modifier Curve Name |
reference | Enter the name of a performance curve which represents the change in cooling energy when heat recovery is active A default constant of 1.1 is used if this input is blank Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup |
|
initial_Initial Heat Recovery Cooling Energy Fraction |
number W/W |
1.0 |
Enter the fractional electric consumption rate at the start of heat recovery mode. The electric consumption rate exponentially approaches the steady-state value according to the inputs for Heat Recovery Cooling Energy Modifier and Heat Recovery Cooling Energy Time Constant |
heat_Heat Recovery Cooling Energy Time Constant |
number hr |
0.0 |
Enter the time constant used to model the transition from cooling only mode to heat recovery mode |
heat_Heat Recovery Heating Capacity Modifier Curve Name |
reference | Enter the name of a performance curve which represents the change in heating capacity when heat recovery is active A default constant of 1.1 is used if this input is blank Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup |
|
initial_Initial Heat Recovery Heating Capacity Fraction |
number W/W |
1.0 |
Enter the fractional capacity available at the start of heat recovery mode. The capacity exponentially approaches the steady-state value according to the inputs for Heat Recovery Heating Capacity Modifier and Heat Recovery Heating Capacity Time Constant |
heat_Heat Recovery Heating Capacity Time Constant |
number hr |
0.15 |
Enter the time constant used to model the transition from cooling only mode to heat recovery mode |
heat_Heat Recovery Heating Energy Modifier Curve Name |
reference | Enter the name of a performance curve which represents the change in heating electric consumption rate when heat recovery is active A default constant of 1.1 is used if this input is blank Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup |
|
initial_Initial Heat Recovery Heating Energy Fraction |
number W/W |
1.0 |
Enter the fractional electric consumption rate at the start of heat recovery mode. The electric consumption rate exponentially approaches the steady-state value according to the inputs for Heat Recovery Cooling Energy Modifier and Heat Recovery Cooling Energy Time Constant |
heat_Heat Recovery Heating Energy Time Constant |
number hr |
0.0 |
Enter the time constant used to model the transition from cooling only mode to heat recovery mode |
Referenced by 2 object types
AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl¶
from idfpy.models import AirConditionerVariableRefrigerantFlowFluidTemperatureControl extensible
This is a key object in the new physics based VRF model applicable for Fluid Temperature Control It describes the Variable Refrigerant Flow system excluding the performance of indoor units Indoor units are modeled separately, see ZoneHVAC:TerminalUnit:VariableRefrigerantFlow
| Field | Type | Default | Details |
|---|---|---|---|
heat_Heat Pump Name required |
string | Enter a unique name for this variable refrigerant flow heat pump | |
availability_Availability Schedule Name |
reference | Enter the name of a schedule that defines the availability of the unit Schedule values of 0 denote the unit is off. All other values denote the unit is available If this field is left blank, the unit is available the entire simulation Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
zone_Zone Terminal Unit List Name required |
reference | Enter the name of a ZoneTerminalUnitList. This list connects zone terminal units to this heat pump Names a ZoneTerminalUnitList |
|
refrigerant_Refrigerant Type |
reference | R410A |
Names a FluidProperties:Name |
rated_Rated Evaporative Capacity |
number or AutosizeW |
40000.0 |
Enter the total evaporative capacity in watts at rated conditions This is the capacity corresponding to the max compressor speed at rated conditions The actual evaporative capacity is obtained by multiplying the rated capacity with the modification factor calculated by Evaporative Capacity Multiplier Function of Temperature Curve |
rated_Rated Compressor Power Per Unit of Rated Evaporative Capacity |
number dimensionless |
0.35 |
Enter the rated compressor power per Watt of rated evaporative capacity [W/W] Rated compressor power corresponds to the max compressor speed at rated conditions The actual compressor power is obtained by multiplying the rated power with the modification factor calculated by Compressor Power Multiplier Function of Temperature Curve Range: > 0 |
minimum_Minimum Outdoor Air Temperature in Cooling Mode |
number C |
-6.0 |
Enter the minimum outdoor temperature allowed for cooling operation Cooling is disabled below this temperature |
maximum_Maximum Outdoor Air Temperature in Cooling Mode |
number C |
43.0 |
Enter the maximum outdoor temperature allowed for cooling operation Cooling is disabled above this temperature |
minimum_Minimum Outdoor Air Temperature in Heating Mode |
number C |
-20.0 |
Enter the minimum outdoor temperature allowed for heating operation Heating is disabled below this temperature |
maximum_Maximum Outdoor Air Temperature in Heating Mode |
number C |
16.0 |
Enter the maximum outdoor temperature allowed for heating operation Heating is disabled below this temperature |
reference_Reference Outdoor Unit Superheating |
number deltaC |
3.0 |
|
reference_Reference Outdoor Unit Subcooling |
number deltaC |
5.0 |
|
refrigerant_Refrigerant Temperature Control Algorithm for Indoor Unit |
choice | VariableTemp |
One of ConstantTemp, VariableTemp |
reference_Reference Evaporating Temperature for Indoor Unit |
number C |
6.0 |
This field is used if Refrigerant Temperature Control Algorithm is ConstantTemp Evaporating temperature is the refrigerant temperature, not air temperature |
reference_Reference Condensing Temperature for Indoor Unit |
number C |
44.0 |
This field is used if Refrigerant Temperature Control Algorithm is ConstantTemp Condensing temperature is the refrigerant temperature, not air temperature |
variable_Variable Evaporating Temperature Minimum for Indoor Unit |
number C |
4.0 |
This field is used if Refrigerant Temperature Control Algorithm is VariableTemp Evaporating temperature is the refrigerant temperature, not air temperature |
variable_Variable Evaporating Temperature Maximum for Indoor Unit |
number C |
13.0 |
This field is used if Refrigerant Temperature Control Algorithm is VariableTemp Evaporating temperature is the refrigerant temperature, not air temperature |
variable_Variable Condensing Temperature Minimum for Indoor Unit |
number C |
42.0 |
This field is used if Refrigerant Temperature Control Algorithm is VariableTemp Condensing temperature is the refrigerant temperature, not air temperature |
variable_Variable Condensing Temperature Maximum for Indoor Unit |
number C |
46.0 |
This field is used if Refrigerant Temperature Control Algorithm is VariableTemp Condensing temperature is the refrigerant temperature, not air temperature |
outdoor_Outdoor Unit Fan Power Per Unit of Rated Evaporative Capacity |
number dimensionless |
0.00425 |
Enter the outdoor unit fan power per Watt of rated evaporative capacity [W/W] Range: > 0 |
outdoor_Outdoor Unit Fan Flow Rate Per Unit of Rated Evaporative Capacity |
number m3/s-W |
7.5e-05 |
This field is only used if the previous is set to autocalculate and performance input method is NominalCapacity Range: > 0 |
outdoor_Outdoor Unit Evaporating Temperature Function of Superheating Curve Name required |
reference | Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more | |
outdoor_Outdoor Unit Condensing Temperature Function of Subcooling Curve Name required |
reference | Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more | |
diameter_Diameter of Main Pipe Connecting Outdoor Unit to the First Branch Joint |
number m |
0.0762 |
used to calculate the piping loss Range: ≥ 0 |
length_Length of Main Pipe Connecting Outdoor Unit to the First Branch Joint |
number m |
30.0 |
used to calculate the heat loss of the main pipe Range: ≥ 0 |
equivalent_Equivalent Length of Main Pipe Connecting Outdoor Unit to the First Branch Joint |
number m |
36.0 |
used to calculate the refrigerant pressure drop of the main pipe Range: ≥ 0 |
height_Height Difference Between Outdoor Unit and Indoor Units |
number m |
5.0 |
Difference between outdoor unit height and indoor unit height Positive means outdoor unit is higher than indoor unit Negative means outdoor unit is lower than indoor unit |
main_Main Pipe Insulation Thickness |
number m |
0.02 |
Range: ≥ 0 |
main_Main Pipe Insulation Thermal Conductivity |
number W/m-K |
0.032 |
Range: ≥ 0 |
crankcase_Crankcase Heater Power per Compressor |
number W |
33.0 |
Enter the value of the resistive heater located in the compressor(s). This heater is used to warm the refrigerant and oil when the compressor is off |
number_Number of Compressors |
integer dimensionless |
2 |
Enter the total number of compressor. This input is used only for crankcase heater calculations. |
ratio_Ratio of Compressor Size to Total Compressor Capacity |
number W/W |
0.5 |
Enter the ratio of the first stage compressor to total compressor capacity All other compressors are assumed to be equally sized. This inputs is used only for crankcase heater calculations |
maximum_Maximum Outdoor Dry-Bulb Temperature for Crankcase Heater |
number C |
5.0 |
Enter the maximum outdoor temperature above which the crankcase heaters are disabled |
defrost_Defrost Strategy |
choice | Resistive |
Select a defrost strategy. Reverse cycle reverses the operating mode from heating to cooling to melt frost formation on the condenser coil The resistive strategy uses a resistive heater to melt the frost. One of Resistive, ReverseCycle |
defrost_Defrost Control |
choice | Timed |
Choose a defrost control type Either use a fixed Timed defrost period or select OnDemand to defrost only when necessary One of OnDemand, Timed |
defrost_Defrost Energy Input Ratio Modifier Function of Temperature Curve Name |
reference | A valid performance curve must be used if ReverseCycle defrost strategy is selected Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup |
|
defrost_Defrost Time Period Fraction |
number | 0.058333 |
Fraction of time in defrost mode Only applicable if timed defrost control is specified Range: ≥ 0 |
resistive_Resistive Defrost Heater Capacity |
number or AutosizeW |
0.0 |
Enter the size of the resistive defrost heating element Only applicable if resistive defrost strategy is specified |
maximum_Maximum Outdoor Dry-bulb Temperature for Defrost Operation |
number C |
5.0 |
Enter the maximum outdoor temperature above which the defrost operation is disabled |
compressor_Compressor maximum delta Pressure |
number Pa |
4500000.0 |
Range: ≥ 0, ≤ 5e+07 |
number_Number of Compressor Loading Index Entries |
integer | 2 |
First index represents minimal capacity operation Last index represents full capacity operation Range: ≥ 2, ≤ 9 |
loading_ |
list | Each item: compressor_speed_at_loading_index (rev/min), loading_index_evaporative_capacity_multiplier_function_of_temperature_curve_name, loading_index_compressor_power_multiplier_function_of_temperature_curve_name |
AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl:HR¶
from idfpy.models import AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR extensible
This is a key object in the new physics based VRF Heat Recovery (HR) model applicable for Fluid Temperature Control. It describes the VRF HR system excluding the performance of indoor units. Indoor units are modeled separately in the ZoneHVAC:TerminalUnit:VariableRefrigerantFlow object
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | Enter a unique name for this variable refrigerant flow heat pump | |
availability_Availability Schedule Name |
reference | Enter the name of a schedule that defines the availability of the unit Schedule values of 0 denote the unit is off. All other values denote the unit is available If this field is left blank, the unit is available the entire simulation Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
zone_Zone Terminal Unit List Name required |
reference | Enter the name of a ZoneTerminalUnitList. This list connects zone terminal units to this heat pump Names a ZoneTerminalUnitList |
|
refrigerant_Refrigerant Type |
reference | R410A |
Names a FluidProperties:Name |
rated_Rated Evaporative Capacity |
number or AutosizeW |
40000.0 |
Enter the total evaporative capacity in watts at rated conditions This is the capacity corresponding to the max compressor speed at rated conditions The actual evaporative capacity is obtained by multiplying the rated capacity with the modification factor calculated by Evaporative Capacity Multiplier Function of Temperature Curve |
rated_Rated Compressor Power Per Unit of Rated Evaporative Capacity |
number dimensionless |
0.35 |
Enter the rated compressor power per Watt of rated evaporative capacity [W/W] Rated compressor power corresponds to the max compressor speed at rated conditions The actual compressor power is obtained by multiplying the rated power with the modification factor calculated by Compressor Power Multiplier Function of Temperature Curve Range: > 0 |
minimum_Minimum Outdoor Air Temperature in Cooling Only Mode |
number C |
-6.0 |
Enter the minimum outdoor temperature allowed for cooling operation Cooling is disabled below this temperature |
maximum_Maximum Outdoor Air Temperature in Cooling Only Mode |
number C |
43.0 |
Enter the maximum outdoor temperature allowed for cooling operation Cooling is disabled above this temperature |
minimum_Minimum Outdoor Air Temperature in Heating Only Mode |
number C |
-20.0 |
Enter the minimum outdoor temperature allowed for heating operation Heating is disabled below this temperature |
maximum_Maximum Outdoor Air Temperature in Heating Only Mode |
number C |
16.0 |
Enter the maximum outdoor temperature allowed for heating operation Heating is disabled below this temperature |
minimum_Minimum Outdoor Temperature in Heat Recovery Mode |
number C |
-20.0 |
The minimum outdoor temperature below which heat recovery mode will not operate. |
maximum_Maximum Outdoor Temperature in Heat Recovery Mode |
number C |
43.0 |
The maximum outdoor temperature above which heat recovery mode will not operate. |
refrigerant_Refrigerant Temperature Control Algorithm for Indoor Unit |
choice | VariableTemp |
One of ConstantTemp, VariableTemp |
reference_Reference Evaporating Temperature for Indoor Unit |
number C |
6.0 |
This field is used if Refrigerant Temperature Control Algorithm is ConstantTemp Evaporating temperature is the refrigerant temperature, not air temperature |
reference_Reference Condensing Temperature for Indoor Unit |
number C |
44.0 |
This field is used if Refrigerant Temperature Control Algorithm is ConstantTemp Condensing temperature is the refrigerant temperature, not air temperature |
variable_Variable Evaporating Temperature Minimum for Indoor Unit |
number C |
4.0 |
This field is used if Refrigerant Temperature Control Algorithm is VariableTemp Evaporating temperature is the refrigerant temperature, not air temperature |
variable_Variable Evaporating Temperature Maximum for Indoor Unit |
number C |
13.0 |
This field is used if Refrigerant Temperature Control Algorithm is VariableTemp Evaporating temperature is the refrigerant temperature, not air temperature |
variable_Variable Condensing Temperature Minimum for Indoor Unit |
number C |
42.0 |
This field is used if Refrigerant Temperature Control Algorithm is VariableTemp Condensing temperature is the refrigerant temperature, not air temperature |
variable_Variable Condensing Temperature Maximum for Indoor Unit |
number C |
46.0 |
This field is used if Refrigerant Temperature Control Algorithm is VariableTemp Condensing temperature is the refrigerant temperature, not air temperature |
outdoor_Outdoor Unit Evaporator Reference Superheating |
number deltaC |
3.0 |
|
outdoor_Outdoor Unit Condenser Reference Subcooling |
number deltaC |
5.0 |
|
outdoor_Outdoor Unit Evaporator Rated Bypass Factor |
number dimensionless |
0.4 |
Range: > 0 |
outdoor_Outdoor Unit Condenser Rated Bypass Factor |
number dimensionless |
0.2 |
Range: > 0 |
difference_Difference between Outdoor Unit Evaporating Temperature and Outdoor Air Temperature in Heat Recovery Mode |
number deltaC |
5.0 |
|
outdoor_Outdoor Unit Heat Exchanger Capacity Ratio |
number dimensionless |
0.3 |
Enter the rated capacity ratio between the main and supplementary outdoor unit heat exchangers [W/W] Range: > 0 |
outdoor_Outdoor Unit Fan Power Per Unit of Rated Evaporative Capacity |
number dimensionless |
0.00425 |
Enter the outdoor unit fan power per Watt of rated evaporative capacity [W/W] Range: > 0 |
outdoor_Outdoor Unit Fan Flow Rate Per Unit of Rated Evaporative Capacity |
number m3/s-W |
7.5e-05 |
Enter the outdoor unit fan flow rate per Watt of rated evaporative capacity [W/W] Range: > 0 |
outdoor_Outdoor Unit Evaporating Temperature Function of Superheating Curve Name required |
reference | Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more | |
outdoor_Outdoor Unit Condensing Temperature Function of Subcooling Curve Name required |
reference | Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more | |
diameter_Diameter of Main Pipe for Suction Gas |
number m |
0.0762 |
used to calculate the piping loss Range: ≥ 0 |
diameter_Diameter of Main Pipe for Discharge Gas |
number m |
0.0762 |
used to calculate the piping loss Range: ≥ 0 |
length_Length of Main Pipe Connecting Outdoor Unit to the First Branch Joint |
number m |
30.0 |
used to calculate the heat loss of the main pipe Range: ≥ 0 |
equivalent_Equivalent Length of Main Pipe Connecting Outdoor Unit to the First Branch Joint |
number m |
36.0 |
used to calculate the refrigerant pressure drop of the main pipe Range: ≥ 0 |
height_Height Difference Between Outdoor Unit and Indoor Units |
number m |
5.0 |
Difference between outdoor unit height and indoor unit height Positive means outdoor unit is higher than indoor unit Negative means outdoor unit is lower than indoor unit |
main_Main Pipe Insulation Thickness |
number m |
0.02 |
Range: ≥ 0 |
main_Main Pipe Insulation Thermal Conductivity |
number W/m-K |
0.032 |
Range: ≥ 0 |
crankcase_Crankcase Heater Power per Compressor |
number W |
33.0 |
Enter the value of the resistive heater located in the compressor(s). This heater is used to warm the refrigerant and oil when the compressor is off |
number_Number of Compressors |
integer dimensionless |
2 |
Enter the total number of compressor. This input is used only for crankcase heater calculations. |
ratio_Ratio of Compressor Size to Total Compressor Capacity |
number W/W |
0.5 |
Enter the ratio of the first stage compressor to total compressor capacity All other compressors are assumed to be equally sized. This inputs is used only for crankcase heater calculations |
maximum_Maximum Outdoor Dry-Bulb Temperature for Crankcase Heater |
number C |
5.0 |
Enter the maximum outdoor temperature above which the crankcase heaters are disabled |
defrost_Defrost Strategy |
choice | Resistive |
Select a defrost strategy. Reverse cycle reverses the operating mode from heating to cooling to melt frost formation on the condenser coil The resistive strategy uses a resistive heater to melt the frost. One of Resistive, ReverseCycle |
defrost_Defrost Control |
choice | Timed |
Choose a defrost control type Either use a fixed Timed defrost period or select OnDemand to defrost only when necessary One of OnDemand, Timed |
defrost_Defrost Energy Input Ratio Modifier Function of Temperature Curve Name |
reference | A valid performance curve must be used if ReverseCycle defrost strategy is selected Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup |
|
defrost_Defrost Time Period Fraction |
number | 0.058333 |
Fraction of time in defrost mode Only applicable if timed defrost control is specified Range: ≥ 0 |
resistive_Resistive Defrost Heater Capacity |
number or AutosizeW |
0.0 |
Enter the size of the resistive defrost heating element Only applicable if resistive defrost strategy is specified |
maximum_Maximum Outdoor Dry-bulb Temperature for Defrost Operation |
number C |
5.0 |
Enter the maximum outdoor temperature above which the defrost operation is disabled |
initial_Initial Heat Recovery Cooling Capacity Fraction |
number W/W |
1.0 |
This is used to describe the transition from Cooling Only mode to Heat Recovery mode Enter the fractional capacity available at the start of heat recovery mode. The capacity exponentially approaches the steady-state value according to the inputs for Heat Recovery Cooling Capacity Modifier and Heat Recovery Cooling Capacity Time Constant |
heat_Heat Recovery Cooling Capacity Time Constant |
number hr |
0.0 |
This is used to describe the transition from Cooling Only mode to Heat Recovery mode Enter the time constant used to model the transition from cooling only mode to heat recovery mode |
initial_Initial Heat Recovery Cooling Energy Fraction |
number W/W |
1.0 |
This is used to describe the transition from Cooling Only mode to Heat Recovery mode Enter the fractional electric consumption rate at the start of heat recovery mode. The electric consumption rate exponentially approaches the steady-state value according to the inputs for Heat Recovery Cooling Energy Modifier and Heat Recovery Cooling Energy Time Constant |
heat_Heat Recovery Cooling Energy Time Constant |
number hr |
0.0 |
This is used to describe the transition from Cooling Only mode to Heat Recovery mode Enter the time constant used to model the transition from cooling only mode to heat recovery mode |
initial_Initial Heat Recovery Heating Capacity Fraction |
number W/W |
1.0 |
This is used to describe the transition from Heating Only mode to Heat Recovery mode Enter the fractional capacity available at the start of heat recovery mode. The capacity exponentially approaches the steady-state value according to the inputs for Heat Recovery Heating Capacity Modifier and Heat Recovery Heating Capacity Time Constant |
heat_Heat Recovery Heating Capacity Time Constant |
number hr |
0.0 |
This is used to describe the transition from Heating Only mode to Heat Recovery mode Enter the time constant used to model the transition from cooling only mode to heat recovery mode |
initial_Initial Heat Recovery Heating Energy Fraction |
number W/W |
1.0 |
This is used to describe the transition from Heating Only mode to Heat Recovery mode Enter the fractional electric consumption rate at the start of heat recovery mode. The electric consumption rate exponentially approaches the steady-state value according to the inputs for Heat Recovery Cooling Energy Modifier and Heat Recovery Cooling Energy Time Constant |
heat_Heat Recovery Heating Energy Time Constant |
number hr |
0.0 |
This is used to describe the transition from Heating Only mode to Heat Recovery mode Enter the time constant used to model the transition from cooling only mode to heat recovery mode |
compressor_Compressor maximum delta Pressure |
number Pa |
4500000.0 |
Range: ≥ 0, ≤ 5e+07 |
compressor_Compressor Inverter Efficiency |
number dimensionless |
0.95 |
Efficiency of the compressor inverter Range: > 0, ≤ 1 |
compressor_Compressor Evaporative Capacity Correction Factor |
number dimensionless |
1.0 |
Describe the evaporative capacity difference because of system configuration difference between test bed and real system. Range: > 0 |
number_Number of Compressor Loading Index Entries |
integer | 2 |
Load index describe the compressor operational state, either a single compressor or multiple compressors, at different load levels. First index represents minimal capacity operation Last index represents full capacity operation Range: ≥ 2 |
loading_ |
list | Each item: compressor_speed_at_loading_index (rev/min), loading_index_evaporative_capacity_multiplier_function_of_temperature_curve_name, loading_index_compressor_power_multiplier_function_of_temperature_curve_name |
AirLoopHVAC:ControllerList¶
from idfpy.models import AirLoopHVACControllerList
List controllers in order of control sequence
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
controller_Controller 1 Object Type required |
choice | One of Controller:OutdoorAir, Controller:WaterCoil |
|
controller_Controller 1 Name required |
reference | Names a Controller:OutdoorAir, Controller:WaterCoil | |
controller_Controller 2 Object Type |
choice | One of Controller:OutdoorAir, Controller:WaterCoil |
|
controller_Controller 2 Name |
reference | Names a Controller:OutdoorAir, Controller:WaterCoil | |
controller_Controller 3 Object Type |
choice | One of Controller:OutdoorAir, Controller:WaterCoil |
|
controller_Controller 3 Name |
reference | Names a Controller:OutdoorAir, Controller:WaterCoil | |
controller_Controller 4 Object Type |
choice | One of Controller:OutdoorAir, Controller:WaterCoil |
|
controller_Controller 4 Name |
reference | Names a Controller:OutdoorAir, Controller:WaterCoil | |
controller_Controller 5 Object Type |
choice | One of Controller:OutdoorAir, Controller:WaterCoil |
|
controller_Controller 5 Name |
reference | Names a Controller:OutdoorAir, Controller:WaterCoil | |
controller_Controller 6 Object Type |
choice | One of Controller:OutdoorAir, Controller:WaterCoil |
|
controller_Controller 6 Name |
reference | Names a Controller:OutdoorAir, Controller:WaterCoil | |
controller_Controller 7 Object Type |
choice | One of Controller:OutdoorAir, Controller:WaterCoil |
|
controller_Controller 7 Name |
reference | Names a Controller:OutdoorAir, Controller:WaterCoil | |
controller_Controller 8 Object Type |
choice | One of Controller:OutdoorAir, Controller:WaterCoil |
|
controller_Controller 8 Name |
reference | Names a Controller:OutdoorAir, Controller:WaterCoil |
Referenced by 2 object types
AirflowNetwork:Distribution:Component:Coil¶
from idfpy.models import AirflowNetworkDistributionComponentCoil
This object defines the name of a coil used in an air loop.
| Field | Type | Default | Details |
|---|---|---|---|
coil_Coil Name required |
reference | Enter the name of a cooling or heating coil in the primary Air loop. Names a Coil:Cooling:DX, Coil:Cooling:DX:MultiSpeed, Coil:Cooling:DX:SingleSpeed, Coil:Cooling:DX:SingleSpeed:ThermalStorage, Coil:Cooling:DX:TwoSpeed, Coil:Cooling:DX:TwoStageWithHumidityControlMode, Coil:Cooling:DX:VariableSpeed, Coil:Cooling:Water, Coil:Cooling:Water:DetailedGeometry, Coil:Cooling:WaterToAirHeatPump:EquationFit, Coil:Cooling:WaterToAirHeatPump:VariableSpeedEquationFit, Coil:Heating:DX:MultiSpeed and 8 more |
|
coil_Coil Object Type required |
choice | Select the type of coil corresponding to the name entered in the field above. One of Coil:Cooling:DX, Coil:Cooling:DX:MultiSpeed, Coil:Cooling:DX:SingleSpeed, Coil:Cooling:DX:TwoSpeed, Coil:Cooling:DX:TwoStageWithHumidityControlMode, Coil:Cooling:DX:VariableSpeed, Coil:Cooling:Water, Coil:Cooling:Water:DetailedGeometry, Coil:Cooling:WaterToAirHeatPump:EquationFit, Coil:Cooling:WaterToAirHeatPump:VariableSpeedEquationFit, Coil:Heating:DX:MultiSpeed, Coil:Heating:DX:SingleSpeed, Coil:Heating:DX:VariableSpeed, Coil:Heating:Desuperheater, Coil:Heating:Electric, Coil:Heating:Electric:MultiStage, Coil:Heating:Fuel, Coil:Heating:Gas:MultiStage, Coil:Heating:Water, Coil:Heating:WaterToAirHeatPump:EquationFit, Coil:Heating:WaterToAirHeatPump:VariableSpeedEquationFit |
|
air_Air Path Length required |
number m |
Enter the air path length (depth) for the coil. Range: > 0 |
|
air_Air Path Hydraulic Diameter required |
number m |
Enter the hydraulic diameter of this coil. The hydraulic diameter is defined as 4 multiplied by the cross section area divided by perimeter. Range: > 0 |
Referenced by 3 object types
AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:Distribution:Linkage, AirflowNetwork:IntraZone:Linkage
AirflowNetwork:Distribution:Component:ConstantPressureDrop¶
from idfpy.models import AirflowNetworkDistributionComponentConstantPressureDrop
This object defines the characteristics of a constant pressure drop component (e.g. filter). Each node connected to this object can not be a node of mixer, splitter, a node of air primary loop, or zone equipment loop. It is recommended to connect to a duct component at both ends.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | Enter a unique name for this object. | |
pressure_Pressure Difference Across the Component required |
number Pa |
Enter the pressure drop across this component. Range: > 0 |
Referenced by 3 object types
AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:Distribution:Linkage, AirflowNetwork:IntraZone:Linkage
AirflowNetwork:Distribution:Component:Duct¶
from idfpy.models import AirflowNetworkDistributionComponentDuct
This object defines the relationship between pressure and air flow through the duct.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | Enter a unique name for this object. | |
duct_Duct Length required |
number m |
Enter the length of the duct. Range: > 0 |
|
hydraulic_Hydraulic Diameter required |
number m |
Enter the hydraulic diameter of the duct. Hydraulic diameter is defined as 4 multiplied by cross section area divided by perimeter Range: > 0 |
|
cross_Cross Section Area required |
number m2 |
Enter the cross section area of the duct. Range: > 0 |
|
surface_Surface Roughness |
number m |
0.0009 |
Enter the inside surface roughness of the duct. Range: > 0 |
coefficient_Coefficient for Local Dynamic Loss Due to Fitting |
number dimensionless |
0.0 |
Enter the coefficient used to calculate dynamic losses of fittings (e.g. elbows). Range: ≥ 0 |
heat_Heat Transmittance Coefficient (U-Factor) for Duct Wall Construction |
number W/m2-K |
0.943 |
conduction only Default value of 0.943 is equivalent to 1.06 m2-K/W (R6) duct insulation. Range: > 0 |
overall_Overall Moisture Transmittance Coefficient from Air to Air |
number kg/m2 |
0.001 |
Enter the overall moisture transmittance coefficient including moisture film coefficients at both surfaces. Range: > 0 |
outside_Outside Convection Coefficient |
number W/m2-K |
optional. convection coefficient calculated automatically, unless specified Range: > 0 |
|
inside_Inside Convection Coefficient |
number W/m2-K |
optional. convection coefficient calculated automatically, unless specified Range: > 0 |
Referenced by 3 object types
AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:Distribution:Linkage, AirflowNetwork:IntraZone:Linkage
AirflowNetwork:Distribution:Component:Fan¶
from idfpy.models import AirflowNetworkDistributionComponentFan
This object defines the name of the supply Air Fan used in an Air loop.
| Field | Type | Default | Details |
|---|---|---|---|
fan_Fan Name required |
reference | Enter the name of the fan in the primary air loop. Names a Fan:ConstantVolume, Fan:OnOff, Fan:SystemModel, Fan:VariableVolume |
|
supply_Supply Fan Object Type |
choice | Fan:ConstantVolume |
One of Fan:ConstantVolume, Fan:OnOff, Fan:SystemModel, Fan:VariableVolume |
Referenced by 3 object types
AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:Distribution:Linkage, AirflowNetwork:IntraZone:Linkage
AirflowNetwork:Distribution:Component:HeatExchanger¶
from idfpy.models import AirflowNetworkDistributionComponentHeatExchanger
This object defines the name of an air-to-air heat exchanger used in an air loop.
| Field | Type | Default | Details |
|---|---|---|---|
heatexchanger_HeatExchanger Name required |
reference | Enter the name of an air-to-air heat exchanger in the primary Air loop. Names a HeatExchanger:AirToAir:FlatPlate, HeatExchanger:AirToAir:SensibleAndLatent, HeatExchanger:Desiccant:BalancedFlow |
|
heatexchanger_HeatExchanger Object Type required |
choice | Select the type of heat exchanger corresponding to the name entered in the field above. One of HeatExchanger:AirToAir:FlatPlate, HeatExchanger:AirToAir:SensibleAndLatent, HeatExchanger:Desiccant:BalancedFlow |
|
air_Air Path Length required |
number m |
Enter the air path length (depth) for the heat exchanger. Range: > 0 |
|
air_Air Path Hydraulic Diameter required |
number m |
Enter the hydraulic diameter of this heat exchanger. The hydraulic diameter is defined as 4 multiplied by the cross section area divided by perimeter. Range: > 0 |
Referenced by 3 object types
AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:Distribution:Linkage, AirflowNetwork:IntraZone:Linkage
AirflowNetwork:Distribution:Component:Leak¶
from idfpy.models import AirflowNetworkDistributionComponentLeak
This object defines the characteristics of a supply or return air leak.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | Enter a unique name for this object. | |
air_Air Mass Flow Coefficient required |
number kg/s |
Defined at 1 Pa pressure difference across this component. Enter the coefficient used in the following equation: Mass Flow Rate = Air Mass Flow Coefficient * (dP)^Air Mass Flow Exponent Range: > 0 |
|
air_Air Mass Flow Exponent |
number dimensionless |
0.65 |
Enter the exponent used in the following equation: Mass Flow Rate = Air Mass Flow Coefficient * (dP)^Air Mass Flow Exponent Range: ≥ 0.5, ≤ 1 |
Referenced by 3 object types
AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:Distribution:Linkage, AirflowNetwork:IntraZone:Linkage
AirflowNetwork:Distribution:Component:LeakageRatio¶
from idfpy.models import AirflowNetworkDistributionComponentLeakageRatio
This object is used to define supply and return air leaks with respect to the fan's maximum air flow rate.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | Enter a unique name for this object. | |
effective_Effective Leakage Ratio |
number dimensionless |
Defined as a ratio of leak flow rate to the maximum flow rate. Range: > 0, ≤ 1 |
|
maximum_Maximum Flow Rate required |
number m3/s |
Enter the maximum air flow rate in this air loop. Range: > 0 |
|
reference_Reference Pressure Difference required |
number Pa |
Enter the pressure corresponding to the Effective leakage ratio entered above. Range: > 0 |
|
air_Air Mass Flow Exponent |
number dimensionless |
0.65 |
Enter the exponent used in the air mass flow equation. Range: ≥ 0.5, ≤ 1 |
Referenced by 3 object types
AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:Distribution:Linkage, AirflowNetwork:IntraZone:Linkage
AirflowNetwork:Distribution:Component:OutdoorAirFlow¶
from idfpy.models import AirflowNetworkDistributionComponentOutdoorAirFlow
This object includes the outdoor air flow rate set by the Controller:OutdoorAir object in the airflow network.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
outdoor_Outdoor Air Mixer Name required |
reference | Names a OutdoorAir:Mixer | |
air_Air Mass Flow Coefficient When No Outdoor Air Flow at Reference Conditions required |
number kg/s |
Enter the air mass flow coefficient at the conditions defined in the Reference Crack Conditions object. Defined at 1 Pa pressure difference. Enter the coefficient used in the following equation: Mass Flow Rate = Air Mass Flow Coefficient * (dP)^Air Mass Flow Exponent. Used only when no outdoor air flow rate. Range: > 0 |
|
air_Air Mass Flow Exponent When No Outdoor Air Flow |
number dimensionless |
0.65 |
Enter the exponent used in the following equation: Mass Flow Rate = Air Mass Flow Coefficient * (dP)^Air Mass Flow Exponent. Used only when no outdoor air flow rate. Range: ≥ 0.5, ≤ 1 |
reference_Reference Crack Conditions |
reference | Select a AirflowNetwork:MultiZone:ReferenceCrackConditions name associated with the air mass flow coefficient entered above. Names a AirflowNetwork:MultiZone:ReferenceCrackConditions |
Referenced by 3 object types
AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:Distribution:Linkage, AirflowNetwork:IntraZone:Linkage
AirflowNetwork:Distribution:Component:ReliefAirFlow¶
from idfpy.models import AirflowNetworkDistributionComponentReliefAirFlow
This object allows variation of air flow rate to perform pressure.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
outdoor_Outdoor Air Mixer Name required |
reference | Names a OutdoorAir:Mixer | |
air_Air Mass Flow Coefficient When No Outdoor Air Flow at Reference Conditions required |
number kg/s |
Enter the air mass flow coefficient at the conditions defined in the Reference Crack Conditions object. Defined at 1 Pa pressure difference. Enter the coefficient used in the following equation: Mass Flow Rate = Air Mass Flow Coefficient * (dP)^Air Mass Flow Exponent. Used only when no outdoor air flow rate. Range: > 0 |
|
air_Air Mass Flow Exponent When No Outdoor Air Flow |
number dimensionless |
0.65 |
Enter the exponent used in the following equation: Mass Flow Rate = Air Mass Flow Coefficient * (dP)^Air Mass Flow Exponent. Used only when no outdoor air flow rate. Range: ≥ 0.5, ≤ 1 |
reference_Reference Crack Conditions |
reference | Select a AirflowNetwork:MultiZone:ReferenceCrackConditions name associated with the air mass flow coefficient entered above. Names a AirflowNetwork:MultiZone:ReferenceCrackConditions |
Referenced by 4 object types
AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:Distribution:Linkage, AirflowNetwork:IntraZone:Linkage, AirflowNetwork:ZoneControl:PressureController
AirflowNetwork:Distribution:Component:TerminalUnit¶
from idfpy.models import AirflowNetworkDistributionComponentTerminalUnit
This object defines the name of a terminal unit in an air loop.
| Field | Type | Default | Details |
|---|---|---|---|
terminal_Terminal Unit Name required |
reference | Enter the name of a terminal unit in the AirLoopHVAC. Names a AirTerminal:SingleDuct:ConstantVolume:NoReheat, AirTerminal:SingleDuct:ConstantVolume:Reheat, AirTerminal:SingleDuct:VAV:Reheat |
|
terminal_Terminal Unit Object Type required |
choice | Select the type of terminal unit corresponding to the name entered in the field above. One of AirTerminal:SingleDuct:ConstantVolume:Reheat, AirTerminal:SingleDuct:VAV:Reheat |
|
air_Air Path Length required |
number m |
Enter the air path length (depth) for the terminal unit. Range: > 0 |
|
air_Air Path Hydraulic Diameter required |
number m |
Enter the hydraulic diameter of this terminal unit. The hydraulic diameter is defined as 4 multiplied by the cross section area divided by perimeter. Range: > 0 |
Referenced by 3 object types
AirflowNetwork:Distribution:DuctViewFactors, AirflowNetwork:Distribution:Linkage, AirflowNetwork:IntraZone:Linkage
AirflowNetwork:Distribution:DuctSizing¶
from idfpy.models import AirflowNetworkDistributionDuctSizing unique
This object defines required parameters for duct sizing in an Airflow Network simulation. To activate duct sizing, see AirflowNetwork:SimulationControl Do Distribution Duct Sizing Calculation.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
duct_Duct Sizing Method |
choice | MaximumVelocity |
One of MaximumVelocity, PressureLoss, PressureLossWithMaximumVelocity |
duct_Duct Sizing Factor |
number | 1.0 |
Range: > 0 |
maximum_Maximum Airflow Velocity |
number m/s |
5.0 |
Used only if Duct Sizing Type = MaximumVelocity or PressureLossWithMaximumVelocity. When MaximumVelocity is entered, duct diameter is calculated at D = flow rate / cross section area. When PressureLossWithMaximumVelocity is entered, duct diameter is calculated based on PressureLoss. The value is used to check to ensure the final velocity is less than the maximum value. If greater, final value will be obtained from MaximumVelocity. This field is apply for trunk size, while branch size is based on total pressure drop. Range: > 0, ≤ 25 |
total_Total Pressure Loss Across Supply Trunk |
number Pa |
Used only if Duct Sizing Type = PressureLoss or PressureLossWithMaximumVelocity. When PressureLoss is entered, duct diameter is calculated using Colebrook's equation When PressureLossWithMaximumVelocity is entered, duct diameter is calculated based on PressureLoss. The value is used to check to ensure the final velocity is less than the maximum value. If greater, final value will be obtained from MaximumVelocity. This field is apply for trunk size, while branch size is based on total pressure drop. Range: > 0 |
|
total_Total Pressure Loss Across Supply Branch |
number Pa |
Duct diameter is calculated using Colebrook's equation. When there is no solution, velocity = 5 m/s is used to calculate duct diameter. Range: > 0 |
|
total_Total Pressure Loss Across Return Trunk |
number Pa |
Duct diameter is calculated using Colebrook's equation. When there is no solution, velocity = 5 m/s is used to calculate duct diameter. Range: > 0 |
|
total_Total Pressure Loss Across Return Branch |
number Pa |
Duct diameter is calculated using Colebrook's equation. When there is no solution, velocity = 5 m/s is used to calculate duct diameter. Range: > 0 |
AirflowNetwork:Distribution:DuctViewFactors¶
from idfpy.models import AirflowNetworkDistributionDuctViewFactors extensible
This object is used to allow user-defined view factors to be used for duct-surface radiation calculations. All surfaces must be in the same enclosure.
| Field | Type | Default | Details |
|---|---|---|---|
linkage_Linkage Name required |
reference | Names a AirflowNetwork:Distribution:Component:Coil, AirflowNetwork:Distribution:Component:ConstantPressureDrop, AirflowNetwork:Distribution:Component:Duct, AirflowNetwork:Distribution:Component:Fan, AirflowNetwork:Distribution:Component:HeatExchanger, AirflowNetwork:Distribution:Component:Leak, AirflowNetwork:Distribution:Component:LeakageRatio, AirflowNetwork:Distribution:Component:OutdoorAirFlow, AirflowNetwork:Distribution:Component:ReliefAirFlow, AirflowNetwork:Distribution:Component:TerminalUnit | |
duct_Duct Surface Exposure Fraction |
number | 0.0 |
Range: ≥ 0, ≤ 1 |
duct_Duct Surface Emittance |
number | 0.9 |
Range: ≥ 0, ≤ 1 |
surfaces |
list | Each item: surface_name, surface_view_factor |
AirflowNetwork:Distribution:Linkage¶
from idfpy.models import AirflowNetworkDistributionLinkage
This object defines the connection between two nodes and a component.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | Enter a unique name for this object. | |
node_Node 1 Name required |
reference | Enter the name of zone or AirflowNetwork Node. Names a AirflowNetwork:Distribution:Node, Zone |
|
node_Node 2 Name required |
reference | Enter the name of zone or AirflowNetwork Node. Names a AirflowNetwork:Distribution:Node, Zone |
|
component_Component Name required |
reference | Enter the name of an AirflowNetwork component. A component is one of the following AirflowNetwork:Distribution:Component objects: Leak, LeakageRatio, Duct, ConstantVolumeFan, Coil, TerminalUnit, ConstantPressureDrop, or HeatExchanger. Names a AirTerminal:SingleDuct:ConstantVolume:NoReheat, AirTerminal:SingleDuct:ConstantVolume:Reheat, AirTerminal:SingleDuct:VAV:Reheat, AirflowNetwork:Distribution:Component:Coil, AirflowNetwork:Distribution:Component:ConstantPressureDrop, AirflowNetwork:Distribution:Component:Duct, AirflowNetwork:Distribution:Component:Fan, AirflowNetwork:Distribution:Component:HeatExchanger, AirflowNetwork:Distribution:Component:Leak, AirflowNetwork:Distribution:Component:LeakageRatio, AirflowNetwork:Distribution:Component:OutdoorAirFlow, AirflowNetwork:Distribution:Component:ReliefAirFlow and 27 more |
|
thermal_Thermal Zone Name |
reference | Only used if component = AirflowNetwork:Distribution:Component:Duct The zone name is where AirflowNetwork:Distribution:Component:Duct is exposed. Leave this field blank if the duct conduction loss is ignored. Names a Zone |
Referenced by 3 object types
Duct:Loss:Conduction, Duct:Loss:Leakage, Duct:Loss:MakeupAir
AirflowNetwork:Distribution:Node¶
from idfpy.models import AirflowNetworkDistributionNode
This object represents an air distribution node in the AirflowNetwork model.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | Enter a unique name for this object. | |
component_Component Name or Node Name |
string | Designates node names defined in another object. The node name may occur in air branches. Enter a node name to represent a node already defined in an air loop. Leave this field blank if the Node or Object Type field below is entered as AirLoopHVAC:ZoneMixer, AirLoopHVAC:ZoneSplitter, AirLoopHVAC:OutdoorAirSystem, or Other. | |
component_Component Object Type or Node Type |
choice | Other |
Designates Node type for the Node or Component Name defined in the field above. AirLoopHVAC:ZoneMixer -- Represents a AirLoopHVAC:ZoneMixer object. AirLoopHVAC:ZoneSplitter -- Represents a AirLoopHVAC:ZoneSplitter object. AirLoopHVAC:OutdoorAirSystem -- Represents an AirLoopHVAC:OutdoorAirSystem object. OAMixerOutdoorAirStreamNode -- Represents an external node used in the OutdoorAir:Mixer OutdoorAir:NodeList -- Represents an external node when a heat exchanger is used before the OutdoorAir:Mixer OutdoorAir:Node -- Represents an external node when a heat exchanger is used before the OutdoorAir:Mixer Other -- none of the above, the Node name already defined in the previous field is part of an air loop. Zone -- Enter a zone name for duct simple model to calculate duct loss without using AFN model. One of AirLoopHVAC:OutdoorAirSystem, AirLoopHVAC:ZoneMixer, AirLoopHVAC:ZoneSplitter, OAMixerOutdoorAirStreamNode, Other, OutdoorAir:Node, OutdoorAir:NodeList, Zone |
node_Node Height |
number m |
0.0 |
Enter the reference height used to calculate the relative pressure. |
Referenced by 1 object types
AirflowNetwork:IntraZone:Linkage¶
from idfpy.models import AirflowNetworkIntraZoneLinkage
This object defines the connection between two nodes and a component used in the combination of RoomAir and AirflowNetwork model.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | Enter a unique name for this object. | |
node_Node 1 Name required |
reference | Enter the name of zone or AirflowNetwork Node. Names a AirflowNetwork:IntraZone:Node, Zone |
|
node_Node 2 Name required |
reference | Enter the name of zone or AirflowNetwork Node. Names a AirflowNetwork:IntraZone:Node, Zone |
|
component_Component Name |
reference | Enter the name of an AirflowNetwork component. A component is one of the following AirflowNetwork:Multizone:Component objects: AirflowNetwork:MultiZone:Surface:Crack, AirflowNetwork:MultiZone:Surface:EffectiveLeakageArea, If the next field is specified, this field can be either blank or ignored. Names a AirflowNetwork:Distribution:Component:Coil, AirflowNetwork:Distribution:Component:ConstantPressureDrop, AirflowNetwork:Distribution:Component:Duct, AirflowNetwork:Distribution:Component:Fan, AirflowNetwork:Distribution:Component:HeatExchanger, AirflowNetwork:Distribution:Component:Leak, AirflowNetwork:Distribution:Component:LeakageRatio, AirflowNetwork:Distribution:Component:OutdoorAirFlow, AirflowNetwork:Distribution:Component:ReliefAirFlow, AirflowNetwork:Distribution:Component:TerminalUnit |
|
airflownetwork_AirflowNetwork:MultiZone:Surface Name |
reference | Only used when one of two nodes defined above are not located in the same zone, and the input of the Component Name field in this object is ignored Names a BuildingSurface:Detailed, Ceiling:Adiabatic, Ceiling:Interzone, Door, Door:Interzone, FenestrationSurface:Detailed, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone, GlazedDoor, GlazedDoor:Interzone and 9 more |
AirflowNetwork:IntraZone:Node¶
from idfpy.models import AirflowNetworkIntraZoneNode
This object represents a node in a zone in the combination of RoomAir and AirflowNetwork model.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | Enter a unique name for this object. | |
roomair_RoomAir:Node:AirflowNetwork Name required |
reference | Enter the name of a RoomAir:Node object defined in a RoomAirSettings:AirflowNetwork object. Names a RoomAir:Node:AirflowNetwork |
|
zone_Zone Name required |
reference | Enter the name of a zone object defined in a AirflowNetwork:MultiZone:Zone object. Names a AirflowNetwork:MultiZone:Zone |
|
node_Node Height |
number m |
0.0 |
Enter the reference height used to calculate the relative pressure |
Referenced by 1 object types
AirflowNetwork:MultiZone:Component:DetailedOpening¶
from idfpy.models import AirflowNetworkMultiZoneComponentDetailedOpening
This object specifies the properties of airflow through windows and doors (window, door and glass door heat transfer subsurfaces) when they are closed or open.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | Enter a unique name for this object. | |
air_Air Mass Flow Coefficient When Opening is Closed required |
number kg/s-m |
Defined at 1 Pa per meter of crack length. Enter the coefficient used in the following equation: Mass Flow Rate = Air Mass Flow Coefficient * (dP)^Air Mass Flow Exponent. Used only when opening (window or door) is closed. Range: > 0 |
|
air_Air Mass Flow Exponent When Opening is Closed |
number dimensionless |
0.65 |
Enter the exponent used in the following equation: Mass Flow Rate = Air Mass Flow Coefficient * (dP)^Air Mass Flow Exponent. Used only when opening (window or door) is closed. Range: ≥ 0.5, ≤ 1 |
type_Type of Rectangular Large Vertical Opening (LVO) |
choice | NonPivoted |
Select the type of vertical opening: Non-pivoted opening or Horizontally pivoted opening. One of HorizontallyPivoted, NonPivoted |
extra_Extra Crack Length or Height of Pivoting Axis |
number m |
0.0 |
Extra crack length is used for LVO Non-pivoted type with multiple openable parts. Height of pivoting axis is used for LVO Horizontally pivoted type. Specifies window or door characteristics that depend on the LVO type. For Non-pivoted Type (rectangular windows and doors), this field is the extra crack length in meters due to multiple openable parts, if present. Extra here means in addition to the length of the cracks on the top, bottom and sides of the window/door. For Horizontally pivoted Type, this field gives the height of the pivoting axis measured from the bottom of the glazed part of the window (m). Range: ≥ 0 |
number_Number of Sets of Opening Factor Data required |
integer | Enter the number of the following sets of data for opening factor, discharge coefficient, width factor, height factor, and start height factor. Range: ≥ 2, ≤ 4 |
|
opening_Opening Factor 1 |
number dimensionless |
0.0 |
This value must be specified as 0. Range: ≥ 0, ≤ 0 |
discharge_Discharge Coefficient for Opening Factor 1 |
number dimensionless |
0.001 |
The Discharge Coefficient indicates the fractional effectiveness for air flow through a window or door at that Opening Factor. Range: > 0, ≤ 1 |
width_Width Factor for Opening Factor 1 |
number dimensionless |
0.0 |
The Width Factor is the opening width divided by the window or door width. Range: ≥ 0, ≤ 1 |
height_Height Factor for Opening Factor 1 |
number dimensionless |
0.0 |
The Height Factor is the opening height divided by the window or door height. Range: ≥ 0, ≤ 1 |
start_Start Height Factor for Opening Factor 1 |
number dimensionless |
0.0 |
The Start Height Factor is the Start Height divided by the window or door height. Start Height is the distance between the bottom of the window or door and the bottom of the window or door opening. The sum of the Height Factor and the Start Height Factor must be less than 1.0 in order to have the opening within the window or door dimensions. Range: ≥ 0, ≤ 1 |
opening_Opening Factor 2 required |
number dimensionless |
If Number of Sets of Opening Factor Data = 2, this value must be 1.0. If Number of Sets of Opening Factor Data = 3, this value must be less than 1.0. If Number of Sets of Opening Factor Data = 4, this value must be less than the value entered for Opening factor 3 and greater than the value entered for Opening factor 1. Range: > 0, ≤ 1 |
|
discharge_Discharge Coefficient for Opening Factor 2 |
number dimensionless |
1.0 |
The Discharge Coefficient indicates the fractional effectiveness for air flow through a window or door at that Opening Factor. Range: > 0, ≤ 1 |
width_Width Factor for Opening Factor 2 |
number dimensionless |
1.0 |
The Width Factor is the opening width divided by the window or door width. Range: > 0, ≤ 1 |
height_Height Factor for Opening Factor 2 |
number dimensionless |
1.0 |
The Height Factor is the opening height divided by the window or door height. Range: > 0, ≤ 1 |
start_Start Height Factor for Opening Factor 2 |
number dimensionless |
0.0 |
The Start Height Factor is the Start Height divided by the window or door height. Start Height is the distance between the bottom of the window or door and the bottom of the window or door opening. The sum of the Height Factor and the Start Height Factor must be less than 1.0 in order to have the opening within the window or door dimensions. Range: ≥ 0, < 1 |
opening_Opening Factor 3 |
number dimensionless |
If Number of Sets of Opening Factor Data = 3, this value must be 1.0. If Number of Sets of Opening Factor Data = 4, this value must be less than 1.0, and greater than value entered for Opening factor 2. Range: ≥ 0, ≤ 1 |
|
discharge_Discharge Coefficient for Opening Factor 3 |
number dimensionless |
0.0 |
The Discharge Coefficient indicates the fractional effectiveness for air flow through a window or door at that Opening Factor. Range: ≥ 0, ≤ 1 |
width_Width Factor for Opening Factor 3 |
number dimensionless |
0.0 |
The Width Factor is the opening width divided by the window or door width. Range: ≥ 0, ≤ 1 |
height_Height Factor for Opening Factor 3 |
number dimensionless |
0.0 |
The Height Factor is the opening height divided by the window or door height. Range: ≥ 0, ≤ 1 |
start_Start Height Factor for Opening Factor 3 |
number dimensionless |
0.0 |
The Start Height Factor is the Start Height divided by the window or door height. Start Height is the distance between the bottom of the window or door and the bottom of the window or door opening. The sum of the Height Factor and the Start Height Factor must be less than 1.0 in order to have the opening within the window or door dimensions. Range: ≥ 0, ≤ 1 |
opening_Opening Factor 4 |
number dimensionless |
If Number of Sets of Opening Factor Data = 4, this value must be 1.0 Range: ≥ 0, ≤ 1 |
|
discharge_Discharge Coefficient for Opening Factor 4 |
number dimensionless |
0.0 |
The Discharge Coefficient indicates the fractional effectiveness for air flow through a window or door at that Opening Factor. Range: ≥ 0, ≤ 1 |
width_Width Factor for Opening Factor 4 |
number dimensionless |
0.0 |
The Width Factor is the opening width divided by the window or door width. Range: ≥ 0, ≤ 1 |
height_Height Factor for Opening Factor 4 |
number dimensionless |
0.0 |
The Height Factor is the opening height divided by the window or door height. Range: ≥ 0, ≤ 1 |
start_Start Height Factor for Opening Factor 4 |
number dimensionless |
0.0 |
The Start Height Factor is the Start Height divided by the window or door height. Start Height is the distance between the bottom of the window or door and the bottom of the window or door opening. The sum of the Height Factor and the Start Height Factor must be less than 1.0 in order to have the opening within the window or door dimensions. Range: ≥ 0, ≤ 1 |
Referenced by 1 object types
AirflowNetwork:MultiZone:Component:HorizontalOpening¶
from idfpy.models import AirflowNetworkMultiZoneComponentHorizontalOpening
This object specifies the properties of air flow through a horizontal opening
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | Enter a unique name for this object. | |
air_Air Mass Flow Coefficient When Opening is Closed required |
number kg/s-m |
Defined at 1 Pa pressure difference. Enter the coefficient used in the following equation: Mass flow rate = Air Mass Flow Coefficient * (dP)^Air Mass Flow Exponent. Used only when opening is closed. Range: > 0 |
|
air_Air Mass Flow Exponent When Opening is Closed |
number dimensionless |
0.65 |
Enter the exponent used in the following equation: Mass flow rate = Air Mass Flow Coefficient * (dP)^Air Mass Flow Exponent. Used only when opening is closed. Range: ≥ 0.5, ≤ 1 |
sloping_Sloping Plane Angle |
number deg |
90.0 |
Sloping plane angle = 90 is equivalent to fully open. Range: > 0, ≤ 90 |
discharge_Discharge Coefficient required |
number dimensionless |
The Discharge Coefficient indicates the fractional effectiveness for air flow through the opening at that Opening Factor. Range: > 0 |
Referenced by 1 object types
AirflowNetwork:MultiZone:Component:SimpleOpening¶
from idfpy.models import AirflowNetworkMultiZoneComponentSimpleOpening
This object specifies the properties of air flow through windows and doors (window, door and glass door heat transfer subsurfaces) when they are closed or open.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | Enter a unique name for this object. | |
air_Air Mass Flow Coefficient When Opening is Closed required |
number kg/s-m |
Defined at 1 Pa pressure difference. Enter the coefficient used in the following equation: Mass Flow Rate = Air Mass Flow Coefficient * (dP)^Air Mass Flow Exponent. Used only when opening (window or door) is closed. Range: > 0 |
|
air_Air Mass Flow Exponent When Opening is Closed |
number dimensionless |
0.65 |
Enter the exponent used in the following equation: Mass Flow Rate = Air Mass Flow Coefficient * (dP)^Air Mass Flow Exponent. Used only when opening (window or door) is closed. Range: ≥ 0.5, ≤ 1 |
minimum_Minimum Density Difference for Two-Way Flow required |
number kg/m3 |
Enter the minimum density difference above which two-way flow may occur due to stack effect. Range: > 0 |
|
discharge_Discharge Coefficient required |
number dimensionless |
The Discharge Coefficient indicates the fractional effectiveness for air flow through a window or door at that Opening Factor. Range: > 0 |
Referenced by 1 object types
AirflowNetwork:MultiZone:Component:ZoneExhaustFan¶
from idfpy.models import AirflowNetworkMultiZoneComponentZoneExhaustFan
This object specifies the additional properties for a zone exhaust fan to perform multizone airflow calculations.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
reference | Enter the name of a Fan:ZoneExhaust object. Names a Fan:ZoneExhaust |
|
air_Air Mass Flow Coefficient When the Zone Exhaust Fan is Off at Reference Conditions required |
number kg/s |
Enter the air mass flow coefficient at the conditions defined in the Reference Crack Conditions object. Defined at 1 Pa pressure difference. Enter the coefficient used in the following equation: Mass Flow Rate = Air Mass Flow Coefficient * (dP)^Air Mass Flow Exponent. Used only when the fan is off. Range: > 0 |
|
air_Air Mass Flow Exponent When the Zone Exhaust Fan is Off |
number dimensionless |
0.65 |
Enter the exponent used in the following equation: Mass Flow Rate = Air Mass Flow Coefficient * (dP)^Air Mass Flow Exponent. Used only when the fan is off. Range: ≥ 0.5, ≤ 1 |
reference_Reference Crack Conditions |
reference | Select a AirflowNetwork:MultiZone:ReferenceCrackConditions name associated with the air mass flow coefficient entered above. Names a AirflowNetwork:MultiZone:ReferenceCrackConditions |
Referenced by 1 object types
AirflowNetwork:MultiZone:ExternalNode¶
from idfpy.models import AirflowNetworkMultiZoneExternalNode
This object defines outdoor environmental conditions outside of the building.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | Enter a unique name for this object. This node name will be referenced by a particular building facade. | |
external_External Node Height |
number m |
0.0 |
Designates the reference height used to calculate relative pressure. |
wind_Wind Pressure Coefficient Curve Name required |
reference | The name of the AirflowNetwork:MultiZone:WindPressureCoefficientValues, curve, or table object specifying the wind pressure coefficient. Names a AirflowNetwork:MultiZone:WindPressureCoefficientValues, Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2 and 2 more |
|
symmetric_Symmetric Wind Pressure Coefficient Curve |
choice | No |
Specify whether the pressure curve is symmetric or not. Specify Yes for curves that should be evaluated from 0 to 180 degrees Specify No for curves that should be evaluated from 0 to 360 degrees One of No, Yes |
wind_Wind Angle Type |
choice | Absolute |
Specify whether the angle used to compute the wind pressure coefficient is absolute or relative Specify Relative to compute the angle between the wind direction and the surface azimuth Specify Absolute to use the wind direction angle directly One of Absolute, Relative |
Referenced by 1 object types
AirflowNetwork:MultiZone:ReferenceCrackConditions¶
from idfpy.models import AirflowNetworkMultiZoneReferenceCrackConditions
This object specifies the conditions under which the air mass flow coefficient was measured.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | Enter a unique name for this object. | |
reference_Reference Temperature required |
number C |
Enter the reference temperature under which the surface crack data were obtained. Suggested value 20C. | |
reference_Reference Barometric Pressure |
number Pa |
101325.0 |
Enter the reference barometric pressure under which the surface crack data were obtained. Range: ≥ 31000, ≤ 120000 |
reference_Reference Humidity Ratio |
number kgWater/kgDryAir |
0.0 |
Enter the reference humidity ratio under which the surface crack data were obtained. |
Referenced by 4 object types
AirflowNetwork:Distribution:Component:OutdoorAirFlow, AirflowNetwork:Distribution:Component:ReliefAirFlow, AirflowNetwork:MultiZone:Component:ZoneExhaustFan, AirflowNetwork:MultiZone:Surface:Crack
AirflowNetwork:MultiZone:SpecifiedFlowRate¶
from idfpy.models import AirflowNetworkMultiZoneSpecifiedFlowRate
This object is used to define specified flow through a linkage.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | Enter a unique name for this object. | |
air_Air Flow Value required |
number | Enter the specified flow rate. | |
air_Air Flow Units |
choice | MassFlow |
Enter the units of the air flow value. VolumetricFlow (m3/s) MassFlow (kg/s) One of MassFlow, VolumetricFlow |
Referenced by 1 object types
AirflowNetwork:MultiZone:Surface¶
from idfpy.models import AirflowNetworkMultiZoneSurface
This object specifies the properties of a surface linkage through which air flows. Airflow Report: Node 1 as an inside face zone; Node 2 as an outside face zone or external node.
| Field | Type | Default | Details |
|---|---|---|---|
surface_Surface Name required |
reference | Enter the name of a heat transfer surface. Names a BuildingSurface:Detailed, Ceiling:Adiabatic, Ceiling:Interzone, Door, Door:Interzone, FenestrationSurface:Detailed, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone, GlazedDoor, GlazedDoor:Interzone and 9 more |
|
leakage_Leakage Component Name required |
reference | Enter the name of an Airflow Network leakage component. A leakage component is one of the following AirflowNetwork:Multizone objects: AirflowNetwork:MultiZone:Component:DetailedOpening, AirflowNetwork:MultiZone:Component:SimpleOpening, AirflowNetwork:MultiZone:Surface:Crack, AirflowNetwork:MultiZone:Surface:EffectiveLeakageArea, AirflowNetwork:MultiZone:Component:HorizontalOpening, or AirflowNetwork:MultiZone:Component:ZoneExhaustFan. When the zone exhaust fan name is entered, any surface control fields below A3 are ignored when the zone exhaust fan turns on. Names a AirflowNetwork:MultiZone:Component:DetailedOpening, AirflowNetwork:MultiZone:Component:HorizontalOpening, AirflowNetwork:MultiZone:Component:SimpleOpening, AirflowNetwork:MultiZone:Component:ZoneExhaustFan, AirflowNetwork:MultiZone:SpecifiedFlowRate, AirflowNetwork:MultiZone:Surface:Crack, AirflowNetwork:MultiZone:Surface:EffectiveLeakageArea |
|
external_External Node Name |
reference | Used if Wind Pressure Coefficient Type = Input in the AirflowNetwork:SimulationControl object, otherwise this field may be left blank. Names a AirflowNetwork:MultiZone:ExternalNode, OutdoorAir:Node |
|
window_Window/Door Opening Factor, or Crack Factor |
number dimensionless |
1.0 |
This field specifies a multiplier for a crack, window, or door. Range: > 0, ≤ 1 |
ventilation_Ventilation Control Mode |
choice | ZoneLevel |
When Ventilation Control Mode = Temperature or Enthalpy, the following fields are used to modulate the Ventilation Open Factor for a window or door opening according to the parent zone's indoor-outdoor temperature or enthalpy difference. When Ventilation Control Mode = AdjacentTemperature or AdjacentEnthalpy, the following fields are used to modulate the Ventilation Open Factor for an interior window or door opening according to temperature or enthalpy difference between the parent zone and the adjacent zone. Constant: controlled by field Venting Schedule Name. NoVent: control will not open window or door during simulation (Ventilation Open Factor = 0). ZoneLevel: control will be controlled by AirflowNetwork:MultiZone:Zone Mode. One of ASHRAE55Adaptive, AdjacentEnthalpy, AdjacentTemperature, CEN15251Adaptive, Constant, Enthalpy, NoVent, Temperature, ZoneLevel |
ventilation_Ventilation Control Zone Temperature Setpoint Schedule Name |
reference | Used only if Ventilation Control Mode = Temperature or Enthalpy. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
minimum_Minimum Venting Open Factor |
number dimensionless |
0.0 |
Used only if Ventilation Control Mode = Temperature or Enthalpy. Range: ≥ 0, ≤ 1 |
indoor_Indoor and Outdoor Temperature Difference Lower Limit For Maximum Venting Open Factor |
number deltaC |
0.0 |
Applicable only if Ventilation Control Mode = Temperature Range: ≥ 0, < 100 |
indoor_Indoor and Outdoor Temperature Difference Upper Limit for Minimum Venting Open Factor |
number deltaC |
100.0 |
Applicable only if Ventilation Control Mode = Temperature. This value must be greater than the corresponding lower value (previous field). Range: > 0 |
indoor_Indoor and Outdoor Enthalpy Difference Lower Limit For Maximum Venting Open Factor |
number deltaJ/kg |
0.0 |
Applicable only if Ventilation Control Mode = Enthalpy. This value must be less than the corresponding upper value (next field). Range: ≥ 0, < 300000 |
indoor_Indoor and Outdoor Enthalpy Difference Upper Limit for Minimum Venting Open Factor |
number deltaJ/kg |
300000.0 |
Applicable only if Ventilation Control Mode = Enthalpy. This value must be greater than the corresponding lower value (previous field). Range: > 0 |
venting_Venting Availability Schedule Name |
reference | Non-zero schedule value means venting is allowed if other venting control conditions are satisfied. A zero (or negative) schedule value means venting is not allowed under any circumstances. The schedule values should be greater than or equal to 0 and less than or equal to 1. If this schedule is not specified then venting is allowed if other venting control conditions are satisfied. Not used if Ventilation Control Mode = NoVent or ZoneLevel. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
occupant_Occupant Ventilation Control Name |
reference | Enter the name where Occupancy Ventilation Control is required. Names a AirflowNetwork:OccupantVentilationControl |
|
equivalent_Equivalent Rectangle Method |
choice | PolygonHeight |
This field is applied to a non-rectangular window or door. The equivalent shape has the same area as a polygonal window or door. One of BaseSurfaceAspectRatio, PolygonHeight, UserDefinedAspectRatio |
equivalent_Equivalent Rectangle Aspect Ratio |
number dimensionless |
1.0 |
This field is used when UserDefinedAspectRatio is entered in the Equivalent Rectangle Method field. Range: > 0 |
AirflowNetwork:MultiZone:Surface:Crack¶
from idfpy.models import AirflowNetworkMultiZoneSurfaceCrack
This object specifies the properties of airflow through a crack.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | Enter a unique name for this object. | |
air_Air Mass Flow Coefficient at Reference Conditions required |
number kg/s |
Enter the air mass flow coefficient at the conditions defined in the Reference Crack Conditions object. Defined at 1 Pa pressure difference across this crack. Range: > 0 |
|
air_Air Mass Flow Exponent |
number dimensionless |
0.65 |
Enter the air mass flow exponent for the surface crack. Range: ≥ 0.5, ≤ 1 |
reference_Reference Crack Conditions |
reference | Select a AirflowNetwork:MultiZone:ReferenceCrackConditions name associated with the air mass flow coefficient entered above. Names a AirflowNetwork:MultiZone:ReferenceCrackConditions |
Referenced by 1 object types
AirflowNetwork:MultiZone:Surface:EffectiveLeakageArea¶
from idfpy.models import AirflowNetworkMultiZoneSurfaceEffectiveLeakageArea
This object is used to define surface air leakage.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | Enter a unique name for this object. | |
effective_Effective Leakage Area required |
number m2 |
Enter the effective leakage area. Range: > 0 |
|
discharge_Discharge Coefficient |
number dimensionless |
1.0 |
Enter the coefficient used in the air mass flow equation. Range: > 0 |
reference_Reference Pressure Difference |
number Pa |
4.0 |
Enter the pressure difference used to define the air mass flow coefficient and exponent. Range: > 0 |
air_Air Mass Flow Exponent |
number dimensionless |
0.65 |
Enter the exponent used in the air mass flow equation. Range: ≥ 0.5, ≤ 1 |
Referenced by 1 object types
AirflowNetwork:MultiZone:WindPressureCoefficientArray¶
from idfpy.models import AirflowNetworkMultiZoneWindPressureCoefficientArray
Used only if Wind Pressure Coefficient (WPC) Type = Input in the AirflowNetwork:SimulationControl object. Number of WPC Values in the corresponding AirflowNetwork:MultiZone:WindPressureCoefficientValues object must be the same as the number of wind directions specified for this AirflowNetwork:MultiZone:WindPressureCoefficientArray object.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | Enter a unique name for the object. | |
wind_Wind Direction 1 required |
number deg |
Enter the wind direction corresponding to the 1st WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 2 required |
number deg |
Enter the wind direction corresponding to the 2nd WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 3 |
number deg |
Enter the wind direction corresponding to the 3rd WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 4 |
number deg |
Enter the wind direction corresponding to the 4th WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 5 |
number deg |
Enter the wind direction corresponding to the 5th WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 6 |
number deg |
Enter the wind direction corresponding to the 6th WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 7 |
number deg |
Enter the wind direction corresponding to the 7th WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 8 |
number deg |
Enter the wind direction corresponding to the 8th WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 9 |
number deg |
Enter the wind direction corresponding to the 9th WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 10 |
number deg |
Enter the wind direction corresponding to the 10th WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 11 |
number deg |
Enter the wind direction corresponding to the 11th WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 12 |
number deg |
Enter the wind direction corresponding to the 12th WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 13 |
number deg |
Enter the wind direction corresponding to the 13th WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 14 |
number deg |
Enter the wind direction corresponding to the 14th WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 15 |
number deg |
Enter the wind direction corresponding to the 15th WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 16 |
number deg |
Enter the wind direction corresponding to the 16th WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 17 |
number deg |
Enter the wind direction corresponding to the 17th WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 18 |
number deg |
Enter the wind direction corresponding to the 18th WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 19 |
number deg |
Enter the wind direction corresponding to the 19th WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 20 |
number deg |
Enter the wind direction corresponding to the 20th WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 21 |
number deg |
Enter the wind direction corresponding to the 21st WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 22 |
number deg |
Enter the wind direction corresponding to the 22nd WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 23 |
number deg |
Enter the wind direction corresponding to the 23rd WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 24 |
number deg |
Enter the wind direction corresponding to the 24th WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 25 |
number deg |
Enter the wind direction corresponding to the 25th WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 26 |
number deg |
Enter the wind direction corresponding to the 26th WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 27 |
number deg |
Enter the wind direction corresponding to the 27th WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 28 |
number deg |
Enter the wind direction corresponding to the 28th WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 29 |
number deg |
Enter the wind direction corresponding to the 29th WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 30 |
number deg |
Enter the wind direction corresponding to the 30th WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 31 |
number deg |
Enter the wind direction corresponding to the 31st WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 32 |
number deg |
Enter the wind direction corresponding to the 32nd WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 33 |
number deg |
Enter the wind direction corresponding to the 33rd WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 34 |
number deg |
Enter the wind direction corresponding to the 34th WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 35 |
number deg |
Enter the wind direction corresponding to the 35th WPC Array value. Range: ≥ 0, ≤ 360 |
|
wind_Wind Direction 36 |
number deg |
Enter the wind direction corresponding to the 36th WPC Array value. Range: ≥ 0, ≤ 360 |
Referenced by 1 object types
AirflowNetwork:MultiZone:WindPressureCoefficientValues¶
from idfpy.models import AirflowNetworkMultiZoneWindPressureCoefficientValues
Used only if Wind Pressure Coefficient (WPC) Type = INPUT in the AirflowNetwork:SimulationControl object. The number of WPC numeric inputs must correspond to the number of wind direction inputs in the AirflowNetwork:Multizone:WindPressureCoefficientArray object.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | Enter a unique name for this object. | |
airflownetwork_AirflowNetwork:MultiZone:WindPressureCoefficientArray Name required |
reference | Enter the name of the AirflowNetwork:Multizone:WindPressureCoefficientArray object. Names a AirflowNetwork:MultiZone:WindPressureCoefficientArray |
|
wind_Wind Pressure Coefficient Value 1 required |
number dimensionless |
Enter the WPC Value corresponding to the 1st wind direction. | |
wind_Wind Pressure Coefficient Value 2 required |
number dimensionless |
Enter the WPC Value corresponding to the 2nd wind direction. | |
wind_Wind Pressure Coefficient Value 3 |
number dimensionless |
Enter the WPC Value corresponding to the 3rd wind direction. | |
wind_Wind Pressure Coefficient Value 4 |
number dimensionless |
Enter the WPC Value corresponding to the 4th wind direction. | |
wind_Wind Pressure Coefficient Value 5 |
number dimensionless |
Enter the WPC Value corresponding to the 5th wind direction. | |
wind_Wind Pressure Coefficient Value 6 |
number dimensionless |
Enter the WPC Value corresponding to the 6th wind direction. | |
wind_Wind Pressure Coefficient Value 7 |
number dimensionless |
Enter the WPC Value corresponding to the 7th wind direction. | |
wind_Wind Pressure Coefficient Value 8 |
number dimensionless |
Enter the WPC Value corresponding to the 8th wind direction. | |
wind_Wind Pressure Coefficient Value 9 |
number dimensionless |
Enter the WPC Value corresponding to the 9th wind direction. | |
wind_Wind Pressure Coefficient Value 10 |
number dimensionless |
Enter the WPC Value corresponding to the 10th wind direction. | |
wind_Wind Pressure Coefficient Value 11 |
number dimensionless |
Enter the WPC Value corresponding to the 11th wind direction. | |
wind_Wind Pressure Coefficient Value 12 |
number dimensionless |
Enter the WPC Value corresponding to the 12th wind direction. | |
wind_Wind Pressure Coefficient Value 13 |
number dimensionless |
Enter the WPC Value corresponding to the 13th wind direction. | |
wind_Wind Pressure Coefficient Value 14 |
number dimensionless |
Enter the WPC Value corresponding to the 14th wind direction. | |
wind_Wind Pressure Coefficient Value 15 |
number dimensionless |
Enter the WPC Value corresponding to the 15th wind direction. | |
wind_Wind Pressure Coefficient Value 16 |
number dimensionless |
Enter the WPC Value corresponding to the 16th wind direction. | |
wind_Wind Pressure Coefficient Value 17 |
number dimensionless |
Enter the WPC Value corresponding to the 17th wind direction. | |
wind_Wind Pressure Coefficient Value 18 |
number dimensionless |
Enter the WPC Value corresponding to the 18th wind direction. | |
wind_Wind Pressure Coefficient Value 19 |
number dimensionless |
Enter the WPC Value corresponding to the 19th wind direction. | |
wind_Wind Pressure Coefficient Value 20 |
number dimensionless |
Enter the WPC Value corresponding to the 20th wind direction. | |
wind_Wind Pressure Coefficient Value 21 |
number dimensionless |
Enter the WPC Value corresponding to the 21st wind direction. | |
wind_Wind Pressure Coefficient Value 22 |
number dimensionless |
Enter the WPC Value corresponding to the 22nd wind direction. | |
wind_Wind Pressure Coefficient Value 23 |
number dimensionless |
Enter the WPC Value corresponding to the 23rd wind direction. | |
wind_Wind Pressure Coefficient Value 24 |
number dimensionless |
Enter the WPC Value corresponding to the 24th wind direction. | |
wind_Wind Pressure Coefficient Value 25 |
number dimensionless |
Enter the WPC Value corresponding to the 25th wind direction. | |
wind_Wind Pressure Coefficient Value 26 |
number dimensionless |
Enter the WPC Value corresponding to the 26th wind direction. | |
wind_Wind Pressure Coefficient Value 27 |
number dimensionless |
Enter the WPC Value corresponding to the 27th wind direction. | |
wind_Wind Pressure Coefficient Value 28 |
number dimensionless |
Enter the WPC Value corresponding to the 28th wind direction. | |
wind_Wind Pressure Coefficient Value 29 |
number dimensionless |
Enter the WPC Value corresponding to the 29th wind direction. | |
wind_Wind Pressure Coefficient Value 30 |
number dimensionless |
Enter the WPC Value corresponding to the 30th wind direction. | |
wind_Wind Pressure Coefficient Value 31 |
number dimensionless |
Enter the WPC Value corresponding to the 31st wind direction. | |
wind_Wind Pressure Coefficient Value 32 |
number dimensionless |
Enter the WPC Value corresponding to the 32nd wind direction. | |
wind_Wind Pressure Coefficient Value 33 |
number dimensionless |
Enter the WPC Value corresponding to the 33rd wind direction. | |
wind_Wind Pressure Coefficient Value 34 |
number dimensionless |
Enter the WPC Value corresponding to the 34th wind direction. | |
wind_Wind Pressure Coefficient Value 35 |
number dimensionless |
Enter the WPC Value corresponding to the 35th wind direction. | |
wind_Wind Pressure Coefficient Value 36 |
number dimensionless |
Enter the WPC Value corresponding to the 36th wind direction. |
Referenced by 2 object types
AirflowNetwork:MultiZone:Zone¶
from idfpy.models import AirflowNetworkMultiZoneZone
This object is used to simultaneously control a thermal zone's window and door openings, both exterior and interior.
| Field | Type | Default | Details |
|---|---|---|---|
zone_Zone Name required |
reference | Enter the zone name where ventilation control is required. Names a Zone |
|
ventilation_Ventilation Control Mode |
choice | NoVent |
When Ventilation Control Mode = Temperature or Enthalpy, the following fields are used to modulate the Ventilation Open Factor for all window and door openings in the zone according to the zone's indoor-outdoor temperature or enthalpy difference. Constant: controlled by field Venting Schedule Name. NoVent: control will not open window or door during simulation (Ventilation Open Factor = 0). One of ASHRAE55Adaptive, CEN15251Adaptive, Constant, Enthalpy, NoVent, Temperature |
ventilation_Ventilation Control Zone Temperature Setpoint Schedule Name |
reference | Used only if Ventilation Control Mode = Temperature or Enthalpy. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
minimum_Minimum Venting Open Factor |
number dimensionless |
0.0 |
Used only if Ventilation Control Mode = Temperature or Enthalpy. Range: ≥ 0, ≤ 1 |
indoor_Indoor and Outdoor Temperature Difference Lower Limit For Maximum Venting Open Factor |
number deltaC |
0.0 |
Applicable only if Ventilation Control Mode = Temperature. This value must be less than the corresponding upper value (next field). Range: ≥ 0, < 100 |
indoor_Indoor and Outdoor Temperature Difference Upper Limit for Minimum Venting Open Factor |
number deltaC |
100.0 |
Applicable only if Ventilation Control Mode = Temperature. This value must be greater than the corresponding lower value (previous field). Range: > 0 |
indoor_Indoor and Outdoor Enthalpy Difference Lower Limit For Maximum Venting Open Factor |
number deltaJ/kg |
0.0 |
Applicable only if Ventilation Control Mode = Enthalpy. This value must be less than the corresponding upper value (next field). Range: ≥ 0, < 300000 |
indoor_Indoor and Outdoor Enthalpy Difference Upper Limit for Minimum Venting Open Factor |
number deltaJ/kg |
300000.0 |
Applicable only if Ventilation Control Mode = Enthalpy. This value must be greater than the corresponding lower value (previous field). Range: > 0 |
venting_Venting Availability Schedule Name |
reference | Non-zero Schedule value means venting is allowed if other venting control conditions are satisfied. A zero (or negative) Schedule value means venting is not allowed under any The Schedule values should be greater than or equal to 0 and less than or equal to 1. circumstances. If this Schedule is not specified then venting is allowed if other venting control conditions are satisfied. Not used if Ventilation Control Mode = NoVent. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
single_Single Sided Wind Pressure Coefficient Algorithm |
choice | Standard |
Selecting Advanced results in EnergyPlus calculating modified Wind Pressure Coefficients to account for wind direction and turbulence effects on single sided ventilation rates. Model is only valid for zones with 2 openings, both of which are on a single facade. One of Advanced, Standard |
facade_Facade Width |
number m |
10.0 |
This is the whole building width along the direction of the facade of this zone. Range: ≥ 0 |
occupant_Occupant Ventilation Control Name |
reference | Enter the name where Occupancy Ventilation Control is required. Names a AirflowNetwork:OccupantVentilationControl |
Referenced by 1 object types
AirflowNetwork:OccupantVentilationControl¶
from idfpy.models import AirflowNetworkOccupantVentilationControl
This object is used to provide advanced thermal comfort control of window opening and closing for both exterior and interior windows.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | Enter the name where the advanced thermal comfort control is required. | |
minimum_Minimum Opening Time |
number minutes |
0.0 |
Range: ≥ 0 |
minimum_Minimum Closing Time |
number minutes |
0.0 |
Range: ≥ 0 |
thermal_Thermal Comfort Low Temperature Curve Name |
reference | Enter a curve name that represents thermal comfort temperature as a function of outdoor dry-bulb temperature. Up to two curves are allowed if the performance cannot be represented by a single curve. The following two fields are used if two curves are required. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
thermal_Thermal Comfort Temperature Boundary Point |
number C |
10.0 |
This point is used to allow separate low and high thermal comfort temperature curves. If a single performance curve is used, leave this field blank. Range: ≥ 0 |
thermal_Thermal Comfort High Temperature Curve Name |
reference | Enter a curve name that represents thermal comfort temperature as a function of outdoor dry-bulb temperature. Up to two curves are allowed if the performance cannot be represented by a single curve. If a single performance curve is used, leave this field blank. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
maximum_Maximum Threshold for Persons Dissatisfied PPD |
number percent |
10.0 |
Range: ≥ 0, ≤ 100 |
occupancy_Occupancy Check |
choice | No |
If Yes, occupancy check will be performed as part of the opening probability check. One of No, Yes |
opening_Opening Probability Schedule Name |
reference | If this field is blank, the opening probability check is bypassed and opening is true. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
closing_Closing Probability Schedule Name |
reference | If this field is blank, the closing probability check is bypassed and closing is true. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
Referenced by 2 object types
AirflowNetwork:MultiZone:Surface, AirflowNetwork:MultiZone:Zone
AirflowNetwork:SimulationControl¶
from idfpy.models import AirflowNetworkSimulationControl unique
This object defines the global parameters used in an Airflow Network simulation.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | Enter a unique name for this object. | |
airflownetwork_AirflowNetwork Control |
choice | NoMultizoneOrDistribution |
NoMultizoneOrDistribution: Only perform Simple calculations (objects ZoneInfiltration:*, ZoneVentilation:*, ZoneMixing, ZoneCrossMixing, ZoneRefrigerationDoorMixing, ZoneAirBalance:OutdoorAir, ZoneEarthtube, ZoneThermalChimney, and ZoneCoolTower:Shower); MultizoneWithoutDistribution: Use AirflowNetwork objects to simulate multizone Airflows driven by wind during simulation time, and objects of ZoneInfiltration:*, ZoneVentilation:*, ZoneMixing, ZoneCrossMixing ZoneRefrigerationDoorMixing, ZoneAirBalance:OutdoorAir, ZoneEarthtube, ZoneThermalChimney, and ZoneCoolTower:Shower are ignored; MultizoneWithDistributionOnlyDuringFanOperation: Perform distribution system calculations during system fan on time and Simple calculations during system Fan off time; MultizoneWithDistribution: Perform distribution system calculations during system fan on time and multizone Airflow driven by wind during system fan off time. One of MultizoneWithDistribution, MultizoneWithDistributionOnlyDuringFanOperation, MultizoneWithoutDistribution, NoMultizoneOrDistribution |
wind_Wind Pressure Coefficient Type |
choice | SurfaceAverageCalculation |
Input: User must enter AirflowNetwork:MultiZone:WindPressureCoefficientArray, AirflowNetwork:MultiZone:ExternalNode, and AirflowNetwork:MultiZone:WindPressureCoefficientValues objects. SurfaceAverageCalculation: used only for rectangular buildings. If SurfaceAverageCalculation is selected, AirflowNetwork:MultiZone:WindPressureCoefficientArray, AirflowNetwork:MultiZone:ExternalNode, and AirflowNetwork:MultiZone:WindPressureCoefficientValues objects are not used. One of Input, SurfaceAverageCalculation |
height_Height Selection for Local Wind Pressure Calculation |
choice | OpeningHeight |
If ExternalNode is selected, the height given in the AirflowNetwork:MultiZone:ExternalNode object will be used. If OpeningHeight is selected, the surface opening height (centroid) will be used to calculate local wind pressure This field is ignored when the choice of the Wind Pressure Coefficient Type field is SurfaceAverageCalculation. One of ExternalNode, OpeningHeight |
building_Building Type |
choice | LowRise |
Used only if Wind Pressure Coefficient Type = SurfaceAverageCalculation, otherwise this field may be left blank. One of HighRise, LowRise |
maximum_Maximum Number of Iterations |
integer dimensionless |
500 |
Determines the maximum number of iterations used to converge on a solution. If this limit is exceeded, the program terminates. Range: > 10, ≤ 30000 |
initialization_Initialization Type |
choice | ZeroNodePressures |
One of LinearInitializationMethod, ZeroNodePressures |
relative_Relative Airflow Convergence Tolerance |
number dimensionless |
0.0001 |
This tolerance is defined as the absolute value of the sum of the mass Flow Rates divided by the sum of the absolute value of the mass Flow Rates. The mass Flow Rates described here refer to the mass Flow Rates at all Nodes in the AirflowNetwork model. The solution converges when both this tolerance and the tolerance in the next field (Absolute Airflow Convergence Tolerance) are satisfied. Range: > 0 |
absolute_Absolute Airflow Convergence Tolerance |
number kg/s |
1e-06 |
This tolerance is defined as the absolute value of the sum of the mass flow rates. The mass flow rates described here refer to the mass flow rates at all nodes in the AirflowNetwork model. The solution converges when both this tolerance and the tolerance in the previous field (Relative Airflow Convergence Tolerance) are satisfied. Range: > 0 |
convergence_Convergence Acceleration Limit |
number dimensionless |
-0.5 |
Used only for AirflowNetwork:SimulationControl Range: ≥ -1, ≤ 1 |
azimuth_Azimuth Angle of Long Axis of Building |
number deg |
0.0 |
Degrees clockwise from true North. Used only if Wind Pressure Coefficient Type = SurfaceAverageCalculation. Range: ≥ 0, ≤ 180 |
ratio_Ratio of Building Width Along Short Axis to Width Along Long Axis |
number | 1.0 |
Used only if Wind Pressure Coefficient Type = SurfaceAverageCalculation. Range: > 0, ≤ 1 |
height_Height Dependence of External Node Temperature |
choice | No |
If Yes, external node temperature is height dependent. If No, external node temperature is based on zero height. One of No, Yes |
solverSolver |
choice | SkylineLU |
Select the solver to use for the pressure network solution One of ConjugateGradient, SkylineLU |
allow_Allow Unsupported Zone Equipment |
choice | No |
Set this input to Yes to have zone equipment that are currently unsupported in the AirflowNetwork model allowed in the simulation if present. Setting this field to Yes, allows the following equipment to be modeled along an AirflowNetwork model: ZoneHVAC:Dehumidifier, ZoneHVAC:EnergyRecoveryVentilator, WaterHeater:HeatPump:*. One of No, Yes |
do_Do Distribution Duct Sizing Calculation |
choice | No |
Controls duct sizing. See AirflowNetwork:Distribution:DuctSizing for sizing options. One of No, Yes |
AirflowNetwork:ZoneControl:PressureController¶
from idfpy.models import AirflowNetworkZoneControlPressureController unique
This object is used to control a zone to a specified indoor pressure using the AirflowNetwork model. The specified pressure setpoint is used to control the zone exhaust fan flow rate in a controlled zone or the relief air flow rate in an air loop.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
control_Control Zone Name required |
reference | Names a Zone | |
control_Control Object Type required |
choice | The current selection is AirflowNetwork:MultiZone:Component:ZoneExhaustFan or AirflowNetwork:Distribution:Component:ReliefAirFlow. One of AirflowNetwork:Distribution:Component:ReliefAirFlow, AirflowNetwork:MultiZone:Component:ZoneExhaustFan |
|
control_Control Object Name required |
reference | Control names are names of individual control objects Names a AirflowNetwork:Distribution:Component:ReliefAirFlow, Fan:ZoneExhaust |
|
pressure_Pressure Control Availability Schedule Name |
reference | Availability schedule name for pressure controller. Schedule value > 0 means the pressure controller is enabled. If this field is blank, then pressure controller is always enabled. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
pressure_Pressure Setpoint Schedule Name required |
reference | Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
Compliance:Building¶
from idfpy.models import ComplianceBuilding unique
Building level inputs related to compliance to building standards, building codes, and beyond energy code programs.
| Field | Type | Default | Details |
|---|---|---|---|
building_Building Rotation for Appendix G |
number deg |
0.0 |
Additional degrees of rotation to be used with the requirement in ASHRAE Standard 90.1 Appendix G that states that the baseline building should be rotated in four directions. |
CondenserLoop¶
from idfpy.models import CondenserLoop
Defines a central plant condenser loop. CondenserLoop and PlantLoop are nearly identical except some components and operation schemes are applicable to only one loop type or the other.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
fluid_Fluid Type |
choice | Water |
One of UserDefinedFluidType, Water |
user_User Defined Fluid Type |
reference | This field is only required when Fluid Type is UserDefinedFluidType Names a FluidProperties:GlycolConcentration, FluidProperties:Name |
|
condenser_Condenser Equipment Operation Scheme Name required |
reference | Names a CondenserEquipmentOperationSchemes | |
condenser_Condenser Loop Temperature Setpoint Node Name required |
string | ||
maximum_Maximum Loop Temperature required |
number C |
||
minimum_Minimum Loop Temperature required |
number C |
||
maximum_Maximum Loop Flow Rate required |
number or Autosizem3/s |
||
minimum_Minimum Loop Flow Rate |
number m3/s |
0.0 |
|
condenser_Condenser Loop Volume |
number or Autocalculatem3 |
Autocalculate |
|
condenser_Condenser Side Inlet Node Name required |
string | ||
condenser_Condenser Side Outlet Node Name required |
string | ||
condenser_Condenser Side Branch List Name required |
reference | Names a BranchList | |
condenser_Condenser Side Connector List Name required |
reference | Names a ConnectorList | |
demand_Demand Side Inlet Node Name required |
string | ||
demand_Demand Side Outlet Node Name required |
string | ||
condenser_Condenser Demand Side Branch List Name required |
reference | Names a BranchList | |
condenser_Condenser Demand Side Connector List Name required |
reference | Names a ConnectorList | |
load_Load Distribution Scheme |
choice | SequentialLoad |
One of Optimal, SequentialLoad, SequentialUniformPLR, UniformLoad, UniformPLR |
pressure_Pressure Simulation Type |
choice | None |
One of LoopFlowCorrection, None, PumpPowerCorrection |
loop_Loop Circulation Time |
number minutes |
2.0 |
This field is only used to autocalculate the Condenser Loop Volume. Loop Volume = Loop Circulation Time * Maximum Loop Flow Rate Range: ≥ 0 |
Referenced by 1 object types
Controller:MechanicalVentilation¶
from idfpy.models import ControllerMechanicalVentilation extensible
This object is used in conjunction with Controller:OutdoorAir to specify outdoor ventilation air based on outdoor air specified in the DesignSpecification:OutdoorAir object The Controller:OutdoorAir object is associated with a specific air loop, so the outdoor air flow rates specified in Controller:MechanicalVentilation correspond to the zones attached to that specific air loop. Duplicate groups of Zone name, Design Specification Outdoor Air Object Name, and Design Specification Zone Air Distribution Object Name to increase allowable number of entries
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
availability_Availability Schedule Name |
reference | If this field is blank, the controller uses the values from the associated Controller:OutdoorAir. Schedule values greater than 0 indicate mechanical ventilation is enabled Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
demand_Demand Controlled Ventilation |
choice | No |
One of No, Yes |
system_System Outdoor Air Method |
choice | Standard62.1VentilationRateProcedure |
One of IndoorAirQualityProcedure, IndoorAirQualityProcedureCombined, IndoorAirQualityProcedureGenericContaminant, ProportionalControlBasedOnDesignOARate, ProportionalControlBasedOnDesignOccupancy, ProportionalControlBasedOnOccupancySchedule, Standard62.1VentilationRateProcedure, Standard62.1VentilationRateProcedureWithLimit, ZoneSum |
zone_Zone Maximum Outdoor Air Fraction |
number dimensionless |
1.0 |
Range: > 0 |
zone_ |
list | Each item: zone_or_zonelist_name, design_specification_outdoor_air_object_name, design_specification_zone_air_distribution_object_name |
Referenced by 1 object types
Controller:OutdoorAir¶
from idfpy.models import ControllerOutdoorAir
Controller to set the outdoor air flow rate for an air loop. Control options include fixed, proportional, scheduled, economizer, and demand-controlled ventilation.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
relief_Relief Air Outlet Node Name required |
string | ||
return_Return Air Node Name required |
string | ||
mixed_Mixed Air Node Name required |
string | ||
actuator_Actuator Node Name required |
string | Outdoor air inlet node entering the first pre-treat component if any | |
minimum_Minimum Outdoor Air Flow Rate required |
number or Autosizem3/s |
If there is a Mechanical Ventilation Controller (Controller:MechanicalVentilation), note that this value times the Minimum Outdoor Air Schedule is a hard minimum that may override DCV or other advanced OA controls. | |
maximum_Maximum Outdoor Air Flow Rate required |
number or Autosizem3/s |
||
economizer_Economizer Control Type |
choice | NoEconomizer |
One of DifferentialDryBulb, DifferentialDryBulbAndEnthalpy, DifferentialEnthalpy, ElectronicEnthalpy, FixedDewPointAndDryBulb, FixedDryBulb, FixedEnthalpy, NoEconomizer |
economizer_Economizer Control Action Type |
choice | ModulateFlow |
One of MinimumFlowWithBypass, ModulateFlow |
economizer_Economizer Maximum Limit Dry-Bulb Temperature |
number C |
Enter the maximum outdoor dry-bulb temperature limit for FixedDryBulb economizer control type. No input or blank input means this limit is not operative. Limit is applied regardless of economizer control type. | |
economizer_Economizer Maximum Limit Enthalpy |
number J/kg |
Enter the maximum outdoor enthalpy limit for FixedEnthalpy economizer control type. No input or blank input means this limit is not operative Limit is applied regardless of economizer control type. | |
economizer_Economizer Maximum Limit Dewpoint Temperature |
number C |
Enter the maximum outdoor dewpoint temperature limit for FixedDewPointAndDryBulb economizer control type. No input or blank input means this limit is not operative. Limit is applied regardless of economizer control type. | |
electronic_Electronic Enthalpy Limit Curve Name |
reference | Enter the name of a quadratic or cubic curve which defines the maximum outdoor humidity ratio (function of outdoor dry-bulb temperature) for ElectronicEnthalpy economizer control type. No input or blank input means this limit is not operative Limit is applied regardless of economizer control type. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
economizer_Economizer Minimum Limit Dry-Bulb Temperature |
number C |
Enter the minimum outdoor dry-bulb temperature limit for economizer control. No input or blank input means this limit is not operative Limit is applied regardless of economizer control type. | |
lockout_Lockout Type |
choice | NoLockout |
One of LockoutWithCompressor, LockoutWithHeating, NoLockout |
minimum_Minimum Limit Type |
choice | ProportionalMinimum |
One of FixedMinimum, ProportionalMinimum |
minimum_Minimum Outdoor Air Schedule Name |
reference | Schedule values multiply the minimum outdoor air flow rate Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
minimum_Minimum Fraction of Outdoor Air Schedule Name |
reference | schedule values multiply the design/mixed air flow rate Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
maximum_Maximum Fraction of Outdoor Air Schedule Name |
reference | schedule values multiply the design/mixed air flow rate Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
mechanical_Mechanical Ventilation Controller Name |
reference | Enter the name of a Controller:MechanicalVentilation object. Optional field for defining outdoor ventilation air based on flow rate per unit floor area and flow rate per person. Simplified method of demand-controlled ventilation. Names a Controller:MechanicalVentilation |
|
time_Time of Day Economizer Control Schedule Name |
reference | Optional schedule to simulate "push-button" type economizer control. Schedule values greater than 0 indicate time-of-day economizer control is enabled. Economizer control may be used with or without the high humidity control option. When used together, high humidity control has priority over economizer control. If the field Economizer Control Type = NoEconomizer, then this option is disabled. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
high_High Humidity Control |
choice | No |
Optional field to enable modified outdoor air flow rates based on zone relative humidity. Select Yes to modify outdoor air flow rate based on a zone humidistat. Select No to disable this feature. If the field Economizer Control Type = NoEconomizer, then this option is disabled. One of No, Yes |
humidistat_Humidistat Control Zone Name |
reference | Enter the name of the zone where the humidistat is located. This field is only used when the field High Humidity Control = Yes. Names a Zone |
|
high_High Humidity Outdoor Air Flow Ratio |
number | 1.0 |
Enter the ratio of outdoor air to the maximum outdoor air flow rate when modified air flow rates are active based on high indoor humidity. The minimum value must be greater than 0. This field is only used when the field High Humidity Control = Yes. Range: > 0 |
control_Control High Indoor Humidity Based on Outdoor Humidity Ratio |
choice | Yes |
If No is selected, the outdoor air flow rate is modified any time indoor relative humidity is above the humidistat setpoint. If Yes is selected, the outdoor air flow rate is modified any time the indoor relative humidity is above the humidistat setpoint and the outdoor humidity ratio is less than the indoor humidity ratio. This field is only used when the field High Humidity Control = Yes. One of No, Yes |
heat_Heat Recovery Bypass Control Type |
choice | BypassWhenWithinEconomizerLimits |
BypassWhenWithinEconomizerLimits specifies that heat recovery is active only when the economizer is off because conditions are outside the economizer control limits BypassWhenOAFlowGreaterThanMinimum specifies enhanced economizer controls to allow heat recovery when economizer is active (within limits) but the outdoor air flow rate is at the minimum. One of BypassWhenOAFlowGreaterThanMinimum, BypassWhenWithinEconomizerLimits |
economizer_Economizer Operation Staging |
choice | InterlockedWithMechanicalCooling |
This input is only used when the Controller:OutdoorAir is used in conjunction with an AirLoopHVAC:UnitarySystem with multiple cooling speeds. When modeling an AirLoopHVAC:UnitarySystem with multiple cooling speeds (as specified in a UnitarySystemPerformance:Multispeed), EconomizerFirst runs the economizer at all speeds, all the way to the highest cooling speed before mechanical cooling is used to meet the load. InterlockedWithMechanicalCooling runs the economizer at the cooling speed chosen by the AirLoopHVAC:UnitarySystem. Use EconomizerFirst to model typical economizer staging for multi-speed packaged single-zone equipment with sensible load control (Control Type input of the AirLoopHVAC:UnitarySystem should be set to Load). One of EconomizerFirst, InterlockedWithMechanicalCooling |
Referenced by 7 object types
AirLoopHVAC:ControllerList, DemandManager:Ventilation, FaultModel:EnthalpySensorOffset:OutdoorAir, FaultModel:EnthalpySensorOffset:ReturnAir, FaultModel:HumiditySensorOffset:OutdoorAir, FaultModel:TemperatureSensorOffset:OutdoorAir, FaultModel:TemperatureSensorOffset:ReturnAir
Controller:WaterCoil¶
from idfpy.models import ControllerWaterCoil
Controller for a water coil which is located directly in an air loop branch or outdoor air equipment list. Controls the coil water flow to meet the specified leaving air setpoint(s). Used with Coil:Heating:Water, Coil:Cooling:Water, Coil:Cooling:Water:DetailedGeometry, and CoilSystem:Cooling:Water:HeatexchangerAssisted.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
control_Control Variable required |
choice | keys HumidityRatio or TemperatureAndHumidityRatio requires a ZoneControl:Humidistat object along with SetpointManager:SingleZone:Humidity:Maximum, SetpointManager:MultiZone:MaximumHumidity:Average, or SetpointManager:Multizone:Humidity:Maximum object One of HumidityRatio, Temperature, TemperatureAndHumidityRatio |
|
actionAction |
choice | Leave blank to have this automatically selected from coil type. Chilled water coils should be reverse action Hot water coils should be normal action One of Normal, Reverse |
|
actuator_Actuator Variable required |
choice | One of Flow |
|
sensor_Sensor Node Name required |
string | ||
actuator_Actuator Node Name required |
string | ||
controller_Controller Convergence Tolerance |
number or AutosizedeltaC |
Autosize |
|
maximum_Maximum Actuated Flow |
number or Autosizem3/s |
Autosize |
|
minimum_Minimum Actuated Flow |
number m3/s |
0.0 |
Range: ≥ 0 |
Referenced by 2 object types
AirLoopHVAC:ControllerList, FaultModel:TemperatureSensorOffset:CoilSupplyAir
Dehumidifier:Desiccant:NoFans¶
from idfpy.models import DehumidifierDesiccantNoFans
This object models a solid desiccant dehumidifier. The process air stream is the air which is dehumidified. The regeneration air stream is the air which is heated to regenerate the desiccant. This object determines the process air outlet conditions, the load on the regeneration heating coil, the electric power consumption for the wheel rotor motor, and the regeneration air fan mass flow rate. All other heat exchangers are modeled as separate objects connected to the inlet and outlet nodes of the dehumidifier. The solid desiccant dehumidifier is typically used in an AirLoopHVAC:OutdoorAirSystem, but can also be specified in any AirLoopHVAC.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
availability_Availability Schedule Name |
reference | Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
process_Process Air Inlet Node Name |
string | This is the node entering the process side of the desiccant wheel. | |
process_Process Air Outlet Node Name |
string | This is the node leaving the process side of the desiccant wheel. | |
regeneration_Regeneration Air Inlet Node Name |
string | This is the node entering the regeneration side of the desiccant wheel after the regeneration coil. | |
regeneration_Regeneration Fan Inlet Node Name |
string | Node for air entering the regeneration fan, mass flow is set by the desiccant dehumidifier module. | |
control_Control Type |
choice | Type of setpoint control: LeavingMaximumHumidityRatioSetpoint means that the unit is controlled to deliver air at the Leaving Max Humidity Ratio Setpoint (see below), SystemNodeMaximumHumidityRatioSetpoint means that the leaving humidity ratio setpoint is the System Node Humidity Ratio Max property of the Process Air Outlet Node. A Setpoint object must be used to control this setpoint. Both control types use bypass dampers to prevent over drying. One of LeavingMaximumHumidityRatioSetpoint, SystemNodeMaximumHumidityRatioSetpoint |
|
leaving_Leaving Maximum Humidity Ratio Setpoint |
number kgWater/kgDryAir |
Fixed setpoint for maximum process air leaving humidity ratio Applicable only when Control Type = LeavingMaximumHumidityRatioSetpoint. | |
nominal_Nominal Process Air Flow Rate |
number m3/s |
Process air flow rate at nominal conditions Range: > 0 |
|
nominal_Nominal Process Air Velocity |
number m/s |
Process air velocity at nominal flow When using Performance Model Type of Default, must be 2.032 to 4.064 m/s (400 to 800 fpm) Range: > 0, ≤ 6 |
|
rotor_Rotor Power |
number W |
Power input to wheel rotor motor Range: ≥ 0 |
|
regeneration_Regeneration Coil Object Type |
choice | heating coil type works with gas, electric, hot water and steam heating coils One of Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water |
|
regeneration_Regeneration Coil Name |
reference | Name of heating coil object for regeneration air Names a Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water |
|
regeneration_Regeneration Fan Object Type |
choice | Type of fan object for regeneration air. When using the Default Performance Model Type (see below), only Fan:VariableVolume or Fan:SystemModel are valid. One of Fan:ConstantVolume, Fan:SystemModel, Fan:VariableVolume |
|
regeneration_Regeneration Fan Name |
reference | Name of fan object for regeneration air Names a Fan:ConstantVolume, Fan:SystemModel, Fan:VariableVolume |
|
performance_Performance Model Type |
choice | Specifies whether the default performance model or user-specified curves should be used to model the performance. The default model is a generic solid desiccant wheel using performance curves of the form: curve = C1 + C2*edb + C3*edb**2 + C4*ew + C5*ew**2 + C6*vel + C7*vel**2 + C8*edb*ew + C9*edb**2*ew**2 + C10*edb*vel + C11*edb**2*vel**2 + C12*ew*vel + C13*ew**2*vel**2 + C14*ALOG(edb) + C15*ALOG(ew) + C16*ALOG(vel) edb = process entering dry-bulb temperature [C] ew = process entering humidity ratio [kgWater/kgDryAir] vel = process air velocity [m/s] If UserCurves are specified, then performance is calculated as follows: Leaving Dry-Bulb = (Leaving Dry-Bulb fTW Curve) * (Leaving Dry-Bulb fV Curve) Leaving Humidity Ratio = (Leaving Humidity Ratio fTW Curve) * (Leaving Humidity Ratio fV Curve) Regen Energy = (Regen Energy fTW Curve) * (Regen Energy fV Curve) Regen Velocity = (Regen Velocity fTW Curve) * (Regen Velocity fV Curve) One of Default, UserCurves |
|
leaving_Leaving Dry-Bulb Function of Entering Dry-Bulb and Humidity Ratio Curve Name |
reference | Leaving dry-bulb of process air as a function of entering dry-bulb and entering humidity ratio, biquadratic curve curve = C1 + C2*edb + C3*edb**2 + C4*ew + C5*ew**2 + C6*edb*ew edb = process entering dry-bulb temperature [C] ew = process entering humidity ratio [kgWater/kgDryAir] Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup |
|
leaving_Leaving Dry-Bulb Function of Air Velocity Curve Name |
reference | Leaving dry-bulb of process air as a function of air velocity, quadratic curve. curve = C1 + C2*v + C3*v**2 v = process air velocity [m/s] Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
leaving_Leaving Humidity Ratio Function of Entering Dry-Bulb and Humidity Ratio Curve Name |
reference | Leaving humidity ratio of process air as a function of entering dry-bulb and entering humidity ratio, biquadratic curve curve = C1 + C2*edb + C3*edb**2 + C4*ew + C5*ew**2 + C6*edb*ew edb = process entering dry-bulb temperature [C] ew = process entering humidity ratio [kgWater/kgDryAir] Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup |
|
leaving_Leaving Humidity Ratio Function of Air Velocity Curve Name |
reference | Leaving humidity ratio of process air as a function of process air velocity, quadratic curve. curve = C1 + C2*v + C3*v**2 v = process air velocity [m/s] Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
regeneration_Regeneration Energy Function of Entering Dry-Bulb and Humidity Ratio Curve Name |
reference | Regeneration energy [J/kg of water removed] as a function of entering dry-bulb and entering humidity ratio, biquadratic curve curve = C1 + C2*edb + C3*edb**2 + C4*ew + C5*ew**2 + C6*edb*ew edb = process entering dry-bulb temperature [C] ew = process entering humidity ratio [kgWater/kgDryAir] Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup |
|
regeneration_Regeneration Energy Function of Air Velocity Curve Name |
reference | Regeneration energy [J/kg of water removed] as a function of process air velocity, quadratic curve. curve = C1 + C2*v + C3*v**2 v = process air velocity [m/s] Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
regeneration_Regeneration Velocity Function of Entering Dry-Bulb and Humidity Ratio Curve Name |
reference | Regeneration velocity [m/s] as a function of entering dry-bulb and entering humidity ratio, biquadratic curve curve = C1 + C2*edb + C3*edb**2 + C4*ew + C5*ew**2 + C6*edb*ew edb = process entering dry-bulb temperature [C] ew = process entering humidity ratio [kgWater/kgDryAir] Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup |
|
regeneration_Regeneration Velocity Function of Air Velocity Curve Name |
reference | Regeneration velocity [m/s] as a function of process air velocity, quadratic curve. curve = C1 + C2*v + C3*v**2 v = process air velocity [m/s] Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
nominal_Nominal Regeneration Temperature |
number C |
Nominal regen temperature upon which the regen energy modifier curve is based. Not used if Default if chosen for the field Performance Mode Type. 121 C is a commonly used value. Range: ≥ 40, ≤ 250 |
Referenced by 3 object types
AirLoopHVAC:DedicatedOutdoorAirSystem, AirLoopHVAC:OutdoorAirSystem:EquipmentList, Branch
Dehumidifier:Desiccant:System¶
from idfpy.models import DehumidifierDesiccantSystem
This compound object models a desiccant heat exchanger, an optional heater, and associated fans. The process air stream is the air which is dehumidified. The regeneration air stream is the air which is heated to regenerate the desiccant. The desiccant heat exchanger transfers both sensible and latent energy between the process and regeneration air streams. The desiccant dehumidifier is typically used in an AirLoopHVAC:OutdoorAirSystem, but can also be specified in any AirLoopHVAC.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
availability_Availability Schedule Name |
reference | Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
desiccant_Desiccant Heat Exchanger Object Type required |
choice | One of HeatExchanger:Desiccant:BalancedFlow |
|
desiccant_Desiccant Heat Exchanger Name required |
reference | Names a HeatExchanger:Desiccant:BalancedFlow | |
sensor_Sensor Node Name required |
string | ||
regeneration_Regeneration Air Fan Object Type required |
choice | One of Fan:ConstantVolume, Fan:OnOff, Fan:SystemModel |
|
regeneration_Regeneration Air Fan Name required |
reference | Names a Fan:OnOff, Fan:SystemModel, Fan:VariableVolume | |
regeneration_Regeneration Air Fan Placement |
choice | DrawThrough |
One of BlowThrough, DrawThrough |
regeneration_Regeneration Air Heater Object Type |
choice | works with gas, electric, hot water and steam heating coils. For autosizing the regeneration air heating coil the Design Coil Inlet Air Condition used is the outdoor air condition if the desiccant system is on the primary air loop, or else if the desiccant system is on outdoor air system then it is the return air condition. The Design Coil Outlet Air Temperature is the Regeneration Inlet Air Setpoint Temperature specified in the input field below. One of Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water |
|
regeneration_Regeneration Air Heater Name |
reference | Names a Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water | |
regeneration_Regeneration Inlet Air Setpoint Temperature |
number C |
46.0 |
This value is also used as regeneration air heater design coil air outlet temperature for autosizing calculation of the heater. |
companion_Companion Cooling Coil Object Type |
choice | One of Coil:Cooling:DX:SingleSpeed, Coil:Cooling:DX:TwoStageWithHumidityControlMode, Coil:Cooling:DX:VariableSpeed |
|
companion_Companion Cooling Coil Name |
reference | Names a Coil:Cooling:DX:SingleSpeed, Coil:Cooling:DX:SingleSpeed:ThermalStorage, Coil:Cooling:DX:TwoStageWithHumidityControlMode, Coil:Cooling:DX:VariableSpeed, CoilSystem:Cooling:DX:HeatExchangerAssisted | |
companion_Companion Cooling Coil Upstream of Dehumidifier Process Inlet |
choice | No |
Select Yes if the companion cooling coil is located directly upstream of the desiccant heat exchanger's process air inlet node. One of No, Yes |
companion_Companion Coil Regeneration Air Heating |
choice | No |
One of No, Yes |
exhaust_Exhaust Fan Maximum Flow Rate |
number m3/s |
||
exhaust_Exhaust Fan Maximum Power |
number W |
||
exhaust_Exhaust Fan Power Curve Name |
reference | Curve object type must be Curve:Quadratic or Curve:Cubic Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
Referenced by 3 object types
AirLoopHVAC:DedicatedOutdoorAirSystem, AirLoopHVAC:OutdoorAirSystem:EquipmentList, Branch
Duct:Loss:Conduction¶
from idfpy.models import DuctLossConduction
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
airloophvac_AirLoopHVAC Name required |
reference | Names a AirLoopHVAC | |
airflownetwork_AirflowNetwork:Distribution:Linkage Name required |
reference | Names a AirflowNetwork:Distribution:Linkage | |
environment_Environment Type |
choice | Zone |
One of Schedule, Zone |
ambient_Ambient Zone Name |
reference | Names a Zone | |
ambient_Ambient Temperature Schedule Name |
reference | Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules | |
ambient_Ambient Humidity Ratio Schedule Name |
reference | Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
Duct:Loss:Leakage¶
from idfpy.models import DuctLossLeakage
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
airloophvac_AirLoopHVAC Name required |
reference | Names a AirLoopHVAC | |
airflownetwork_AirflowNetwork:Distribution:Linkage Name required |
reference | Names a AirflowNetwork:Distribution:Linkage |
Duct:Loss:MakeupAir¶
from idfpy.models import DuctLossMakeupAir
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
airloophvac_AirLoopHVAC Name required |
reference | Names a AirLoopHVAC | |
airflownetwork_AirflowNetwork:Distribution:Linkage Name required |
reference | Names a AirflowNetwork:Distribution:Linkage |
Exterior:FuelEquipment¶
from idfpy.models import ExteriorFuelEquipment
only used for Meter type reporting, does not affect building loads
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
fuel_Fuel Use Type required |
choice | One of Coal, Diesel, DistrictCooling, DistrictHeatingSteam, DistrictHeatingWater, Electricity, FuelOilNo1, FuelOilNo2, Gasoline, NaturalGas, OtherFuel1, OtherFuel2, Propane, Water |
|
schedule_Schedule Name required |
reference | units in schedule should be fraction applied to capacity of the exterior fuel equipment, generally (0.0 - 1.0) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
design_Design Level required |
number W |
Range: ≥ 0 | |
end_End-Use Subcategory |
string | General |
Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table. |
Exterior:Lights¶
from idfpy.models import ExteriorLights
only used for Meter type reporting, does not affect building loads
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
schedule_Schedule Name required |
reference | units in schedule should be fraction applied to capacity of the exterior lights equipment, generally (0.0 - 1.0) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
design_Design Level required |
number W |
Range: ≥ 0 | |
control_Control Option |
choice | Astronomical Clock option overrides schedule to turn lights off when sun is up One of AstronomicalClock, ScheduleNameOnly |
|
end_End-Use Subcategory |
string | General |
Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table. |
Referenced by 1 object types
Exterior:WaterEquipment¶
from idfpy.models import ExteriorWaterEquipment
only used for Meter type reporting, does not affect building loads
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
fuel_Fuel Use Type |
choice | Water |
One of Water |
schedule_Schedule Name required |
reference | units in Schedule should be fraction applied to capacity of the exterior water equipment, generally (0.0 - 1.0) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
design_Design Level required |
number m3/s |
Range: ≥ 0 | |
end_End-Use Subcategory |
string | General |
Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table. |
GroundHeatTransfer:Basement:AutoGrid¶
from idfpy.models import GroundHeatTransferBasementAutoGrid
AutoGrid only necessary when EquivSizing is false If the modeled building is not a rectangle or square, Equivalent sizing MUST be used to get accurate results
| Field | Type | Default | Details |
|---|---|---|---|
clearance_CLEARANCE: Distance from outside of wall to edge, |
number m |
15.0 |
Range: ≥ 0 |
slabx_SLABX: X dimension of the building slab required |
number m |
Range: ≥ 0, ≤ 60 | |
slaby_SLABY: Y dimension of the building slab required |
number m |
Range: ≥ 0, ≤ 60 | |
concagheight_ConcAGHeight: Height of the foundation wall above grade |
number m |
0.0 |
Range: ≥ 0 |
slabdepth_SlabDepth: Thickness of the floor slab |
number m |
0.1 |
|
basedepth_BaseDepth: Depth of the basement wall below grade |
number m |
2.0 |
Range: ≥ 0 |
GroundHeatTransfer:Basement:BldgData¶
from idfpy.models import GroundHeatTransferBasementBldgData
Specifies the surface and gravel thicknesses used for the Basement preprocessor ground heat transfer simulation.
| Field | Type | Default | Details |
|---|---|---|---|
dwall_DWALL: Wall thickness |
number m |
0.2 |
Range: ≥ 0.2 |
dslab_DSLAB: Floor slab thickness |
number m |
0.1 |
Range: > 0, ≤ 0.25 |
dgravxy_DGRAVXY: Width of gravel pit beside basement wall |
number m |
0.3 |
Range: > 0 |
dgravzn_DGRAVZN: Gravel depth extending above the floor slab |
number m |
0.2 |
Range: > 0 |
dgravzp_DGRAVZP: Gravel depth below the floor slab |
number m |
0.1 |
Range: > 0 |
GroundHeatTransfer:Basement:ComBldg¶
from idfpy.models import GroundHeatTransferBasementComBldg
ComBldg contains the monthly average temperatures (C) and possibility of daily variation amplitude
| Field | Type | Default | Details |
|---|---|---|---|
january_January average temperature |
number C |
22.0 |
|
february_February average temperature |
number C |
22.0 |
|
march_March average temperature |
number C |
22.0 |
|
april_April average temperature |
number C |
22.0 |
|
may_May average temperature |
number C |
22.0 |
|
june_June average temperature |
number C |
22.0 |
|
july_July average temperature |
number C |
22.0 |
|
august_August average temperature |
number C |
22.0 |
|
september_September average temperature |
number C |
22.0 |
|
october_October average temperature |
number C |
22.0 |
|
november_November average temperature |
number C |
22.0 |
|
december_December average temperature |
number C |
22.0 |
|
daily_Daily variation sine wave amplitude |
number deltaC |
0.0 |
(Normally zero, just for checking) |
GroundHeatTransfer:Basement:EquivAutoGrid¶
from idfpy.models import GroundHeatTransferBasementEquivAutoGrid
EquivAutoGrid necessary when EquivSizing=TRUE, TRUE is is the normal case.
| Field | Type | Default | Details |
|---|---|---|---|
clearance_CLEARANCE: Distance from outside of wall to edge of 3-D ground domain |
number m |
15.0 |
Range: ≥ 0 |
slabdepth_SlabDepth: Thickness of the floor slab |
number m |
0.1 |
Range: ≥ 0 |
basedepth_BaseDepth: Depth of the basement wall below grade |
number m |
2.0 |
Range: ≥ 0 |
GroundHeatTransfer:Basement:EquivSlab¶
from idfpy.models import GroundHeatTransferBasementEquivSlab
Using an equivalent slab allows non-rectangular shapes to be modeled accurately. The simulation default should be EquivSizing=True
| Field | Type | Default | Details |
|---|---|---|---|
apratio_APRatio: The area to perimeter ratio for this slab required |
number m |
Range: > 0 | |
equivsizing_EquivSizing: Flag required |
choice | Will the dimensions of an equivalent slab be calculated (TRUE) or will the dimensions be input directly? (FALSE)] Only advanced special simulations should use FALSE. One of FALSE, TRUE |
GroundHeatTransfer:Basement:Insulation¶
from idfpy.models import GroundHeatTransferBasementInsulation
Describes the insulation used on an exterior basement wall for the Basement preprocessor ground heat transfer simulation.
| Field | Type | Default | Details |
|---|---|---|---|
rext_REXT: R Value of any exterior insulation |
number m2-K/W |
Range: > 0 | |
insfull_INSFULL: Flag: Is the wall fully insulated? required |
choice | True for full insulation False for insulation half way down side wall from grade line One of FALSE, TRUE |
GroundHeatTransfer:Basement:Interior¶
from idfpy.models import GroundHeatTransferBasementInterior
Provides the information needed to simulate the inside boundary conditions for the Basement preprocessor ground heat transfer simulation.
| Field | Type | Default | Details |
|---|---|---|---|
cond_COND: Flag: Is the basement conditioned? |
choice | TRUE |
for EnergyPlus this should be TRUE One of FALSE, TRUE |
hin_HIN: Downward convection only heat transfer coefficient |
number W/m2-K |
0.92 |
Range: > 0 |
hin_HIN: Upward convection only heat transfer coefficient |
number W/m2-K |
4.04 |
Range: > 0 |
hin_HIN: Horizontal convection only heat transfer coefficient |
number W/m2-K |
3.08 |
Range: > 0 |
hin_HIN: Downward combined (convection and radiation) heat transfer coefficient |
number W/m2-K |
6.13 |
Range: > 0 |
hin_HIN: Upward combined (convection and radiation) heat transfer coefficient |
number W/m2-K |
9.26 |
Range: > 0 |
hin_HIN: Horizontal combined (convection and radiation) heat transfer coefficient |
number W/m2-K |
8.29 |
Range: > 0 |
GroundHeatTransfer:Basement:ManualGrid¶
from idfpy.models import GroundHeatTransferBasementManualGrid
Manual Grid only necessary using manual gridding (not recommended)
| Field | Type | Default | Details |
|---|---|---|---|
nx_NX: Number of cells in the X direction: 20] required |
number | Range: ≥ 1 | |
ny_NY: Number of cells in the Y direction: 20] required |
number | Range: ≥ 1 | |
nzag_NZAG: Number of cells in the Z direction. above grade: 4 Always] required |
number | Range: ≥ 1 | |
nzbg_NZBG: Number of cells in Z direction. below grade: 10-35] required |
number | Range: ≥ 1 | |
ibase_IBASE: X direction cell indicator of slab edge: 5-20] required |
number | ||
jbase_JBASE: Y direction cell indicator of slab edge: 5-20] required |
number | ||
kbase_KBASE: Z direction cell indicator of the top of the floor slab: 5-20] required |
number |
GroundHeatTransfer:Basement:MatlProps¶
from idfpy.models import GroundHeatTransferBasementMatlProps
Specifies the material properties for the Basement preprocessor ground heat transfer simulation. Only the Foundation Wall, Floor Slab, Soil, and Gravel properties are currently used.
| Field | Type | Default | Details |
|---|---|---|---|
nmat_NMAT: Number of materials in this domain required |
number | Range: ≤ 6 | |
density_Density for Foundation Wall |
number kg/m3 |
2243.0 |
Range: > 0 |
density_density for Floor Slab |
number kg/m3 |
2243.0 |
Range: > 0 |
density_density for Ceiling |
number kg/m3 |
311.0 |
Range: > 0 |
density_density for Soil |
number kg/m3 |
1500.0 |
Range: > 0 |
density_density for Gravel |
number kg/m3 |
2000.0 |
Range: > 0 |
density_density for Wood |
number kg/m3 |
449.0 |
Range: > 0 |
specific_Specific heat for foundation wall |
number J/kg-K |
880.0 |
Range: > 0 |
specific_Specific heat for floor slab |
number J/kg-K |
880.0 |
Range: > 0 |
specific_Specific heat for ceiling |
number J/kg-K |
1530.0 |
Range: > 0 |
specific_Specific heat for soil |
number J/kg-K |
840.0 |
Range: > 0 |
specific_Specific heat for gravel |
number J/kg-K |
720.0 |
Range: > 0 |
specific_Specific heat for wood |
number J/kg-K |
1530.0 |
Range: > 0 |
thermal_Thermal conductivity for foundation wall |
number W/m-K |
1.4 |
Range: > 0 |
thermal_Thermal conductivity for floor slab |
number W/m-K |
1.4 |
Range: > 0 |
thermal_Thermal conductivity for ceiling |
number W/m-K |
0.09 |
Range: > 0 |
thermal_thermal conductivity for soil |
number W/m-K |
1.1 |
Range: > 0 |
thermal_thermal conductivity for gravel |
number W/m-K |
1.9 |
Range: > 0 |
thermal_thermal conductivity for wood |
number W/m-K |
0.12 |
Range: > 0 |
GroundHeatTransfer:Basement:SimParameters¶
from idfpy.models import GroundHeatTransferBasementSimParameters
Specifies certain parameters that control the Basement preprocessor ground heat transfer simulation.
| Field | Type | Default | Details |
|---|---|---|---|
f_F: Multiplier for the ADI solution |
number | 0<F<1.0, typically 0.1 (0.3 for high k soil - saturated sand is about 2.6 w/m-K) Range: > 0, ≤ 1 |
|
iyrs_IYRS: Maximum number of yearly iterations: |
number | 15.0 |
typically 15-30] Range: ≥ 0 |
GroundHeatTransfer:Basement:SurfaceProps¶
from idfpy.models import GroundHeatTransferBasementSurfaceProps
Specifies the soil surface properties for the Basement preprocessor ground heat transfer simulation.
| Field | Type | Default | Details |
|---|---|---|---|
albedo_ALBEDO: Surface albedo for No snow conditions |
number | 0.16 |
Range: ≥ 0, ≤ 1 |
albedo_ALBEDO: Surface albedo for snow conditions |
number | 0.4 |
Range: ≥ 0, ≤ 1 |
epsln_EPSLN: Surface emissivity No Snow |
number | 0.94 |
Range: ≥ 0, ≤ 1 |
epsln_EPSLN: Surface emissivity with Snow |
number | 0.86 |
Range: ≥ 0, ≤ 1 |
veght_VEGHT: Surface roughness No snow conditions |
number cm |
6.0 |
Range: ≥ 0 |
veght_VEGHT: Surface roughness Snow conditions |
number cm |
0.25 |
Range: ≥ 0 |
pet_PET: Flag, Potential evapotranspiration on? |
choice | FALSE |
Typically, PET is False One of FALSE, TRUE |
GroundHeatTransfer:Basement:XFACE¶
from idfpy.models import GroundHeatTransferBasementXFACE
This is only needed when using manual gridding (not recommended) XFACE: X Direction cell face coordinates: m
| Field | Type | Default | Details |
|---|---|---|---|
GroundHeatTransfer:Basement:YFACE¶
from idfpy.models import GroundHeatTransferBasementYFACE
This is only needed when using manual gridding (not recommended) YFACE: Y Direction cell face coordinates: m
| Field | Type | Default | Details |
|---|---|---|---|
GroundHeatTransfer:Basement:ZFACE¶
from idfpy.models import GroundHeatTransferBasementZFACE
This is only needed when using manual gridding (not recommended) ZFACE: Z Direction cell face coordinates: m
| Field | Type | Default | Details |
|---|---|---|---|
GroundHeatTransfer:Control¶
from idfpy.models import GroundHeatTransferControl
Object determines if the Slab and Basement preprocessors are going to be executed.
| Field | Type | Default | Details |
|---|---|---|---|
nameName |
string | This field is included for consistency.11 | |
run_Run Basement Preprocessor |
choice | No |
One of No, Yes |
run_Run Slab Preprocessor |
choice | No |
One of No, Yes |
GroundHeatTransfer:Slab:AutoGrid¶
from idfpy.models import GroundHeatTransferSlabAutoGrid
AutoGrid only necessary when EquivalentSlab option not chosen. Not normally needed by EnergyPlus users. This object permits user selection of rectangular slab dimensions. NO SLAB DIMENSIONS LESS THAN 6 m.
| Field | Type | Default | Details |
|---|---|---|---|
slabx_SLABX: X dimension of the building slab required |
number m |
typical values= 6 to 60.0 Range: ≥ 6 |
|
slaby_SLABY: Y dimension of the building slab required |
number m |
typical values= 6 to 60.0 Range: ≥ 6 |
|
slabdepth_SLABDEPTH: Thickness of slab on grade |
number m |
0.1 |
|
clearance_CLEARANCE: Distance from edge of slab to domain edge |
number m |
15.0 |
|
zclearance_ZCLEARANCE: Distance from bottom of slab to domain bottom |
number m |
15.0 |
GroundHeatTransfer:Slab:BldgProps¶
from idfpy.models import GroundHeatTransferSlabBldgProps
Object provides information about the building and its operating conditions Monthly Average Temperature SetPoint fields specify the average indoor building set point temperatures for each month of the year. These fields are useful for simulating a building that is not temperature controlled for some of the year. In such a case, the average indoor set point temperatures can be obtained by first running the model in EnergyPlus with an insulated floor boundary condition, and then using the resulting monthly average zone temperatures in these fields.
| Field | Type | Default | Details |
|---|---|---|---|
iyrs_IYRS: Number of years to iterate |
number | 10.0 |
This field specifies the number of years to iterate. Either the ground heat transfer calculations come to an an annual steady periodic condition by converging to a tolerance (see ConvTol field) or it runs for this number of years. A ten year maximum is usually sufficient. Range: ≥ 1 |
shape_Shape: Slab shape |
number | Use only the value 0 here. Only a rectangular shape is implemented. Range: ≥ 0, ≤ 0 |
|
hbldg_HBLDG: Building height |
number m |
This field supplies the building height. This is used to calculate the building shadowing on the ground. typical value= 0-20 Range: ≥ 0 |
|
tin1_TIN1: January Indoor Average Temperature Setpoint |
number C |
22.0 |
see memo on object for more information |
tin2_TIN2: February Indoor Average Temperature Setpoint |
number C |
22.0 |
see memo on object for more information |
tin3_TIN3: March Indoor Average Temperature Setpoint |
number C |
22.0 |
see memo on object for more information |
tin4_TIN4: April Indoor Average Temperature Setpoint |
number C |
22.0 |
see memo on object for more information |
tin5_TIN5: May Indoor Average Temperature Setpoint |
number C |
22.0 |
see memo on object for more information |
tin6_TIN6: June Indoor Average Temperature Setpoint |
number C |
22.0 |
see memo on object for more information |
tin7_TIN7: July Indoor Average Temperature Setpoint |
number C |
22.0 |
see memo on object for more information |
tin8_TIN8: August Indoor Average Temperature Setpoint |
number C |
22.0 |
see memo on object for more information |
tin9_TIN9: September Indoor Average Temperature Setpoint |
number C |
22.0 |
see memo on object for more information |
tin10_TIN10: October Indoor Average Temperature Setpoint |
number C |
22.0 |
see memo on object for more information |
tin11_TIN11: November Indoor Average Temperature Setpoint |
number C |
22.0 |
see memo on object for more information |
tin12_TIN12: December Indoor Average Temperature Setpoint |
number C |
22.0 |
see memo on object for more information |
tinamp_TINAmp: Daily Indoor sine wave variation amplitude |
number deltaC |
0.0 |
This field permits imposing a daily sinusoidal variation in the indoor setpoint temperature to simulate the effect of a setback profile. The value specified is the amplitude of the sine wave. |
convtol_ConvTol: Convergence Tolerance |
number | 0.1 |
This field specifies the convergence tolerance used to control the iteration. When the temperature change of all nodes is less than the convergence value, iteration ceases. |
GroundHeatTransfer:Slab:BoundConds¶
from idfpy.models import GroundHeatTransferSlabBoundConds
Supplies some of the boundary conditions used in the ground heat transfer calculations.
| Field | Type | Default | Details |
|---|---|---|---|
evtr_EVTR: Is surface evapotranspiration modeled required |
choice | This field specifies whether or not to use the evapotranspiration model. The inclusion of evapotranspiration in the calculation has the greatest effect in warm dry climates, primarily on the ground surface temperature. This field can be used to turn the evapotranspiration off and on to check sensitivity to it. One of FALSE, TRUE |
|
fixbc_FIXBC: is the lower boundary at a fixed temperature required |
choice | This field permits using a fixed temperature at the lower surface of the model instead of a zero heat flux condition. This change normally has a very small effect on the results. FALSE selects the zero flux lower boundary condition One of FALSE, TRUE |
|
tdeepinTDEEPin |
number C |
User input lower boundary temperature if FIXBC is TRUE Blank for FIXBC FALSE or to use the calculated 1-D deep ground temperature. | |
usrhflag_USRHflag: Is the ground surface h specified by the user? required |
choice | This field flags the use of a user specified heat transfer coefficient on the ground surface. This condition is used primarily for testing. For normal runs (USPHflag is FALSE) and the program calculates the heat transfer coefficient using the weather conditions. One of FALSE, TRUE |
|
userh_USERH: User specified ground surface heat transfer coefficient |
number W/m2-K |
Used only if USRHflag is TRUE and the heat transfer coefficient value is specified in this field. |
GroundHeatTransfer:Slab:EquivalentSlab¶
from idfpy.models import GroundHeatTransferSlabEquivalentSlab
Using an equivalent slab allows non-rectangular shapes to be modeled accurately. Object uses the area - perimeter (area/perimeter) ratio to determine the size of an equivalent rectangular slab. EnergyPlus users normally use this option.
| Field | Type | Default | Details |
|---|---|---|---|
apratio_APRatio: The area to perimeter ratio for this slab required |
number m |
Equivalent square slab is simulated, side is 4*APRatio. Range: ≥ 1.5, ≤ 22 |
|
slabdepth_SLABDEPTH: Thickness of slab on grade |
number m |
0.1 |
This field specifies the thickness of the slab. The slab top surface is level with the ground surface, so this is the depth into the ground. The slab depth has a significant effect on the temperature calculation, and it is also important for the auto-grid process. The finite difference grids are set in such a way that they use the slab thickness to determine the vertical grid spacing. Autogridding will fail if the slab thickness is specified larger than 0.25 meters. |
clearance_CLEARANCE: Distance from edge of slab to domain edge |
number m |
15.0 |
This field specifies the distance from the slab to the edge of the area that will be modeled with the grid system. It is the basic size dimension that is used to set the horizontal extent of the domain. 15 meters is a reasonable value. |
zclearance_ZCLEARANCE: Distance from bottom of slab to domain bottom |
number m |
15.0 |
This field specifies the vertical distance from the slab to the bottom edge of the area that will be modeled with the grid system. 15 meters is a reasonable value. |
GroundHeatTransfer:Slab:Insulation¶
from idfpy.models import GroundHeatTransferSlabInsulation
This object supplies the information about insulation used around the slab. There are two possible configurations: under the slab or vertical insulation around the slab.
| Field | Type | Default | Details |
|---|---|---|---|
rins_RINS: R value of under slab insulation |
number m2-K/W |
0.0 |
This field provides the thermal resistance value of the under slab insulation. It should be zero if the vertical insulation configuration is selected. typical value= 0-2.0 |
dins_DINS: Width of strip of under slab insulation |
number m |
0.0 |
This specifies the width of the perimeter strip of insulation under the slab. It should be zero if for the vertical insulation configuration is selected. typical value= 0-2.0 |
rvins_RVINS: R value of vertical insulation |
number m2-K/W |
0.0 |
This field specifies the thermal resistance of the vertical insulation. It should be zero if the under slab insulation configuration is selected. typical value= 0-3.0 |
zvins_ZVINS: Depth of vertical insulation |
number m |
0.0 |
This field specifies the depth of the vertical insulation into the ground in meters. It starts at the slab upper surface and extends into the ground. It should be zero if the under slab insulation configuration is selected. only use values= .2 .4 .6 .8 1.0 1.5 2.0 2.5 3.0 |
ivins_IVINS: Flag: Is there vertical insulation |
0 or 1 |
0.0 |
Specifies if the vertical insulation configuration is being used. values: 1=yes vertical insulation 0=no under-slab insulation |
GroundHeatTransfer:Slab:ManualGrid¶
from idfpy.models import GroundHeatTransferSlabManualGrid
Manual Grid only necessary when using manual gridding (not recommended) Used only in special cases when previous two objects are not used. User must input complete gridding information.
| Field | Type | Default | Details |
|---|---|---|---|
nx_NX: Number of cells in the X direction required |
number | Range: ≥ 1 | |
ny_NY: Number of cells in the Y direction required |
number | Range: ≥ 1 | |
nz_NZ: Number of cells in the Z direction required |
number | Range: ≥ 1 | |
ibox_IBOX: X direction cell indicator of slab edge required |
number | typical values= 1-10 | |
jbox_JBOX: Y direction cell indicator of slab edge required |
number | typical values= 1-10 |
GroundHeatTransfer:Slab:Materials¶
from idfpy.models import GroundHeatTransferSlabMaterials
Object gives an overall description of the slab ground heat transfer model.
| Field | Type | Default | Details |
|---|---|---|---|
nmat_NMAT: Number of materials required |
number | This field specifies the number of different materials that will be used in the model. Typically only a ground material and a slab material are used. (2 materials) Range: > 0 |
|
albedo_ALBEDO: Surface Albedo: No Snow |
number | 0.16 |
Two fields specify the albedo value of the surface: first for no snow coverage days; second for days with snow coverage. The albedo is the solar reflectivity of the surface, and can vary from 0.05 for blacktop to 0.95 for fresh snow. Typical values for North America reported by Bahnfleth range from 0.16 to 0.4. Range: ≥ 0, ≤ 1 |
albedo_ALBEDO: Surface Albedo: Snow |
number | 0.4 |
Range: ≥ 0, ≤ 1 |
epslw_EPSLW: Surface Emissivity: No Snow |
number | 0.94 |
EPSLW (No Snow and Snow) specifies the long wavelength (thermal) emissivity of the ground surface. primarily important for nighttime radiation to sky. typical value .95 Range: > 0 |
epslw_EPSLW: Surface Emissivity: Snow |
number | 0.86 |
Range: > 0 |
z0_Z0: Surface Roughness: No Snow |
number cm |
0.75 |
fields Z0 (No Snow and Snow) describe the height at which an experimentally velocity profile goes to zero. typical value= .75 cm Range: > 0 |
z0_Z0: Surface Roughness: Snow |
number cm |
0.25 |
typical value= .05 cm Range: > 0 |
hin_HIN: Indoor HConv: Downward Flow |
number W/m2-K |
6.13 |
These fields specify the combined convective and radiative heat transfer coefficient between the slab top inside surface and the room air for the cases where heat is flowing downward, and upward. The program toggles between the two if the direction of the heat flux changes. Typical values can be found in the ASHRAE Handbook of Fundamentals, but should be about 6 W/(m2-K) for downward heat flow and 9 W/(m2-K) for upward heat flow. typical value= 4-10 Range: > 0 |
hin_HIN: Indoor HConv: Upward |
number W/m2-K |
9.26 |
typical value= 4-10 Range: > 0 |
GroundHeatTransfer:Slab:MatlProps¶
from idfpy.models import GroundHeatTransferSlabMatlProps
This object contains the material properties for the materials used in the model. The fields are mostly self explanatory.
| Field | Type | Default | Details |
|---|---|---|---|
rho_RHO: Slab Material density |
number kg/m3 |
2300.0 |
Density of Slab Material typical value= 2300.0 Range: > 0 |
rho_RHO: Soil Density |
number kg/m3 |
1200.0 |
Density of Soil Material typical value= 1200.0 Range: > 0 |
cp_CP: Slab CP |
number J/kg-K |
650.0 |
Specific Heat of Slab Material typical value=650.0 Range: > 0 |
cp_CP: Soil CP |
number J/kg-K |
1200.0 |
Specific Heat of Soil Material typical value= 1200.0 Range: > 0 |
tcon_TCON: Slab k |
number W/m-K |
0.9 |
Conductivity of Slab Material typical value= .9 Range: > 0 |
tcon_TCON: Soil k |
number W/m-K |
1.0 |
Conductivity of Soil Material typical value= 1.0 Range: > 0 |
GroundHeatTransfer:Slab:XFACE¶
from idfpy.models import GroundHeatTransferSlabXFACE
This is only needed when using manual gridding (not recommended) XFACE: X Direction cell face coordinates: m
| Field | Type | Default | Details |
|---|---|---|---|
GroundHeatTransfer:Slab:YFACE¶
from idfpy.models import GroundHeatTransferSlabYFACE
This is only needed when using manual gridding (not recommended) YFACE: Y Direction cell face coordinates: m,
| Field | Type | Default | Details |
|---|---|---|---|
GroundHeatTransfer:Slab:ZFACE¶
from idfpy.models import GroundHeatTransferSlabZFACE
This is only needed when using manual gridding (not recommended) ZFACE: Z Direction cell face coordinates: m
| Field | Type | Default | Details |
|---|---|---|---|
HeatExchanger:AirToAir:FlatPlate¶
from idfpy.models import HeatExchangerAirToAirFlatPlate
Flat plate air-to-air heat exchanger, typically used for exhaust or relief air heat recovery.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
availability_Availability Schedule Name |
reference | Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
flow_Flow Arrangement Type |
choice | One of CounterFlow, CrossFlowBothUnmixed, ParallelFlow |
|
economizer_Economizer Lockout |
choice | Yes |
Yes means that the heat exchanger will be locked out (off) when the economizer is operating or high humidity control is active One of No, Yes |
ratio_Ratio of Supply to Secondary hA Values |
number | Ratio of h*A for supply side to h*A for exhaust side Range: ≥ 0 |
|
nominal_Nominal Supply Air Flow Rate |
number or Autosizem3/s |
Autosize |
|
nominal_Nominal Supply Air Inlet Temperature required |
number C |
||
nominal_Nominal Supply Air Outlet Temperature required |
number C |
||
nominal_Nominal Secondary Air Flow Rate required |
number or Autosizem3/s |
||
nominal_Nominal Secondary Air Inlet Temperature required |
number C |
||
nominal_Nominal Electric Power |
number W |
||
supply_Supply Air Inlet Node Name required |
string | ||
supply_Supply Air Outlet Node Name required |
string | ||
secondary_Secondary Air Inlet Node Name required |
string | ||
secondary_Secondary Air Outlet Node Name required |
string |
Referenced by 8 object types
AirLoopHVAC:DedicatedOutdoorAirSystem, AirLoopHVAC:OutdoorAirSystem:EquipmentList, AirflowNetwork:Distribution:Component:HeatExchanger, AirflowNetwork:Distribution:Linkage, Branch, CoilSystem:Cooling:DX:HeatExchangerAssisted, SpaceHVAC:ZoneEquipmentSplitter, ZoneHVAC:EquipmentList
HeatExchanger:AirToAir:SensibleAndLatent¶
from idfpy.models import HeatExchangerAirToAirSensibleAndLatent
This object models an air-to-air heat exchanger using effectiveness relationships. The heat exchanger can transfer sensible energy, latent energy, or both between the supply (primary) and exhaust (secondary) air streams.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
availability_Availability Schedule Name |
reference | Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
nominal_Nominal Supply Air Flow Rate required |
number or Autosizem3/s |
||
sensible_Sensible Effectiveness at 100% Heating Air Flow |
number dimensionless |
0.0 |
Range: ≥ 0, ≤ 1 |
latent_Latent Effectiveness at 100% Heating Air Flow |
number dimensionless |
0.0 |
Range: ≥ 0, ≤ 1 |
sensible_Sensible Effectiveness at 100% Cooling Air Flow |
number dimensionless |
0.0 |
Range: ≥ 0, ≤ 1 |
latent_Latent Effectiveness at 100% Cooling Air Flow |
number dimensionless |
0.0 |
Range: ≥ 0, ≤ 1 |
supply_Supply Air Inlet Node Name required |
string | ||
supply_Supply Air Outlet Node Name required |
string | ||
exhaust_Exhaust Air Inlet Node Name required |
string | ||
exhaust_Exhaust Air Outlet Node Name required |
string | ||
nominal_Nominal Electric Power |
number W |
0.0 |
Range: ≥ 0 |
supply_Supply Air Outlet Temperature Control |
choice | No |
One of No, Yes |
heat_Heat Exchanger Type |
choice | Plate |
One of Plate, Rotary |
frost_Frost Control Type |
choice | None |
One of ExhaustAirRecirculation, ExhaustOnly, MinimumExhaustTemperature, None |
threshold_Threshold Temperature |
number C |
1.7 |
Supply (outdoor) air inlet temp threshold for exhaust air recirculation and exhaust only frost control types. Exhaust air outlet threshold Temperature for minimum exhaust temperature frost control type. |
initial_Initial Defrost Time Fraction |
number dimensionless |
0.083 |
Fraction of the time when frost control will be invoked at the threshold temperature. This field only used for exhaust air recirc and exhaust-only frost control types. Range: ≥ 0, ≤ 1 |
rate_Rate of Defrost Time Fraction Increase |
number 1/K |
0.012 |
Rate of increase in defrost time fraction as actual temp falls below threshold temperature. This field only used for exhaust air recirc and exhaust-only frost control types. Range: ≥ 0 |
economizer_Economizer Lockout |
choice | Yes |
Yes means that the heat exchanger will be locked out (off) when the economizer is operating or high humidity control is active One of No, Yes |
sensible_Sensible Effectiveness of Heating Air Flow Curve Name |
reference | optional if this field has value, then the sensible effectiveness for heating will be the value in N2 multiplied by this curve value Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
latent_Latent Effectiveness of Heating Air Flow Curve Name |
reference | optional if this field has value, then the latent effectiveness for heating will be the value in N3 multiplied by this curve value Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
sensible_Sensible Effectiveness of Cooling Air Flow Curve Name |
reference | optional if this field has value, then the sensible effectiveness for cooling will be the value in N4 multiplied by this curve value Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
latent_Latent Effectiveness of Cooling Air Flow Curve Name |
reference | optional if this field has value, then the latent effectiveness for cooling will be the value in N5 multiplied by this curve value Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
Referenced by 7 object types
AirLoopHVAC:DedicatedOutdoorAirSystem, AirLoopHVAC:OutdoorAirSystem:EquipmentList, AirflowNetwork:Distribution:Component:HeatExchanger, AirflowNetwork:Distribution:Linkage, Branch, CoilSystem:Cooling:DX:HeatExchangerAssisted, ZoneHVAC:EnergyRecoveryVentilator
HeatExchanger:Desiccant:BalancedFlow¶
from idfpy.models import HeatExchangerDesiccantBalancedFlow
This object models a balanced desiccant heat exchanger. The heat exchanger transfers both sensible and latent energy between the process and regeneration air streams. The air flow rate and face velocity are assumed to be the same on both the process and regeneration sides of the heat exchanger.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
availability_Availability Schedule Name |
reference | Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
regeneration_Regeneration Air Inlet Node Name required |
string | ||
regeneration_Regeneration Air Outlet Node Name required |
string | ||
process_Process Air Inlet Node Name required |
string | ||
process_Process Air Outlet Node Name required |
string | ||
heat_Heat Exchanger Performance Object Type |
choice | HeatExchanger:Desiccant:BalancedFlow:PerformanceDataType1 |
One of HeatExchanger:Desiccant:BalancedFlow:PerformanceDataType1 |
heat_Heat Exchanger Performance Name required |
reference | Names a HeatExchanger:Desiccant:BalancedFlow:PerformanceDataType1 | |
economizer_Economizer Lockout |
choice | Yes |
Yes means that the heat exchanger will be locked out (off) when the economizer is operating or high humidity control is active One of No, Yes |
Referenced by 7 object types
AirLoopHVAC:DedicatedOutdoorAirSystem, AirLoopHVAC:OutdoorAirSystem:EquipmentList, AirflowNetwork:Distribution:Component:HeatExchanger, AirflowNetwork:Distribution:Linkage, Branch, CoilSystem:Cooling:DX:HeatExchangerAssisted, Dehumidifier:Desiccant:System
HeatExchanger:Desiccant:BalancedFlow:PerformanceDataType1¶
from idfpy.models import HeatExchangerDesiccantBalancedFlowPerformanceDataType1
RTO = B1 + B2*RWI + B3*RTI + B4*(RWI/RTI) + B5*PWI + B6*PTI + B7*(PWI/PTI) + B8*RFV RWO = C1 + C2*RWI + C3*RTI + C4*(RWI/RTI) + C5*PWI + C6*PTI + C7*(PWI/PTI) + C8*RFV where, RTO = Dry-bulb temperature of the regeneration outlet air (C) RWO = Humidity ratio of the regeneration outlet air (kgWater/kgDryAir) RWI = Humidity ratio of the regeneration inlet air (kgWater/kgDryAir) RTI = Dry-bulb temperature of the regeneration inlet air (C) PWI = Humidity ratio of the process inlet air (kgWater/kgDryAir) PTI = Dry-bulb temperature of the process inlet air (C) RFV = Regeneration Face Velocity (m/s)
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
nominal_Nominal Air Flow Rate |
number or Autosizem3/s |
Air flow rate at nominal conditions (assumed to be the same for both sides of the heat exchanger). | |
nominal_Nominal Air Face Velocity required |
number or Autosizem/s |
||
nominal_Nominal Electric Power |
number W |
0.0 |
Parasitic electric power (e.g., desiccant wheel motor) Range: ≥ 0 |
temperature_Temperature Equation Coefficient 1 required |
number | ||
temperature_Temperature Equation Coefficient 2 required |
number | ||
temperature_Temperature Equation Coefficient 3 required |
number | ||
temperature_Temperature Equation Coefficient 4 required |
number | ||
temperature_Temperature Equation Coefficient 5 required |
number | ||
temperature_Temperature Equation Coefficient 6 required |
number | ||
temperature_Temperature Equation Coefficient 7 required |
number | ||
temperature_Temperature Equation Coefficient 8 required |
number | ||
minimum_Minimum Regeneration Inlet Air Humidity Ratio for Temperature Equation required |
number kgWater/kgDryAir |
Range: ≥ 0, ≤ 1 | |
maximum_Maximum Regeneration Inlet Air Humidity Ratio for Temperature Equation required |
number kgWater/kgDryAir |
Range: ≥ 0, ≤ 1 | |
minimum_Minimum Regeneration Inlet Air Temperature for Temperature Equation required |
number C |
||
maximum_Maximum Regeneration Inlet Air Temperature for Temperature Equation required |
number C |
||
minimum_Minimum Process Inlet Air Humidity Ratio for Temperature Equation required |
number kgWater/kgDryAir |
Range: ≥ 0, ≤ 1 | |
maximum_Maximum Process Inlet Air Humidity Ratio for Temperature Equation required |
number kgWater/kgDryAir |
Range: ≥ 0, ≤ 1 | |
minimum_Minimum Process Inlet Air Temperature for Temperature Equation required |
number C |
||
maximum_Maximum Process Inlet Air Temperature for Temperature Equation required |
number C |
||
minimum_Minimum Regeneration Air Velocity for Temperature Equation required |
number m/s |
Range: > 0 | |
maximum_Maximum Regeneration Air Velocity for Temperature Equation required |
number m/s |
Range: > 0 | |
minimum_Minimum Regeneration Outlet Air Temperature for Temperature Equation required |
number C |
||
maximum_Maximum Regeneration Outlet Air Temperature for Temperature Equation required |
number C |
||
minimum_Minimum Regeneration Inlet Air Relative Humidity for Temperature Equation required |
number percent |
Range: ≥ 0, ≤ 100 | |
maximum_Maximum Regeneration Inlet Air Relative Humidity for Temperature Equation required |
number percent |
Range: ≥ 0, ≤ 100 | |
minimum_Minimum Process Inlet Air Relative Humidity for Temperature Equation required |
number percent |
Range: ≥ 0, ≤ 100 | |
maximum_Maximum Process Inlet Air Relative Humidity for Temperature Equation required |
number percent |
Range: ≥ 0, ≤ 100 | |
humidity_Humidity Ratio Equation Coefficient 1 required |
number | ||
humidity_Humidity Ratio Equation Coefficient 2 required |
number | ||
humidity_Humidity Ratio Equation Coefficient 3 required |
number | ||
humidity_Humidity Ratio Equation Coefficient 4 required |
number | ||
humidity_Humidity Ratio Equation Coefficient 5 required |
number | ||
humidity_Humidity Ratio Equation Coefficient 6 required |
number | ||
humidity_Humidity Ratio Equation Coefficient 7 required |
number | ||
humidity_Humidity Ratio Equation Coefficient 8 required |
number | ||
minimum_Minimum Regeneration Inlet Air Humidity Ratio for Humidity Ratio Equation required |
number kgWater/kgDryAir |
Range: ≥ 0, ≤ 1 | |
maximum_Maximum Regeneration Inlet Air Humidity Ratio for Humidity Ratio Equation required |
number kgWater/kgDryAir |
Range: ≥ 0, ≤ 1 | |
minimum_Minimum Regeneration Inlet Air Temperature for Humidity Ratio Equation required |
number C |
||
maximum_Maximum Regeneration Inlet Air Temperature for Humidity Ratio Equation required |
number C |
||
minimum_Minimum Process Inlet Air Humidity Ratio for Humidity Ratio Equation required |
number kgWater/kgDryAir |
Range: ≥ 0, ≤ 1 | |
maximum_Maximum Process Inlet Air Humidity Ratio for Humidity Ratio Equation required |
number kgWater/kgDryAir |
Range: ≥ 0, ≤ 1 | |
minimum_Minimum Process Inlet Air Temperature for Humidity Ratio Equation required |
number C |
||
maximum_Maximum Process Inlet Air Temperature for Humidity Ratio Equation required |
number C |
||
minimum_Minimum Regeneration Air Velocity for Humidity Ratio Equation required |
number m/s |
Range: > 0 | |
maximum_Maximum Regeneration Air Velocity for Humidity Ratio Equation required |
number m/s |
Range: > 0 | |
minimum_Minimum Regeneration Outlet Air Humidity Ratio for Humidity Ratio Equation required |
number kgWater/kgDryAir |
Range: ≥ 0, ≤ 1 | |
maximum_Maximum Regeneration Outlet Air Humidity Ratio for Humidity Ratio Equation required |
number kgWater/kgDryAir |
Range: ≥ 0, ≤ 1 | |
minimum_Minimum Regeneration Inlet Air Relative Humidity for Humidity Ratio Equation required |
number percent |
Range: ≥ 0, ≤ 100 | |
maximum_Maximum Regeneration Inlet Air Relative Humidity for Humidity Ratio Equation required |
number percent |
Range: ≥ 0, ≤ 100 | |
minimum_Minimum Process Inlet Air Relative Humidity for Humidity Ratio Equation required |
number percent |
Range: ≥ 0, ≤ 100 | |
maximum_Maximum Process Inlet Air Relative Humidity for Humidity Ratio Equation required |
number percent |
Range: ≥ 0, ≤ 100 |
Referenced by 1 object types
Humidifier:Steam:Electric¶
from idfpy.models import HumidifierSteamElectric
Electrically heated steam humidifier with fan.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
availability_Availability Schedule Name |
reference | Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
rated_Rated Capacity |
number or Autosizem3/s |
Capacity is m3/s of water at 5.05 C | |
rated_Rated Power |
number or AutosizeW |
if autosized the rated power is calculated from the rated capacity and enthalpy rise of water from 20.0C to 100.0C steam and assumes electric to thermal energy conversion efficiency of 100.0% | |
rated_Rated Fan Power |
number W |
Range: ≥ 0 | |
standby_Standby Power |
number W |
Range: ≥ 0 | |
air_Air Inlet Node Name |
string | ||
air_Air Outlet Node Name |
string | ||
water_Water Storage Tank Name |
reference | Names a WaterUse:Storage |
Referenced by 3 object types
AirLoopHVAC:DedicatedOutdoorAirSystem, AirLoopHVAC:OutdoorAirSystem:EquipmentList, Branch
Humidifier:Steam:Gas¶
from idfpy.models import HumidifierSteamGas
Natural gas fired steam humidifier with optional blower fan.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
availability_Availability Schedule Name |
reference | Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
rated_Rated Capacity |
number or Autosizem3/s |
Capacity is m3/s of water at 5.05 C The nominal full capacity water addition rate in m3/s of water at 5.05 C | |
rated_Rated Gas Use Rate |
number or AutosizeW |
if auto-sized, the rated gas use rate is calculated from the rated capacity and enthalpy rise of water from 20.0C to 100.0C steam and user input thermal efficiency value specified in the next input field. If this input field is hard-sized and Inlet Water Temperature Option input field is selected as FixedInletWaterTemperature, then the thermal efficiency input field will not be used or else if the Inlet Water Temperature Option input field is selected as VariableInletWaterTemperature, then the thermal efficiency input value is overridden by a value calculated from the capacity, rated gas use rate and design condition. | |
thermal_Thermal Efficiency |
number dimensionless |
0.8 |
Based on the higher heating value of fuel. If "Rated Gas Use Rate" in the field above is not auto-sized and the Inlet Water Temperature Option input field is specified as FixedInletWaterTemperature, then the thermal efficiency specified will not be used in the calculation, or else if the Inlet Water Temperature Option input field is selected as VariableInletWaterTemperature, then the thermal efficiency value is overridden by a value calculated from the capacity, rated gas use rate and design condition. Range: > 0, ≤ 1 |
thermal_Thermal Efficiency Modifier Curve Name |
reference | Linear, Quadratic and Cubic efficiency curves are solely a function of PLR. Linear = C1 + C2*PLR Quadratic = C1 + C2*PLR + C3*PLR^2 Cubic = C1 + C2*PLR + C3*PLR^2 + C4*PLR^3 This is thermal efficiency modifier curve name of gas fired steam humidifier. This curve is normalized, i.e., curve output value at rated condition is 1.0. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more |
|
rated_Rated Fan Power |
number W |
The nominal full capacity electric power input to the blower fan in Watts. If no blower fan is required to inject the dry steam to the supply air stream, then this input field is set to zero. Range: ≥ 0 |
|
auxiliary_Auxiliary Electric Power |
number W |
0.0 |
The auxiliary electric power input in watts. This amount of power will be consumed whenever the unit is available (as defined by the availability schedule). This electric power is used for control purpose only. Range: ≥ 0 |
air_Air Inlet Node Name |
string | ||
air_Air Outlet Node Name |
string | ||
water_Water Storage Tank Name |
reference | Names a WaterUse:Storage | |
inlet_Inlet Water Temperature Option |
choice | FixedInletWaterTemperature |
The inlet water temperature can be fixed at 20C as it is done for electric steam humidifier or it can be allowed to vary with temperature of the water source. Currently allowed water sources are main water or water storage tank in water use objects. if FixedInletWaterTemperature is specified, then a fixed 20C water temperature will be used, or else if VariableInletWaterTemperature is specified, then inlet water will vary depending the source water temperature. If this input field is left blank, then fixed inlet water temperature of 20C will be assumed. One of FixedInletWaterTemperature, VariableInletWaterTemperature |
Referenced by 3 object types
AirLoopHVAC:DedicatedOutdoorAirSystem, AirLoopHVAC:OutdoorAirSystem:EquipmentList, Branch
HybridModel:Zone¶
from idfpy.models import HybridModelZone
Zones with measured air temperature data and a range of dates. If the range of temperature measurement dates includes a leap day, the weather data should include a leap day.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
zone_Zone Name required |
reference | Names a Zone | |
calculate_Calculate Zone Internal Thermal Mass |
choice | No |
Use measured zone air temperature to calculate zone internal thermal mass. If set to Yes, the measured zone air temperature should be provided to calculate the thermal mass. If set to No, the inverse calculation of thermal mass will not be activated. One of No, Yes |
calculate_Calculate Zone Air Infiltration Rate |
choice | No |
Use measured temperature data (temperature, humidity ratio, or CO2 concentration) to calculate zone air infiltration air flow rate. Only one of field Calculate Zone Internal Thermal Mass, Calculate Zone Air Infiltration Rate, and Calculate Zone People Count can be set to YES at a time. By default, this field is set to NO. When set to NO, the inverse calculation of the zone air infiltration rate will not be activated. If this field is set to YES, one of the following fields (combinations) should be provided: 1. Measurements were conducted when HVAC is free-floating: 1.1 Zone Measured Air Temperature Schedule Name 1.2 Zone Measured Air Humidity Ratio Schedule Name 1.3 Zone Measured Air CO2 Concentration Schedule Name 2. Measurements were conducted when HVAC is on: 2.1 Zone Measured Air Temperature Schedule Name, Zone Input Supply Air Temperature Schedule Name, and Zone Input Supply Air Mass Flow Rate Schedule Name 2.2 Zone Measured Air Humidity Ratio Schedule Name, Zone Input Supply Air Temperature Schedule Name, Zone Input Supply Air Mass Flow Rate Schedule Name, and Zone Input Supply Air Humidity Ratio Schedule Name 2.3 Zone Measured Air CO2 Concentration Schedule Name, Zone Input Supply Air Mass Flow Rate Schedule Name, and Zone Input Supply Air CO2 Concentration Schedule Name One of No, Yes |
calculate_Calculate Zone People Count |
choice | No |
Use measured humidity ratio data (temperature, humidity ratio, or CO2 concentration) to calculate zone people count. Only one of field Calculate Zone Internal Thermal Mass, Calculate Zone Air Infiltration Rate, and Calculate Zone People Count can be set to YES at a time. By default, this field is set to NO. When set to NO, the inverse calculation of the zone people count will not be activated. If this field is set to YES, one of the following fields (combinations) should be provided: 1. Measurements were conducted when HVAC is free-floating: 1.1 Zone Measured Air Temperature Schedule Name 1.2 Zone Measured Air Humidity Ratio Schedule Name 1.3 Zone Measured Air CO2 Concentration Schedule Name 2. Measurements were conducted when HVAC is on: 2.1 Zone Measured Air Temperature Schedule Name, Zone Input Supply Air Temperature Schedule Name, and Zone Input Supply Air Mass Flow Rate Schedule Name 2.2 Zone Measured Air Humidity Ratio Schedule Name, Zone Input Supply Air Temperature Schedule Name, Zone Input Supply Air Mass Flow Rate Schedule Name, and Zone Input Supply Air Humidity Ratio Schedule Name 2.3 Zone Measured Air CO2 Concentration Schedule Name, Zone Input Supply Air Mass Flow Rate Schedule Name, and Zone Input Supply Air CO2 Concentration Schedule Name Field Zone Input People Activity Schedule Name, Zone Input People Sensible Heat Fraction Schedule Name, Zone Input People Radiant Heat Fraction Schedule Name, Zone Input People CO2 Generation Rate Schedule Name are optional. If provided, the default people activity level (130W), sensible heat generation rate (78W), latent heat generation (52W) rate, and CO2 generation rate (0.0000000382 [m3/(s*W)]) will be overwritten correspondingly. One of No, Yes |
zone_Zone Measured Air Temperature Schedule Name |
reference | from Schedule:File Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
zone_Zone Measured Air Humidity Ratio Schedule Name |
reference | from Schedule:File Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
zone_Zone Measured Air CO2 Concentration Schedule Name |
reference | from Schedule:File Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
zone_Zone Input People Activity Schedule Name |
reference | When this field is provided and valid, the default people activity level (used to calculate people count) will be overwritten. from Schedule:File Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
zone_Zone Input People Sensible Heat Fraction Schedule Name |
reference | When this field is provided and valid, the default sensible heat fraction from people (used to calculate people count) will be overwritten. from Schedule:File Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
zone_Zone Input People Radiant Heat Fraction Schedule Name |
reference | When this field is provided and valid, the default radiant heat portion of the sensible heat from people (used to calculate people count) will be overwritten. from Schedule:File Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
zone_Zone Input People CO2 Generation Rate Schedule Name |
reference | When this field is provided and valid, the default people CO2 generation rate (used to calculate people count) will be overwritten. from Schedule:File Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
zone_Zone Input Supply Air Temperature Schedule Name |
reference | from Schedule:File Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
zone_Zone Input Supply Air Mass Flow Rate Schedule Name |
reference | from Schedule:File Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
zone_Zone Input Supply Air Humidity Ratio Schedule Name |
reference | from Schedule:File Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
zone_Zone Input Supply Air CO2 Concentration Schedule Name |
reference | from Schedule:File Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
begin_Begin Month required |
integer | Range: ≥ 1, ≤ 12 | |
begin_Begin Day of Month required |
integer | Range: ≥ 1, ≤ 31 | |
end_End Month required |
integer | Range: ≥ 1, ≤ 12 | |
end_End Day of Month required |
integer | Range: ≥ 1, ≤ 31 |
LoadProfile:Plant¶
from idfpy.models import LoadProfilePlant
Used to simulate a scheduled plant loop demand profile. Load and flow rate are specified using schedules. Positive values are heating loads, and negative values are cooling loads. The actual load met is dependent on the performance of the supply loop components. Optional inputs for steam loop.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
inlet_Inlet Node Name required |
string | ||
outlet_Outlet Node Name required |
string | ||
load_Load Schedule Name required |
reference | Schedule values are load in [W] Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules |
|
peak_Peak Flow Rate required |
number m3/s |
||
flow_Flow Rate Fraction Schedule Name required |
reference | Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules | |
plant_Plant Loop Fluid Type |
choice | Water |
One of Steam, Water |
degree_Degree of SubCooling |
number C |
5.0 |
This field is used only when Plant Loop Fluid Type=Steam. Range: ≥ 1 |
degree_Degree of Loop SubCooling |
number C |
20.0 |
This field is used only when Plant Loop Fluid Type=Steam. Range: ≥ 10 |
Referenced by 2 object types
Matrix:TwoDimension¶
from idfpy.models import MatrixTwoDimension extensible
matrix data in row-major order list each row keeping the columns in order number of values must equal N1 x N2
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
number_Number of Rows required |
integer | ||
number_Number of Columns required |
integer | ||
values |
list | Each item: value |
Referenced by 1 object types
Parametric:FileNameSuffix¶
from idfpy.models import ParametricFileNameSuffix unique extensible
Defines the suffixes to be appended to the idf and output file names for each parametric run. If this object is omitted, the suffix will default to the run number.
| Field | Type | Default | Details |
|---|---|---|---|
nameName |
string | ||
suffixes |
list | Each item: suffix_for_file_name_in_run |
Parametric:Logic¶
from idfpy.models import ParametricLogic unique extensible
This object allows some types of objects to be included for some parametric cases and not for others. For example, you might want an overhang on a window in some parametric runs and not others. A single Parametric:Logic object is allowed per file. Consult the Input Output Reference for available commands and syntax.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
lines |
list | Each item: parametric_logic_line |
Parametric:RunControl¶
from idfpy.models import ParametricRunControl unique extensible
Controls which parametric runs are simulated. This object is optional. If it is not included, then all parametric runs are performed.
| Field | Type | Default | Details |
|---|---|---|---|
nameName |
string | ||
runs |
list | Each item: perform_run |
Parametric:SetValueForRun¶
from idfpy.models import ParametricSetValueForRun extensible
Parametric objects allow a set of multiple simulations to be defined in a single idf file. The parametric preprocessor scans the idf for Parametric:* objects then creates and runs multiple idf files, one for each defined simulation. The core parametric object is Parametric:SetValueForRun which defines the name of a parameter and sets the parameter to different values depending on which run is being simulated.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | Parameter Name Must begin with the dollar sign character. The second character must be a letter. Remaining characters may only be letters or numbers. No spaces allowed. | |
values |
list | Each item: value_for_run |
PlantLoop¶
from idfpy.models import PlantLoop
Defines a central plant loop.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
fluid_Fluid Type |
choice | Water |
One of Steam, UserDefinedFluidType, Water |
user_User Defined Fluid Type |
reference | This field is only required when Fluid Type is UserDefinedFluidType Names a FluidProperties:GlycolConcentration, FluidProperties:Name |
|
plant_Plant Equipment Operation Scheme Name required |
reference | Names a PlantEquipmentOperationSchemes | |
loop_Loop Temperature Setpoint Node Name required |
string | ||
maximum_Maximum Loop Temperature required |
number C |
||
minimum_Minimum Loop Temperature required |
number C |
||
maximum_Maximum Loop Flow Rate required |
number or Autosizem3/s |
||
minimum_Minimum Loop Flow Rate |
number m3/s |
0.0 |
|
plant_Plant Loop Volume |
number or Autocalculatem3 |
Autocalculate |
|
plant_Plant Side Inlet Node Name required |
string | ||
plant_Plant Side Outlet Node Name required |
string | ||
plant_Plant Side Branch List Name required |
reference | Names a BranchList | |
plant_Plant Side Connector List Name |
reference | Names a ConnectorList | |
demand_Demand Side Inlet Node Name required |
string | ||
demand_Demand Side Outlet Node Name required |
string | ||
demand_Demand Side Branch List Name required |
reference | Names a BranchList | |
demand_Demand Side Connector List Name |
reference | Names a ConnectorList | |
load_Load Distribution Scheme |
choice | SequentialLoad |
One of Optimal, SequentialLoad, SequentialUniformPLR, UniformLoad, UniformPLR |
availability_Availability Manager List Name |
reference | Names a AvailabilityManagerAssignmentList | |
plant_Plant Loop Demand Calculation Scheme |
choice | SingleSetpoint |
One of DualSetpointDeadband, SingleSetpoint |
common_Common Pipe Simulation |
choice | None |
Specifies a primary-secondary loop configuration. The plant side is the primary loop, and the demand side is the secondary loop. A secondary supply pump is required on the demand side. None = Primary-only, no secondary simulation CommonPipe = Primary-secondary with no temperature control at primary-secondary interface TwoWayCommonPipe = Primary-secondary with control of secondary supply temperature or primary return temperature (requires a setpoint be placed on the plant side or demand side inlet node). One of CommonPipe, None, TwoWayCommonPipe |
pressure_Pressure Simulation Type |
choice | None |
One of LoopFlowCorrection, None, PumpPowerCorrection |
loop_Loop Circulation Time |
number minutes |
2.0 |
This field is only used to autocalculate the Plant Loop Volume. Loop Volume = Loop Circulation Time * Maximum Loop Flow Rate Range: ≥ 0 |
Referenced by 1 object types
Table:IndependentVariable¶
from idfpy.models import TableIndependentVariable extensible
An independent variable representing a single dimension of a Table:Lookup object.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
interpolation_Interpolation Method |
choice | Linear |
One of Cubic, Linear |
extrapolation_Extrapolation Method |
choice | Constant |
One of Constant, Linear |
minimum_Minimum Value |
number | ||
maximum_Maximum Value |
number | ||
normalization_Normalization Reference Value |
number | ||
unit_Unit Type |
choice | Dimensionless |
One of Angle, Dimensionless, Distance, MassFlow, Power, Temperature, VolumetricFlow |
external_External File Name |
string | ||
external_External File Column Number |
integer | Range: ≥ 1 | |
external_External File Starting Row Number |
integer | Range: ≥ 1 | |
values |
list | Each item: value |
Referenced by 1 object types
Table:IndependentVariableList¶
from idfpy.models import TableIndependentVariableList extensible
A sorted list of independent variables used by one or more Table:Lookup objects.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
independent_ |
list | Each item: independent_variable_name |
Referenced by 1 object types
Table:Lookup¶
from idfpy.models import TableLookup extensible
Lookup tables are used in place of curves and can represent any number of independent variables (defined as Table:IndependentVariable objects in a Table:IndependentVariableList). Output values are interpolated within the bounds defined by each independent variable and extrapolated beyond the bounds according to the interpolation/extrapolation methods defined by each independent variable.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
independent_Independent Variable List Name required |
reference | Names a Table:IndependentVariableList | |
normalization_Normalization Method |
choice | None |
One of AutomaticWithDivisor, DivisorOnly, None |
normalization_Normalization Divisor |
number | 1.0 |
|
minimum_Minimum Output |
number | ||
maximum_Maximum Output |
number | ||
output_Output Unit Type |
choice | Dimensionless |
One of Capacity, Dimensionless, Power, Pressure, Temperature |
external_External File Name |
string | ||
external_External File Column Number |
integer | Range: ≥ 1 | |
external_External File Starting Row Number |
integer | Range: ≥ 1 | |
values |
list | Each item: output_value |
Referenced by 101 object types
AirConditioner:VariableRefrigerantFlow, AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl, AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl:HR, AirTerminal:SingleDuct:ConstantVolume:FourPipeBeam, AirTerminal:SingleDuct:ParallelPIU:Reheat, AirflowNetwork:MultiZone:ExternalNode, AirflowNetwork:OccupantVentilationControl, AvailabilityManager:HybridVentilation, Boiler:HotWater, Branch, Chiller:Absorption:Indirect, Chiller:ConstantCOP, Chiller:Electric, Chiller:Electric:EIR, Chiller:Electric:ReformulatedEIR, Chiller:EngineDriven, ChillerHeater:Absorption:DirectFired, ChillerHeater:Absorption:DoubleEffect, ChillerHeaterPerformance:Electric:EIR, Coil:Cooling:DX:CurveFit:Performance, Coil:Cooling:DX:CurveFit:Speed, Coil:Cooling:DX:MultiSpeed, Coil:Cooling:DX:SingleSpeed, Coil:Cooling:DX:SingleSpeed:ThermalStorage, Coil:Cooling:DX:TwoSpeed, Coil:Cooling:DX:TwoStageWithHumidityControlMode, Coil:Cooling:DX:VariableRefrigerantFlow, Coil:Cooling:DX:VariableRefrigerantFlow:FluidTemperatureControl, Coil:Cooling:DX:VariableSpeed, Coil:Cooling:WaterToAirHeatPump:EquationFit, Coil:Cooling:WaterToAirHeatPump:ParameterEstimation, Coil:Cooling:WaterToAirHeatPump:VariableSpeedEquationFit, Coil:Heating:DX:MultiSpeed, Coil:Heating:DX:SingleSpeed, Coil:Heating:DX:VariableRefrigerantFlow, Coil:Heating:DX:VariableRefrigerantFlow:FluidTemperatureControl, Coil:Heating:DX:VariableSpeed, Coil:Heating:Fuel, Coil:Heating:Gas:MultiStage, Coil:Heating:WaterToAirHeatPump:EquationFit, Coil:Heating:WaterToAirHeatPump:ParameterEstimation, Coil:Heating:WaterToAirHeatPump:VariableSpeedEquationFit, Coil:WaterHeating:AirToWaterHeatPump:Pumped, Coil:WaterHeating:AirToWaterHeatPump:VariableSpeed, Coil:WaterHeating:AirToWaterHeatPump:Wrapped, Coil:WaterHeating:Desuperheater, CoilPerformance:DX:Cooling, Controller:OutdoorAir, CoolingTower:VariableSpeed, CoolingTower:VariableSpeed:Merkel, Dehumidifier:Desiccant:NoFans, Dehumidifier:Desiccant:System, ElectricEquipment:ITE:AirCooled, ElectricEquipment:ITE:AirCooled:Definition, ElectricLoadCenter:Inverter:FunctionOfPower, ElectricLoadCenter:Storage:Battery, ElectricLoadCenter:Storage:Converter, EnergyManagementSystem:CurveOrTableIndexVariable, EvaporativeCooler:Direct:ResearchSpecial, EvaporativeCooler:Indirect:ResearchSpecial, Fan:ComponentModel, Fan:OnOff, Fan:SystemModel, FaultModel:Fouling:AirFilter, Generator:CombustionTurbine, Generator:FuelCell:AirSupply, Generator:FuelCell:Inverter, Generator:FuelCell:PowerModule, Generator:FuelCell:WaterSupply, Generator:FuelSupply, Generator:InternalCombustionEngine, Generator:MicroCHP:NonNormalizedParameters, Generator:MicroTurbine, HeatExchanger:AirToAir:SensibleAndLatent, HeatPump:AirToWater, HeatPump:AirToWater:FuelFired:Cooling, HeatPump:AirToWater:FuelFired:Heating, HeatPump:PlantLoop:EIR:Cooling, HeatPump:PlantLoop:EIR:Heating, HeatPump:WaterToWater:EquationFit:Cooling, HeatPump:WaterToWater:EquationFit:Heating, Humidifier:Steam:Gas, OutdoorAir:Node, Pump:ConstantSpeed, Pump:VariableSpeed, Refrigeration:AirChiller, Refrigeration:Case, Refrigeration:Compressor, Refrigeration:CompressorRack, Refrigeration:Condenser:AirCooled, Refrigeration:GasCooler:AirCooled, Refrigeration:SecondarySystem, SetpointManager:CondenserEnteringReset, SurfaceConvectionAlgorithm:Inside:UserCurve, SurfaceConvectionAlgorithm:Outside:UserCurve, ThermalStorage:Ice:Detailed, WaterHeater:Mixed, WindowMaterial:Glazing, ZoneHVAC:Dehumidifier:DX, ZoneHVAC:EnergyRecoveryVentilator:Controller, ZoneHVAC:HybridUnitaryHVAC
TemperingValve¶
from idfpy.models import TemperingValve
Temperature-controlled diversion valve used to divert flow around one or more plant components such as a hot water heater. It can only be used on one of two branches between a Splitter and a Mixer.
| Field | Type | Default | Details |
|---|---|---|---|
nameName required |
string | ||
inlet_Inlet Node Name required |
string | Name of a Node | |
outlet_Outlet Node Name required |
string | Name of a Node | |
stream_Stream 2 Source Node Name required |
string | Name of a Node | |
temperature_Temperature Setpoint Node Name required |
string | Name of a Node | |
pump_Pump Outlet Node Name required |
string |
Referenced by 4 object types
AirLoopHVAC:DedicatedOutdoorAirSystem, Branch, CondenserEquipmentList, PlantEquipmentList
ZoneTerminalUnitList¶
from idfpy.models import ZoneTerminalUnitList extensible
List of variable refrigerant flow (VRF) terminal units served by a given VRF condensing unit. See ZoneHVAC:TerminalUnit:VariableRefrigerantFlow and AirConditioner:VariableRefrigerantFlow.
| Field | Type | Default | Details |
|---|---|---|---|
zone_Zone Terminal Unit List Name required |
string | ||
terminal_ |
list | Each item: zone_terminal_unit_name |