×
Menu
Index

Design options model variables

 
The follow tables summaries the details of each model variable.
 
 
Variable
Formula Variables
Operations
 
 
Air exchanges (profiles)
 
 
Auxiliary variation profile
 
 
General room variables ( 2.3.2.2 )
AirExchangeReference ( 2.3.2.9 )
AuxiliaryVariationProfile
 
Replace with any modulating profiles in the model.
 
Infiltration variation profile
General room variables ( 2.3.2.2 )
AirExchangeReference ( 2.3.2.9 )
InfiltrationVariationProfile
 
Replace with any modulating profiles in the model.
 
Natural variation profile
General room variables ( 2.3.2.2 )
AirExchangeReference ( 2.3.2.9 )
NaturalVariationProfile
 
Replace with any modulating profiles in the model.
 
 
Air exchanges (value)
 
 
Auxiliary adjacent condition
General room variables ( 2.3.2.2 )
AirExchangeReference ( 2.3.2.9 )
AuxiliaryAdjacentCondition
 
Replace
 
 
Auxiliary max flow ( individual air exchange )
General room variables ( 2.3.2.2 )
AuxiliaryMaxFlowRoomTotal
AuxiliaryMaxFlowIndividualAirExchange
 
Value Increase
Value Decrease
Value Replacement
 
This is a property for auxiliary air exchange.
Update the value of an individual auxiliary air exchange.
 
No change will be made if the resulting value is out of the valid range [ 0, 20000 ], error will be logged in the log file.
 
 
 
Auxiliary max flow ( room total )
General room variables ( 2.3.2.2 )
AuxiliaryMaxFlowRoomTotal
 
Value Increase
Value Decrease
Value Replacement
 
This is a property for auxiliary air exchange.
 
If a room has a single auxiliary air exchange, update the value.
 
If a room has multiple auxiliary air exchanges, update the value of each auxiliary air exchange proportional to their current value.
 
 
Infiltration adjacent condition
General room variables ( 2.3.2.2 )
AirExchangeReference ( 2.3.2.9 )
InfiltrationAdjacentCondition
 
Replace
 
Infiltration max flow ( individual air exchange )
General room variables ( 2.3.2.2 )
InfiltrationMaxFlowRoomTotal
InfiltrationMaxFlowIndividualAirExchange
 
Value Increase
Value Decrease
Value Replacement
 
This is a property for infiltration air exchange.
 
Update the value of an individual infiltration air exchange.
 
No change will be made if the resulting value is out of the valid range [ 0, 20000 ], error will be logged in the log file.
 
Infiltration max flow ( room total )
General room variables ( 2.3.2.2 )
InfiltrationMaxFlowRoomTotal
 
Value Increase
Value Decrease
Value Replacement
Update the value on room level.
 
This is a property for infiltration air exchange.
 
If a room has a single infiltration air exchange, update the value.
 
If a room has multiple infiltration air exchanges, update the value of each infiltration air exchange proportional to their current value.
 
 
 
Natural adjacent condition
General room variables ( 2.3.2.2 )
AirExchangeReference ( 2.3.2.9
NaturalAdjacentCondition
 
Replace
 
Natural max flow ( individual air exchange )
General room variables ( 2.3.2.2 )
NaturalMaxFlowRoomTotal
NaturalMaxFlowIndividualAirExchange
 
Value Increase
Value Decrease
Value Replacement
 
This is a property for natural air exchange.
 
Update the value of an individual natural air exchange.
 
No change will be made if the resulting value is out of the valid range [ 0, 20000 ], error will be logged in the log file.
 
Natural max flow ( room total )
General room variables ( 2.3.2.2 )
NaturalMaxFlowRoomTotal
 
Value Increase
Value Decrease
Value Replacement
 
This is a property for natural air exchange.
 
If a room has a single natural air exchange, update the value.
 
If a room has multiple natural air exchanges, update the value of each natural air exchange proportional to their current value.
 
 
 
 
Air exchanges (non-template assignments)
 
 
Auxiliary air exchange ( individual non-template )
General room variables ( 2.3.2.2 )
AuxiliaryAirExchangeIndividual
 
Replace the first qualified air exchange that is user edited instead of template assigned, and retain the other air exchanges.
 
Note this operation will fail if the replacement will result in two identical air exchanges both being included in a room.
 
 
Infiltration air exchange ( individual non-template )
General room variables ( 2.3.2.2 )
InfiltrationAirExchangeIndividual
 
Replace the first qualified air exchange that is user edited instead of template assigned, and retain the other air exchanges.
 
Note this operation will fail if the replacement will result in two identical air exchanges both being included in a room.
 
Natural air exchange ( individual non-template )
General room variables ( 2.3.2.2 )
NaturalAirExchangeIndividual
 
Replace the first qualified air exchange that is user edited instead of template assigned, and retain the other air exchanges.
 
Note this operation will fail if the replacement will result in two identical air exchanges both being included in a room.
 
Auxiliary air exchange ( room non-template )
General room variables ( 2.3.2.2 )
Replace room level auxiliary air exchange.
This variable only affects the user-edited auxiliary air exchanges. Template assigned air exchanges will not be affected.
 
If a room has a single auxiliary air exchange that is user edited, replace it.
 
If a room has multiple user-edited auxiliary air exchanges, replace the first user-edited auxiliary air exchange in the list of air exchanges of the given room with the target auxiliary air exchange; then remove all the rest of the user-edited auxiliary air exchange from the room.
 
Note this operation will fail if the replacement will result in two identical air exchanges both being included in a room.
 
 
 
Infiltration air exchange ( room non-template )
General room variables ( 2.3.2.2 )
 
Replace room level infiltration air exchange.
This variable only affects the user-edited infiltration air exchanges. Template assigned air exchanges will not be affected.
 
If a room has a single infiltration air exchange that is user edited, replace it.
 
If a room has multiple user-edited infiltration air exchanges, replace the first user-edited infiltration air exchange in the list of air exchanges of the given room with the target infiltration air exchange; then remove all the rest of the user-edited infiltration air exchange from the room.
 
Note this operation will fail if the replacement will result in two identical air exchanges both being included in a room.
 
Natural air exchange ( room non-template )
General room variables ( 2.3.2.2 )
Replace room level natural air exchange.
This variable only affects the user-edited natural air exchanges. Template assigned air exchanges will not be affected.
 
If a room has a single natural air exchange that is user edited, replace it.
 
If a room has multiple user-edited natural air exchanges, replace the first user-edited natural air exchange in the list of air exchanges of the given room with the target natural air exchange; then remove all the rest of the user-edited natural air exchange from the room.
 
Note this operation will fail if the replacement will result in two identical air exchanges both being included in a room.
 
 
Apache system ( heating )
 
 
 
 
 
Heating fuel
General room variables ( 2.3.2.2 )
General Apache system variables ( 2.3.2.5 )
SystemHeatingFuel
 
Replace.
 
This is an apache system property.
 
Replace the system heating fuel with a fuel from the default fuels list. Only apply to non-NCM systems.
 
The mechanism for modifying the application object (section 2.2.1 ) will apply.
 
Heat recovery effectiveness
 
General room variables ( 2.3.2.2 )
General Apache system variables ( 2.3.2.5 )
SystemHeatRecoveryEffectiveness
 
Value Increase
Value Decrease
Value Replacement
 
This is an apache system property.
 
Update the heat recovery effectiveness of all apache systems that satisfy the selection criteria.
 
No change will be made if the resulting value is out of the valid range [0, 1], error will be logged in the log file.
 
The mechanism for modifying the application object (section 2.2.1 ) will apply.
 
 
Heating seasonal efficiency
General room variables ( 2.3.2.2 )
General Apache system variables ( 2.3.2.5 )
SystemHeatingSeasonalEfficiency
 
Value Increase
Value Decrease
Value Replacement
 
This is an apache system property.
 
Update the heating seasonal efficiency of all apache systems that satisfy the selection criteria.
 
No change will be made if the resulting value is out of the valid range [0.01, 30], error will be logged in the log file.
 
The mechanism for modifying the application object (section 2.2.1 ) will apply.
 
Heating SCoP
General room variables ( 2.3.2.2 )
General Apache system variables ( 2.3.2.5 )
SystemHeatingSCoP
 
Value Increase
Value Decrease
Value Replacement
 
This is an apache system property.
 
Update the heating SCoP of all apache systems that satisfy the selection criteria.
 
No change will be made if the resulting value is out of the valid range [0.1, 80], error will be logged in the log file.
 
The mechanism for modifying the application object (section 2.2.1 ) will apply.
 
 
Apache system ( cooling )
 
 
Cooling fuel
General room variables ( 2.3.2.2 )
General Apache system variables ( 2.3.2.5 )
SystemCoolingFuel
 
Replace.
 
This is an apache system property.
 
Replace the system cooling fuel with a fuel from the default fuels list. Only apply to non-NCM systems.
 
The mechanism for modifying the application object (section 2.2.1 ) will apply.
 
Cooling nominal EER
General room variables ( 2.3.2.2 )
General Apache system variables ( 2.3.2.5 )
SystemCoolingNominalEER
 
 
Value Increase
Value Decrease
Value Replacement
 
This is an apache system property.
 
Update the cooling nominal EER of all apache systems that satisfy the selection criteria.
 
No change will be made if the resulting value is out of the valid range [0.01, 80], error will be logged in the log file.
 
The mechanism for modifying the application object (section 2.2.1 ) will apply.
 
Cooling seasonal EER
General room variables ( 2.3.2.2 )
General Apache system variables ( 2.3.2.5 )
SystemCoolingSeasonalEER
 
Value Increase
Value Decrease
Value Replacement
 
This is an apache system property.
 
Update the cooling seasonal EER of all apache systems that satisfy the selection criteria.
 
No change will be made if the resulting value is out of the valid range [0.01, 80], error will be logged in the log file.
 
The mechanism for modifying the application object (section 2.2.1 ) will apply.
 
Cooling SSEER
General room variables ( 2.3.2.2 )
General Apache system variables ( 2.3.2.5 )
SystemCoolingSSEER
 
 
Value Increase
Value Decrease
Value Replacement
 
This is an apache system property.
 
Update the cooling SSEER of all apache systems that satisfy the selection criteria.
 
No change will be made if the resulting value is out of the valid range [0.01, 80], error will be logged in the log file.
 
The mechanism for modifying the application object (section 2.2.1 ) will apply.
 
 
 
Apache system ( aux energy )
 
 
Aux energy w/m2
General room variables ( 2.3.2.2 )
General Apache system variables ( 2.3.2.5 )
SystemAuxEnergyWPerM2
 
Value Increase
Value Decrease
Value Replacement
 
This is an apache system property.
 
Update the aux energy value w/m2 of all apache systems that satisfy the selection criteria.
 
No change will be made if the resulting value is out of the valid range [ 0, 100 ], error will be logged in the log file.
 
The mechanism for modifying the application object (section 2.2.1 ) will apply.
 
Off schedule aux energy w/m2
General room variables ( 2.3.2.2 )
General Apache system variables ( 2.3.2.5 )
SystemOffScheduleAuxEnergyWPerM2
 
Value Increase
Value Decrease
Value Replacement
 
This is an apache system property.
 
Update the off schedule aux energy w/m2 of all apache systems that satisfy the selection criteria.
 
No change will be made if the resulting value is out of the valid range [0, 100], error will be logged in the log file.
 
The mechanism for modifying the application object (section 2.2.1 ) will apply.
 
 
Apache system ( room level )
 
 
System air supply variation profile
General room variables ( 2.3.2.2 )
SystemAirSupplyVariationProfile
 
Replace with any modulating profiles in the model.
 
Aux vent system
General room variables ( 2.3.2.2 )
AuxVentSystem
 
Replace the Auxiliary system with any model supported system in the apache systems database.
 
Untick Template check box.
Untick the “Use same system for auxiliary vent. system” check box
 
 
DHW system
General room variables ( 2.3.2.2 )
DHWSystem
 
 
Replace the DHW system with any model supported system in the apache systems database.
 
Untick Template check box.
Untick the “Use same system for DHW system” check box
 
 
HVAC system
General room variables ( 2.3.2.2 )
ApacheSystem
 
Replace the apache system with any model supported system in the apache systems database.
 
Untick Template check box.
 
 
Heating unit size
General room variables ( 2.3.2.2 )
HeatingUnitSize
 
Value Increase
Value Decrease
Value Replacement
 
This is a room property.
Update the value.
No change will be made if the resulting value is out of the valid range [0, 1e+006], error will be logged in the log file.
 
 
Cooling unit size
General room variables ( 2.3.2.2 )
CoolingUnitSize
 
Value Increase
Value Decrease
Value Replacement
 
This is a room property.
Update the value.
No change will be made if the resulting value is out of the valid range [ 0, 1e+006], error will be logged in the log file.
 
 
Heating plant radiant fraction
General room variables ( 2.3.2.2 )
HeatingPlantRadiantFraction
 
Value Increase
Value Decrease
Value Replacement
 
This is a room property.
Update the value.
No change will be made if the resulting value is out of the valid range [ 0, 1 ], error will be logged in the log file.
 
If value update succeeds, untick Template check box.
Otherwise, no change should be made.
 
 
Cooling plant radiant fraction
General room variables ( 2.3.2.2 )
CoolingPlantRadiantFraction
 
Value Increase
Value Decrease
Value Replacement
 
This is a room property.
Update the value.
No change will be made if the resulting value is out of the valid range [ 0, 1 ], error will be logged in the log file.
 
If value update succeeds, untick Template check box.
Otherwise, no change should be made.
 
 
System air supply flow rate
General room variables ( 2.3.2.2 )
SystemAirSupplyFlowRate
 
Value Increase
Value Decrease
Value Replacement
 
This is a room property.
Update the value.
No change will be made if the resulting value is out of the valid range [ 0, 999999 ], error will be logged in the log file.
 
If successful updated the value, the Template check box should be unticked.
 
 
 
System air supply free cooling flow
General room variables ( 2.3.2.2 )
SystemAirSupplyFreeCoolingFlow
 
Value Increase
Value Decrease
Value Replacement
 
This is a room property.
Update the value.
No change will be made if the resulting value is out of the valid range [ 0, 999999 ], error will be logged in the log file.
 
If successful updated the value, the Template check box should be unticked.
 
 
 
 
Constructions
 
 
External door
General room variables ( 2.3.2.2 )
General opaque construction variables ( 2.3.2.6 )
General surface variables ( 2.3.2.3 )
ConstructionExtDoor
 
Add Layers On Inner Face
Add Layers On Outer Face
Replace Outermost Cavity
Replace
 
See section 2.2 for details on each operation.
 
The mechanism for modifying the application object (section 2.2.1 ) will apply to all operations except “Replace”.
 
 
External wall
General room variables ( 2.3.2.2 )
General opaque construction variables ( 2.3.2.6 )
General surface variables ( 2.3.2.3 )
ConstructionExtWall
 
Add Layers On Inner Face
Add Layers On Outer Face
Replace Outermost Cavity
Replace
 
See section 2.2 for details on each operation.
 
The mechanism for modifying the application object (section 2.2.1 ) will apply to all operations except “Replace”.
 
 
External window
General room variables ( 2.3.2.2 )
General glazed construction variables ( 2.3.2.6 2.3.2.7 )
General surface variables ( 2.3.2.3 )
ConstructionExtWindow
 
Replace
 
See section 2.2 for details on each operation.
 
Ground floor
General room variables ( 2.3.2.2 )
General opaque construction variables ( 2.3.2.6 )
General surface variables ( 2.3.2.3 )
ConstructionGroundFloor
 
Add Layers On Inner Face
Add Layers On Outer Face
Replace Outermost Cavity
Replace
 
See section 2.2 for details on each operation.
 
The mechanism for modifying the application object (section 2.2.1 ) will apply to all operations except “Replace”.
 
 
Internal ceiling / floor
General room variables ( 2.3.2.2 )
General opaque construction variables ( 2.3.2.6 )
General surface variables ( 2.3.2.3 )
ConstructionIntCeilingFloor
 
Add Layers On Inner Face
Add Layers On Outer Face
Replace Outermost Cavity
Replace
 
See section 2.2 for details on each operation.
 
The mechanism for modifying the application object (section 2.2.1 ) will apply to all operations except “Replace”.
 
 
Internal door
General room variables ( 2.3.2.2 )
General opaque construction variables ( 2.3.2.6 )
General surface variables ( 2.3.2.3 )
ConstructionIntDoor
 
Add Layers On Inner Face
Add Layers On Outer Face
Replace Outermost Cavity
Replace
 
See section 2.2 for details on each operation.
 
The mechanism for modifying the application object (section 2.2.1 ) will apply to all operations except for “Replace”.
 
 
Internal window
General room variables ( 2.3.2.2 )
General glazed construction variables ( 2.3.2.6 2.3.2.7 )
General surface variables ( 2.3.2.3 )
ConstructionIntWindow
 
Replace
 
See section 2.2 for details on each operation.
 
Partition
General room variables ( 2.3.2.2 )
General opaque construction variables ( 2.3.2.6 )
General surface variables ( 2.3.2.3 )
ConstructionPartition
 
Add Layers On Inner Face
Add Layers On Outer Face
Replace Outermost Cavity
Replace
 
See section 2.2 for details on each operation.
 
The mechanism for modifying the application object (section 2.2.1 ) will apply to all operations except “Replace”.
 
 
Roof
General room variables ( 2.3.2.2 )
General opaque construction variables ( 2.3.2.6 )
General surface variables ( 2.3.2.3 )
ConstructionRoofLight
 
Add Layers On Inner Face
Add Layers On Outer Face
Replace Outermost Cavity
Replace
 
See section 2.2 for details on each operation.
 
The mechanism for modifying the application object (section 2.2.1 ) will apply to all operations except “Replace”.
 
 
Roof light
General room variables ( 2.3.2.2 )
General glazed construction variables ( 2.3.2.6 2.3.2.7 )
General surface variables ( 2.3.2.3 )
ConstructionRoofLight
 
Replace
 
See section 2.2 for details on each operation.
 
 
General
 
 
Building orientation
BuildingOrientation
 
Value Increase
Value Decrease
Value Replacement
 
This is a model property.
Update the value.
No change will be made if the resulting value is out of the valid range [ 0, 360 ], error will be logged in the log file.
 
 
General template
General room variables ( 2.3.2.2 )
GeneralTemplate
 
Replace with any general templates from the template database.
 
Thermal template
General room variables ( 2.3.2.2 )
ThermalTemplate
 
Replace with any thermal templates from the template database.
 
Weather file
N/A
Replace with any simulation weather file installed in local computer.
 
 
Internal gains (profiles)
 
 
Computers variation profile
General room variables ( 2.3.2.2 )
General internal gain variables ( 2.3.2.8 )
ComputersVariationProfile
 
Replace the computer variation profile of each computer internal gains with any modulating profiles in the model.
 
Cooking variation profile
General room variables ( 2.3.2.2 )
General internal gain variables ( 2.3.2.8 )
CookingVariationProfile
 
Replace the cooking variation profile of each cooking internal gains with any modulating profiles in the model.
 
Lighting dimming profile
General room variables ( 2.3.2.2 )
General internal gain variables ( 2.3.2.8 )
LightingDimmingProfile
 
Replace the lighting dimming profile of each lighting internal gains with any modulating profiles in the model.
 
Lighting variation profile
General room variables ( 2.3.2.2 )
General internal gain variables ( 2.3.2.8 )
LightingVariationProfile
 
Replace the lighting variation profile of each lighting internal gains with any modulating profiles in the model.
 
Machinery variation profile
General room variables ( 2.3.2.2 )
General internal gain variables ( 2.3.2.8 )
MachineryVariationProfile
 
Replace the machinery variation profile of each machinery internal gains with any modulating profiles in the model.
 
Misc variation profile
General room variables ( 2.3.2.2 )
General internal gain variables ( 2.3.2.8 )
MiscVariationProfile
 
Replace the misc. variation profile of each misc. internal gains with any modulating profiles in the model.
 
People variation profile
General room variables ( 2.3.2.2 )
General internal gain variables ( 2.3.2.8 )
PeopleVariationProfile
 
Replace the people variation profile of each people internal gains with any modulating profiles in the model.
 
 
Internal gains (values)
 
 
Computers max sensible gain ( individual gain )
General room variables ( 2.3.2.2 )
ComputersMaxSensibleGainRoomTotal
ComputersMaxSensibleGainIndividualGain
 
Value Increase
Value Decrease
Value Replacement
 
This is a property for computers internal gain.
Update the value of an individual computers internal gain.
 
No change will be made if the resulting value is out of the valid range [0, 5000000]. Errors will be logged into the log file.
 
If successful updated the value, the Input mode Template check box should be unticked and the maximum power consumption will be updated to the same value as the max sensible gain.
 
 
Computers max sensible gain ( room total )
General room variables ( 2.3.2.2 )
ComputersMaxSensibleGainRoomTotal
 
Value Increase
Value Decrease
Value Replacement
 
This is a property for computers internal gain.
 
If a room has a single computers internal gain, update the value.
 
If a room has multiple computers internal gains, update the value of each computers internal gain proportional to their current value.
 
No change will be made if the resulting value of any of the computer internal gains is out of the valid range [-5000000, 5000000]. Errors will be logged into the log file.
 
If successful updated the value, the Input mode Template check box should be unticked and the maximum power consumption will be updated to the same value as the max sensible gain.
 
 
Cooking max sensible gain ( individual gain )
General room variables ( 2.3.2.2 )
CookingMaxSensibleGainRoomTotal
CookingMaxSensibleGainIndividualGain
 
Value Increase
Value Decrease
Value Replacement
 
This is a property for cooking internal gain.
Update the value of an individual cooking internal gain.
 
No change will be made if the resulting value is out of the valid range [-5000000, 5000000]. Errors will be logged into the log file.
 
If successful updated the value, the Input mode Template check box should be unticked and the maximum power consumption will be updated by total up the max sensible gain and maximum latent gain.
 
 
 
 
Cooking max sensible gain ( room total )
General room variables ( 2.3.2.2 )
CookingMaxSensibleGainRoomTotal
 
Value Increase
Value Decrease
Value Replacement
 
This is a property for cooking internal gain.
 
If a room has a single cooking internal gain, update the value.
 
If a room has multiple cooking internal gains, update the value of each machinery internal gain proportional to their current absolute value at the same time retain the negative or positive sign.
 
 
No change will be made if the resulting value of any of the cooking internal gains is out of the valid range [-5000000, 5000000]. Errors will be logged into the log file.
 
If successful updated the value, the Input mode Template check box should be unticked and the maximum power consumption will be updated by total up the max sensible gain and maximum latent gain.
 
 
Lighting installed power density ( individual gain )
General room variables ( 2.3.2.2 )
LightingInstalledPowerDensityRoomTotal
LightingInstalledPowerDensityIndividualGain
 
 
Value Increase
Value Decrease
Value Replacement
 
This is a property for lighting internal gain.
Update the value of an individual lighting internal gain if it is in the LUX input mode.
 
No change will be made if the resulting value is out of the valid range [0, 5000000]. Errors will be logged into the log file.
 
If successful updated the value, the Input mode Template check box should be unticked.
 
 
Lighting installed power density ( room total )
General room variables ( 2.3.2.2 )
LightingInstalledPowerDensityRoomTotal
 
Value Increase
Value Decrease
Value Replacement
 
This is a property for lighting internal gain.
 
If a room has a single lighting internal gain in LUX input mode, update the value.
 
If a room has multiple lighting internal gains that are in the LUX input mode, update the value of each computers internal gain proportional to their current value.
 
No change will be made if the resulting value of any of the lighting internal gains is out of the valid range [-5000000, 5000000]. Errors will be logged into the log file.
 
If successful updated the value, the Input mode Template check box should be unticked.
 
 
Lighting max illuminance ( individual gain )
General room variables ( 2.3.2.2 )
LightingMaxIlluminanceRoomTotal
LightingMaxIlluminanceIndividualGain
 
 
Value Increase
Value Decrease
Value Replacement
 
This is a property for lighting internal gain.
 
Update the value of an individual lighting internal gain if it is in the LUX input model.
 
No change will be made if the resulting value is out of the valid range [0, 5000000]. Errors will be logged into the log file.
 
If successful updated the value, the Input mode Template check box should be unticked.
 
 
Lighting max illuminance ( room total )
General room variables ( 2.3.2.2 )
LightingMaxIlluminanceRoomTotal
 
Value Increase
Value Decrease
Value Replacement
 
This is a property for lighting internal gain.
 
If a room has a single lighting internal gain that is in LUX input mode, update the value.
 
If a room has multiple lighting internal gains in LUX input mode, update the value of each computers internal gain proportional to their current value.
 
No change will be made if the resulting value of any of the lighting internal gains is out of the valid range [-5000000, 5000000]. Errors will be logged into the log file.
 
If successful updated the value, the Input mode Template check box should be unticked.
 
 
Lighting max sensible gain ( individual gain )
General room variables ( 2.3.2.2 )
LightingMaxSensibleGainRoomTotal
LightingMaxSensibleGainIndividualGain
 
Value Increase
Value Decrease
Value Replacement
 
This is a property for lighting internal gain.
Update the value of an individual lighting internal gain if it is NOT in the LUX input mode.
 
No change will be made if the resulting value is out of the valid range [0, 5000000]. Errors will be logged into the log file.
 
If successful updated the value, the Input mode Template check box should be unticked and the maximum power consumption will be updated to the same value as the max sensible gain.
 
 
Lighting max sensible gain ( room total )
General room variables ( 2.3.2.2 )
LightingMaxSensibleGainRoomTotal
 
Value Increase
Value Decrease
Value Replacement
 
This is a property for lighting internal gain.
 
If a room has a single lighting internal gain that is NOT in the LUX input mode, update the value.
 
If a room has multiple lighting internal gains that are NOT in the LUX input mode, update the value of each computers internal gain proportional to their current value.
 
No change will be made if the resulting value of any of the lighting internal gains is out of the valid range [-5000000, 5000000]. Errors will be logged into the log file.
 
If successful updated the value, the Input mode Template check box should be unticked and the maximum power consumption will be updated to the same value as the max sensible gain.
 
 
Machinery max sensible gain ( individual gain )
General room variables ( 2.3.2.2 )
MachineryMaxSensibleGainRoomTotal
MachineryMaxSensibleGainIndividualGain
 
Value Increase
Value Decrease
Value Replacement
 
This is a property for machinery internal gain.
Update the value of an individual machinery internal gain.
 
No change will be made if the resulting value is out of the valid range [-5000000, 5000000]. Errors will be logged into the log file.
 
If successful updated the value, the Input mode Template check box should be unticked and the maximum power consumption will be updated by total up the max sensible gain and maximum latent gain.
 
 
 
 
Machinery max sensible gain ( room total )
General room variables ( 2.3.2.2 )
MachineryMaxSensibleGainRoomTotal
 
Value Increase
Value Decrease
Value Replacement
 
This is a property for machinery internal gain.
 
If a room has a single machinery internal gain, update the value.
 
If a room has multiple machinery internal gains, update the value of each machinery internal gain proportional to their current absolute value at the same time retain the negative or positive sign.
 
No change will be made if the resulting value of any of the machinery internal gains is out of the valid range [-5000000, 5000000]. Errors will be logged into the log file.
 
If successful updated the value, the Input mode Template check box should be unticked and the maximum power consumption will be updated by total up the max sensible gain and maximum latent gain.
 
 
Misc internal gain ( individual )
General room variables ( 2.3.2.2 )
MiscInternalGainIndividual
 
Replace the first qualified gain that is user edited instead of template assigned, and retain the other gains.
 
Note this operation will fail if the replacement will result in two identical gains both being included in a room.
 
Misc internal gain ( room )
General room variables ( 2.3.2.2 )
Replace room level misc internal gain.
This variable only affects the user-edited misc internal gain. Template assigned gains will not be affected.
 
If a room has a single a misc internal gain that is user edited, replace it.
 
If a room has multiple user-edited misc internal gains, replace the first user-edited misc internal gain in the list of gains of the given room with the target misc internal gain, then remove all the rest of the user-edited misc internal gain from the room.
 
Note this operation will fail if the replacement will result in two identical gains both being included in a room.
 
Misc max sensible gain ( individual gain )
General room variables ( 2.3.2.2 )
MiscMaxSensibleGainRoomTotal
MiscMaxSensibleGainIndividualGain
 
Value Increase
Value Decrease
Value Replacement
 
This is a property for misc. internal gain.
Update the value of an individual misc. internal gain.
 
No change will be made if the resulting value is out of the valid range [-5000000, 5000000]. Errors will be logged into the log file.
 
If successful updated the value, the Input mode Template check box should be unticked and the maximum power consumption will be updated by total up the max sensible gain and maximum latent gain.
 
 
 
 
Misc max sensible gain ( room total )
General room variables ( 2.3.2.2 )
MiscMaxSensibleGainRoomTotal
 
Value Increase
Value Decrease
Value Replacement
 
This is a property for misc. internal gain.
 
If a room has a single misc. internal gain, update the value.
 
If a room has multiple misc. internal gains, update the value of each machinery internal gain proportional to their current absolute value at the same time retain the negative or positive sign.
 
No change will be made if the resulting value of any of the misc. internal gains is out of the valid range [-5000000, 5000000]. Errors will be logged into the log file.
 
If successful updated the value, the Input mode Template check box should be unticked and the maximum power consumption will be updated by total up the max sensible gain and maximum latent gain.
 
 
People max sensible gain ( individual gain )
General room variables ( 2.3.2.2 )
PeopleMaxSensibleGainRoomTotal
PeopleMaxSensibleGainIndividualGain
 
Value Increase
Value Decrease
Value Replacement
 
This is a property for people internal gain.
Update the value of an individual people internal gain.
 
No change will be made if the resulting value is out of the valid range [0, 5000000]. Errors will be logged into the log file.
 
If successful updated the value, the Input mode Template check box should be unticked.
 
 
 
 
People max sensible gain ( room total )
General room variables ( 2.3.2.2 )
PeopleMaxSensibleGainRoomTotal
 
Value Increase
Value Decrease
Value Replacement
 
This is a property for people internal gain.
 
If a room has a single people internal gain, update the value.
 
If a room has multiple people internal gains, update the value of each people internal gain proportional to their current value.
 
No change will be made if the resulting value of any of the people internal gains is out of the valid range [-5000000, 5000000]. Errors will be logged into the log file.
 
If successful updated the value, the Input mode Template check box should be unticked.
 
 
People occupancy ( individual gain )
General room variables ( 2.3.2.2 )
PeopleOccupancyRoomTotal
PeopleOccupancyIndividualGain
 
 
Value Increase
Value Decrease
Value Replacement
 
This is a property for people internal gain.
Update the value of an individual people internal gain.
 
No change will be made if the resulting value is out of the valid range [ 0, 1e+006] when using unit people or [ 0, 1e+007] when using unit m2/people, error will be logged in the log file.
 
If successful updated the value, the Input mode Template check box should be unticked.
 
 
 
 
People occupancy ( room total )
General room variables ( 2.3.2.2 )
PeopleOccupancyRoomTotal
 
Value Increase
Value Decrease
Value Replacement
 
This is a property for people internal gain.
 
If a room has a single people internal gain, update the value.
 
If a room has multiple people internal gains, update the value of each people internal gain proportional to their current value.
 
Any errors will be logged into the log file.
 
If successful updated the value, the Input mode Template check box should be unticked.
 
 
 
Internal gains (non-template assignments)
 
 
Computers internal gain ( individual non-template )
General room variables ( 2.3.2.2 )
ComputersInternalGainIndividual
 
Replace the first qualified gain that is user edited instead of template assigned, and retain the other gains.
 
Note this operation will fail if the replacement will result in two identical gains both being included in a room.
 
Computers internal gain ( room non-template )
General room variables ( 2.3.2.2 )
Replace room level computers internal gain.
This variable only affects the user-edited computers internal gain. Template assigned gains will not be affected.
 
If a room has a single a computer internal gain that is user edited, replace it.
 
If a room has multiple user-edited computers internal gains, replace the first user-edited computers internal gain in the list of gains of the given room with the target computers internal gain, then remove all the rest of the user-edited computers internal gain from the room.
 
Note this operation will fail if the replacement will result in two identical gains both being included in a room.
 
Cooking internal gain ( individual non-template )
General room variables ( 2.3.2.2 )
CookingInternalGainIndividual
 
Replace the first qualified gain that is user edited instead of template assigned, and retain the other gains.
 
Note this operation will fail if the replacement will result in two identical gains both being included in a room.
 
Cooking internal gain ( room non-template )
General room variables ( 2.3.2.2 )
Replace room level cooking internal gain.
This variable only affects the user-edited cooking internal gain. Template assigned gains will not be affected.
 
If a room has a single a cooking internal gain that is user edited, replace it.
 
If a room has multiple user-edited cooking internal gains, replace the first user-edited cooking internal gain in the list of gains of the given room with the target cooking internal gain, then remove all the rest of the user-edited cooking internal gain from the room.
 
Note this operation will fail if the replacement will result in two identical gains both being included in a room.
 
Lighting internal gain ( individual non-template )
General room variables ( 2.3.2.2 )
LightingInternalGainIndividual
 
 
Replace the first qualified gain that is user edited instead of template assigned, and retain the other gains.
 
Note this operation will fail if the replacement will result in two identical gains both being included in a room.
 
Lighting internal gain ( room non-template  )
General room variables ( 2.3.2.2 )
Replace room level lighting internal gain.
This variable only affects the user-edited lighting internal gain. Template assigned gains will not be affected.
 
If a room has a single a lighting internal gain that is user edited, replace it.
 
If a room has multiple user-edited lighting internal gains, replace the first user-edited lighting internal gain in the list of gains of the given room with the target lighting internal gain, then remove all the rest of the user-edited lighting internal gain from the room.
 
Note this operation will fail if the replacement will result in two identical gains both being included in a room.
 
Machinery internal gain ( individual non-template )
General room variables ( 2.3.2.2 )
MachineryInternalGainIndividual
 
Replace the first qualified gain that is user edited instead of template assigned, and retain the other gains.
 
Note this operation will fail if the replacement will result in two identical gains both being included in a room.
 
Machinery internal gain ( room non-template )
General room variables ( 2.3.2.2 )
Replace room level machinery internal gain.
This variable only affects the user-edited machinery internal gain. Template assigned gains will not be affected.
 
If a room has a single a machinery internal gain that is user edited, replace it.
 
If a room has multiple user-edited machinery internal gains, replace the first user-edited machinery internal gain in the list of gains of the given room with the target machinery internal gain, then remove all the rest of the user-edited machinery internal gain from the room.
 
Note this operation will fail if the replacement will result in two identical gains both being included in a room.
 
People internal gain ( individual non-template )
General room variables ( 2.3.2.2 )
PeopleInternalGainIndividual
 
Replace the first qualified gain that is user edited instead of template assigned, and retain the other gains.
 
Note this operation will fail if the replacement will result in two identical gains both being included in a room.
People internal gain ( room non-template )
General room variables ( 2.3.2.2 )
Replace room level people internal gain.
This variable only affects the user-edited people internal gain. Template assigned gains will not be affected.
 
If a room has a single a people internal gain that is user edited, replace it.
 
If a room has multiple user-edited people internal gains, replace the first user-edited people internal gain in the list of gains of the given room with the target people internal gain, then remove all the rest of the user-edited people internal gain from the room.
 
Note this operation will fail if the replacement will result in two identical gains both being included in a room.
 
Macroflo
 
Max angle opening
General room variables ( 2.3.2.2 )
General surface variables ( 2.3.2.3 )
General opening variables ( 2.3.2.4 )
MaxAngleOpening
 
Value Increase
Value Decrease
Value Replacement
 
This is a macroflo opening property when opening category is within certain categories (see table below for relevant categories).
 
Update the max angle opening of all macroflo openings that satisfy the selection criteria.
 
No change will be made if the resulting value is out of the valid range for a relevant category (see table below). Error will be logged in the log file.
 
Valid value range against each relevant opening category:
 
Opening Category
Max Angle
Open Range
Window / door - side hung
[10,90]
Window - centre hung
[15,90]
Window - top hung
[10,90]
Window - btm hung
[10,90]
Parallel hung windows / flap
[15,90]
 
 
The mechanism for modifying the application object (section 2.2.1 ) will apply.
 
Openable area percentage
General room variables ( 2.3.2.2 )
General surface variables ( 2.3.2.3 )
General opening variables ( 2.3.2.4 )
OpenableAreaPercentage
 
Value Increase
Value Decrease
Value Replacement
 
This is a macroflo opening property.
 
Update the openable area percentage of all macroflo openings that satisfy the selection criteria.
 
No change will be made if the resulting value is out of the valid range [0, 5000], error will be logged in the log file.
 
The mechanism for modifying the application object (section 2.2.1 ) will apply.
 
Opening variation profile
General room variables ( 2.3.2.2 )
General surface variables ( 2.3.2.3 )
General opening variables ( 2.3.2.4 )
OpeningVariationProfile
 
Replace the opening variation profile of all macroflo openings that satisfy the selection criteria with any modulating profiles in the model.
 
The mechanism for modifying the application object (section 2.2.1 ) will apply.
 
External window
General room variables ( 2.3.2.2 )
General glazed construction variables ( 2.3.2.6 2.3.2.7 )
General surface variables ( 2.3.2.3 )
ConstructionExtWindow
 
“Replace Macroflo Opening Type”
 
See section 2.2 for details on the operation.
External door
General room variables ( 2.3.2.2 )
General opaque construction variables ( 2.3.2.6 )
General surface variables ( 2.3.2.3 )
ConstructionExtDoor
 
“Replace Macroflo Opening Type”
 
See section 2.2 for details on the operation.
 
Roof light
General room variables ( 2.3.2.2 )
General glazed construction variables ( 2.3.2.6 2.3.2.7 )
General surface variables ( 2.3.2.3 )
ConstructionRoofLight
 
“Replace Macroflo Opening Type”
 
See section 2.2 for details on the operation.
 
Renewables
 
 
 
Replace each individual people internal gain.
If a room has multiple people internal gains, replace each of them.
 
Solar panel area
SolarPanelArea
 
Value Increase
Value Decrease
Value Replacement
 
This is a model PV level property.
 
Update the solar panel area of all PVs that satisfy the selection criteria.
 
No change will be made if the resulting value is out of the valid range [0, 5000], error will be logged in the log file.
 
Solar panel azimuth
SolarPanelAzimuth
 
Value Increase
Value Decrease
Value Replacement
 
This is a model PV level property.
 
Update the solar panel azimuth of all PVs that satisfy the selection criteria.
 
No change will be made if the resulting value is out of the valid range [0, 360], error will be logged in the log file.
 
Solar panel inclination
SolarPanelInclination
 
Value Increase
Value Decrease
Value Replacement
 
This is a model PV level property.
 
Update the solar panel inclination of all PVs that satisfy the selection criteria.
 
No change will be made if the resulting value is out of the valid range [0, 360], error will be logged in the log file.
 
Wind generator rated power kW
WindGeneratorRatedPowerKW
 
Value Increase
Value Decrease
Value Replacement
 
This is a model Wind level property.
 
Update the wind generator rated power kW of the wind generator if it satisfies the selection criteria.
 
No change will be made if the resulting value is out of the valid range [0, 1000000], error will be logged in the log file.
 
 
Room conditions
 
Aux energy profile
General room variables ( 2.3.2.2 )
AuxEnergyProfile
 
Replace the auxiliary energy profile of all rooms satisfying the selection criteria with any modulating profiles in the model.
 
Cooling profile
General room variables ( 2.3.2.2 )
CoolingProfile
 
Replace the cooling profile of all rooms satisfying the selection criteria with any modulating profiles in the model.
 
Cooling setpoint ( constant )
General room variables ( 2.3.2.2 )
CoolingSetpointConstant
 
Value Increase
Value Decrease
Value Replacement
 
This is a room property.
Update the value.
No change will be made if the resulting value is out of the valid range [-100, 100], error will be logged in the log file.
 
If value update succeeds, untick Template check box. Otherwise, no change should be made.
 
Cooling setpoint ( timed )
General room variables ( 2.3.2.2 )
CoolingSetpointTimed
 
Replace the cooling setpoint timed profile of all rooms satisfying the selection criteria with any absolute profiles in the model.
DHW consumption
General room variables ( 2.3.2.2 )
DHWConsumption
 
Value Increase
Value Decrease
Value Replacement
 
This is a room property.
Update the value.
No change will be made if the resulting value is out of the valid range [0, 10000], error will be logged in the log file.
 
If value update succeeds, untick Template check box. Otherwise, no change should be made.
 
DHW profile
General room variables ( 2.3.2.2 )
DHWProfile
 
Replace the DHW profile of all rooms satisfying the selection criteria with any modulating profiles in the model.
Furniture mass factor
General room variables ( 2.3.2.2 )
FurnitureMassFactor
 
Value Increase
Value Decrease
Value Replacement
 
This is a room property.
Update the value.
 
Any errors occurred will be logged in the log file.
 
If value update succeeds, untick Template check box. Otherwise, no change should be made.
 
Heating profile
 
 
Heating setpoint ( constant )
General room variables ( 2.3.2.2 )
HeatingSetpointConstant
 
Value Increase
Value Decrease
Value Replacement
 
This is a room property.
Update the value.
No change will be made if the resulting value is out of the valid range [-100, 100], error will be logged in the log file.
 
If value update succeeds, untick Template check box. Otherwise, no change should be made.
 
Heating setpoint ( timed )
General room variables ( 2.3.2.2 )
HeatingSetpointTimed
 
Replace the heating setpoint timed profile of all rooms satisfying the selection criteria with any absolute profiles in the model.
Humidity control max
General room variables ( 2.3.2.2 )
HumidityControlMax
 
Value Increase
Value Decrease
Value Replacement
 
This is a room property.
Update the value.
No change will be made if the resulting value is out of the valid range [0, 100] or lower than the Humility control min value, error will be logged in the log file.
 
If value update succeeds, untick Template check box. Otherwise, no change should be made.
 
Humidity control min
General room variables ( 2.3.2.2 )
HumidityControlMin
 
Value Increase
Value Decrease
Value Replacement
 
This is a room property.
Update the value.
No change will be made if the resulting value is out of the valid range [0, 100] or higher than the Humility control high value, error will be logged in the log file.
 
If value update succeeds, untick Template check box. Otherwise, no change should be made.
 
Solar reflected fraction
General room variables ( 2.3.2.2 )
SolarReflectedFraction
 
Value Increase
Value Decrease
Value Replacement
 
This is a room property.
Update the value.
Any errors occurred will be logged in the log file.
 
If value update succeeds, untick Template check box. Otherwise, no change should be made.
 
 
Shading ( cdb )
 
Projections overhang projection
General room variables ( 2.3.2.2 )
General surface variables ( 2.3.2.3 )
ConstructionExtWindow
ProjectionsOverhangProjection
 
Value Increase
Value Decrease
Value Replacement
 
This is an external window property.
Only make the update to an external window if its local shading device setting is “Projections”.
 
If an external window satisfies the above criteria and the filtering criteria, update its overhang projection.
 
No change will be made if the resulting value is out of the valid range [0, 100], error will be logged in the log file.
 
If value update is successful, set the overhang Offset to be 0.
 
 
The mechanism for modifying the application object (section 2.2.1 ) will apply.
 
Recess depth
General room variables ( 2.3.2.2 )
General surface variables ( 2.3.2.3 )
ConstructionExtWindow
RecessDepth
 
Value Increase
Value Decrease
Value Replacement
 
This is an external window property.
Only make the update to an external window if its local shading device setting is “Recess”.
 
If an external window satisfies the above criteria and the filtering criteria, update its overhang projection, left fin projection and right fin projection.
 
No change will be made if any resulting value is out of the valid range [0, 100], error will be logged in the log file.
 
If value update is successful, set the overhang Offset, left fin offset and right fin offset to be 0.
 
The mechanism for modifying the application object (section 2.2.1 ) will apply.
 
Recess left fin projection
General room variables ( 2.3.2.2 )
General surface variables ( 2.3.2.3 )
ConstructionExtWindow
RecessLeftFinProjection
 
Value Increase
Value Decrease
Value Replacement
 
This is an external window property.
Only make the update to an external window if its local shading device setting is “Recess”.
 
If an external window satisfies the above criteria and the filtering criteria, update its left fin projection.
 
No change will be made if any resulting value is out of the valid range [0, 100], error will be logged in the log file.
 
If value update is successful, set the left fin offset to be 0.
 
The mechanism for modifying the application object (section 2.2.1 ) will apply.
 
Recess overhang projection
General room variables ( 2.3.2.2 )
General surface variables ( 2.3.2.3 )
ConstructionExtWindow
RecessOverhangProjection
 
Value Increase
Value Decrease
Value Replacement
 
This is an external window property.
Only make the update to an external window if its local shading device setting is “Recess”.
 
If an external window satisfies the above criteria and the filtering criteria, update its overhang projection.
 
No change will be made if any resulting value is out of the valid range [0, 100], error will be logged in the log file.
 
If value update is successful, set the overhang offset to be 0.
 
The mechanism for modifying the application object (section 2.2.1 ) will apply.
 
Recess right fin projection
General room variables ( 2.3.2.2 )
General surface variables ( 2.3.2.3 )
ConstructionExtWindow
RecessRightFinProjection
 
Value Increase
Value Decrease
Value Replacement
 
This is an external window property.
Only make the update to an external window if its local shading device setting is “Recess”.
 
If an external window satisfies the above criteria and the filtering criteria, update its right fin projection.
 
No change will be made if any resulting value is out of the valid range [0, 100], error will be logged in the log file.
 
If value update is successful, set the right fin offset to be 0.
 
The mechanism for modifying the application object (section 2.2.1 ) will apply.
 
 
Surface objects
 
Windows
General room variables ( 2.3.2.2 )
General surface variables ( 2.3.2.3 )
 
Add Ext. Glazing by Percentage Area (Remove Existing Glazing)
Add Ext. Glazing by Percentage Area (Keep Existing Glazing)
 
Both operations will add the specified percentage of glazing on external surfaces (including the ground floor) satisfying the filtering criteria. The different is that the first operation will remove the existing glazing on those affected surfaces while the second operation will retain the existing glazing on those surfaces.
 
No change will be made if any resulting value is out of the valid range [0, 100], error will be logged in the log file.