×
Menu
Index

Formula variables

 
Note: greyed out variables are the ones that have not been implemented in this version.
General building level variables
Variable
Operators
2nd operands
RoomActivity
 
 
BuildingType
 
 
 
General room variables
Variable
Operators
2nd operands
RoomName
Contains
A string
RoomID
Is
Any room id in the model
RoomArea
All value operators
A value
RoomVolume
All value operators
A value
RoomAvgHeight
All value operators
A value
RoomGroup
Is
Any defined room group in the model
CurSelRooms
N/A
N/A
General surface variables
Variable
Operators
2nd operands
SurfaceArea
All value operators
A value
SurfaceType
Is
One of the following value:
"Floor [ 0 ]"
"Ceiling [ 1 ]"
"Wall [ 2 ]"
SurfaceWidth
All value operators
A value
SurfaceHeight
All value operators
A value
SurfaceOrientation
All value operators
A value
SurfaceAngle
All value operators
A value
SurfaceAzimuth
All value operators
A value
SurfaceTilt
All value operators
A value
 
General opening variables
Variable
Operators
2nd operands
OpeningWidth
All value operators
A value
OpeningHeight
All value operators
A value
OpeningArea
All value operators
A value
MacrofloOpeningType
Is
All macroflo opening type in the model in the following format:
“Description [ ID ]”
OpeningType
Is
One of the following value:
"Rooflight [ 5 ]"
"External glazing [ 6 ]"
“Internal Glazing [ 7 ]”
"Door [ 8 ]"
 
General apache system variables
Variable
Operators
2nd operands
ApacheSystemName
Is
Any apache system name in the model
ApacheSystemID
Is
Any apache system id in the model
 
General Opaque construction variables
Variable
Operators
2nd operands
UValue
All value operators
A value
TotalRValue
All value operators
A value
ThermalMassCm
All value operators
A value
 
 
General Glazed construction variables
Variable
Operators
2nd operands
UValueGlassOnly
All value operators
A value
NetUValue
All value operators
A value
NetRValue
All value operators
A value
VisibleLightNormalTransmittance
All value operators
A value
gValueEN410
All value operators
A value
 
 General Internal gain variables (not used)
Variable
Operators
2nd operands
InternalGainReference
Is
Any internal gains references in the model.
 
 
  General Air exchange variables (not used)
Variable
Operators
2nd operands
AirExchangeReference
Is
Any air exchange references in the model.
 
Model variables
Variable
Operators
2nd operands and variable details
 
Air exchange profile
 
AuxiliaryVariationProfile
Is
All the auxiliary variation profiles in the model in the following format:
 
“Label [ profileID ]”
InfiltrationVariationProfile
Is
All the infiltration variation profiles in the model in the following format:
 
“Label [ profileID ]”
NaturalVariationProfile
Is
All the natural variation profiles in the model in the following format:
 
“Label [ profileID ]”
 
Air exchange (value)
 
AuxiliaryAdjacentCondition
Is
 
The auxiliary adjacent condition types exist in the model in the following format:
“Description [ index ]”
AuxiliaryMaxFlowIndividualAirExchange
All value operators
A value
This variable deals with the max flow for an individual auxiliary air exchange, and compares against the value specified in the 2nd operands.
 
AuxiliaryMaxFlowRoomTotal
All value operators
A value
This variable with the total max flow of all auxiliary air exchanges in a room, and compares against the value specified in the 2nd operands.
 
InfiltrationAdjacentCondition
Is
 
The infiltration adjacent condition types exist in the model in the following format:
“Description [ index ]”
InfiltrationMaxFlowIndividualAirExchange
All value operators
A value
This variable deals with the max flow for an individual infiltration air exchange, and compares against the value specified in the 2nd operands.
 
InfiltrationMaxFlowRoomTotal
All value operators
A value
This variable with the total max flow of all infiltration air exchanges in a room, and compares against the value specified in the 2nd operands.
 
NaturalAdjacentCondition
Is
The natural adjacent condition types exist in the model in the following format:
“Description [ index ]”
NaturalMaxFlowIndividualAirExchange
All value operators
A value
This variable deals with the max flow for an individual natural air exchange, and compares against the value specified in the 2nd operands.
 
NaturalMaxFlowRoomTotal
All value operators
A value
This variable with the total max flow of all natural air exchanges in a room, and compares against the value specified in the 2nd operands.
 
 
Air exchange individual
 
AuxiliaryAirExchangeIndividual
Is
The auxiliary air exchanges in the model in the following format:
“Reference [ handle ]”
InfiltrationAirExchangeIndividual
Is
The infiltration air exchanges in the model in the following format:
“Reference [ handle ]”
NaturalAirExchangeIndividual
Is
The natural air exchanges in the model in the following format:
“Reference [ handle ]”
 
Apache system
 
ApacheSystem
Is
All the apache systems in the model in the following format:
“Name [ systemID ]”
 
AuxVentSystem
Is
All the auxiliary ventilation systems in the model in the following format:
“Name [ systemID ]”
 
CoolingPlantRadiantFraction
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
CoolingUnitSize
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
DHWSystem
Is
All the DHW systems in the model in the following format:
“Name [ systemID ]”
 
HeatingUnitSize
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
HeatingPlantRadiantFraction
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
SystemAirSupplyFlowRate
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
SystemAirSupplyFreeCoolingFlow
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
SystemAirSupplyVariationProfile
Is
All the system air supply variation profiles in the model in the following format:
 
“Label [ profileID ]”
SystemAuxEnergyWPerM2
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
SystemCoolingFuel
Is
List of cooling fuels used by all the apache systems in the model in the following format:
 
“Name [ fuelType ]”
SystemCoolingNominalEER
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
SystemCoolingSeasonalEER
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
SystemCoolingSSEER
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
SystemHeatRecoveryEffectiveness
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
SystemHeatingFuel
Is
List of heating fuels used by all the apache systems in the model in the following format:
 
“Name [ fuelType ]”
SystemHeatingSCoP
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
SystemHeatingSeasonalEfficiency
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
SystemOffScheduleAuxEnergyWPerM2
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
 
Constructions
 
ConstructionExtDoor
Is
All the external door constructions in the model in the following format:
“Name [ ID ]”
 
ConstructionExtWall
Is
All the external wall constructions in the model in the following format:
“Name [ ID ]”
 
ConstructionExtWindow
Is
All the external window constructions in the model in the following format:
“Name [ ID ]”
 
ConstructionGroundFloor
Is
All the ground floor constructions in the model in the following format:
“Name [ ID ]”
 
ConstructionIntCeilingFloor
Is
All the internal ceiling / floor constructions in the model in the following format:
“Name [ ID ]”
 
ConstructionIntDoor
Is
All the internal door constructions in the model in the following format:
“Name [ ID ]”
 
ConstructionIntWindow
Is
All the internal window constructions in the model in the following format:
“Name [ ID ]”
 
ConstructionPartition
Is
All the partition constructions in the model in the following format:
“Name [ ID ]”
 
ConstructionRoof
Is
All the roof constructions in the model in the following format:
“Name [ ID ]”
 
ConstructionRoofLight
Is
All the roof light constructions in the model in the following format:
“Name [ ID ]”
 
 
General
 
BuildingOrientation
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
GeneralTemplate
Is
The name of all general templates in the model.
ThermalTemplate
Is
The name of all thermal templates in the model.
 
Internal gains (profiles)
 
ComputersVariationProfile
Is
All the computers variation profiles in the model in the following format:
 
“Label [ profileID ]”
CookingVariationProfile
Is
All the cooking variation profiles in the model in the following format:
 
“Label [ profileID ]”
LightingDimmingProfile
Is
All the lighting dimming profiles in the model in the following format:
 
“Label [ profileID ]”
LightingVariationProfile
Is
All the lighting variation profiles in the model in the following format:
 
“Label [ profileID ]”
MachineryVariationProfile
Is
All the machinery variation profiles in the model in the following format:
 
“Label [ profileID ]”
MiscVariationProfile
Is
All the misc variation profiles in the model in the following format:
 
“Label [ profileID ]”
PeopleVariationProfile
Is
All the people variation profiles in the model in the following format:
 
“Label [ profileID ]”
 
Internal gains (values)
 
ComputersMaxSensibleGainIndividualGain
All value operators
A value
This variable deals with the max sensible gain for an individual computer internal gain, and compares against the value specified in the 2nd operands.
 
ComputersMaxSensibleGainRoomTotal
All value operators
A value
This variable with the total max sensible gain of all computer internal gains in a room, and compares against the value specified in the 2nd operands.
 
CookingMaxSensibleGainIndividualGain
All value operators
A value
This variable deals with the max sensible gain for an individual cooking internal gain, and compares against the value specified in the 2nd operands.
 
CookingMaxSensibleGainRoomTotal
All value operators
A value
This variable with the total max sensible gain of all cooking internal gains in a room, and compares against the value specified in the 2nd operands.
 
LightingInstalledPowerDensityIndividualGain
All value operators
A value
This variable deals with the installed power density for an individual lighting internal gain, and compares against the value specified in the 2nd operands.
 
LightingInstalledPowerDensityRoomTotal
All value operators
A value
This variable with the total installed power density of all lighting internal gains in a room, and compares against the value specified in the 2nd operands.
 
LightingMaxIlluminanceIndividualGain
All value operators
A value
This variable deals with the max illuminance for an individual lighting internal gain, and compares against the value specified in the 2nd operands.
 
LightingMaxIlluminanceRoomTotal
All value operators
A value
This variable with the total max illuminance of all lighting internal gains in a room, and compares against the value specified in the 2nd operands.
 
LightingMaxSensibleGainIndividualGain
All value operators
A value
This variable deals with the max sensible gain for an individual lighting internal gain, and compares against the value specified in the 2nd operands.
 
LightingMaxSensibleGainRoomTotal
All value operators
A value
This variable with the total max sensible gain of all lighting internal gains in a room, and compares against the value specified in the 2nd operands.
 
MachineryMaxSensibleGainIndividualGain
All value operators
A value
This variable deals with the max sensible gain for an individual machinery internal gain, and compares against the value specified in the 2nd operands.
 
MachineryMaxSensibleGainRoomTotal
All value operators
A value
This variable with the total max sensible gain of all machinery internal gains in a room, and compares against the value specified in the 2nd operands.
 
MiscMaxSensibleGainIndividualGain
All value operators
A value
This variable deals with the max sensible gain for an individual misc. internal gain, and compares against the value specified in the 2nd operands.
 
MiscMaxSensibleGainRoomTotal
All value operators
A value
This variable with the total max sensible gain of all misc. internal gains in a room, and compares against the value specified in the 2nd operands.
 
PeopleMaxSensibleGainIndividualGain
All value operators
A value
This variable deals with the max sensible gain for an individual people internal gain, and compares against the value specified in the 2nd operands.
 
PeopleMaxSensibleGainRoomTotal
All value operators
A value
This variable with the total max sensible gain of all people internal gains in a room, and compares against the value specified in the 2nd operands.
 
PeopleOccupancyIndividualGain
All value operators
A value
This variable deals with the people occupancy for an individual people internal gain, and compares against the value specified in the 2nd operands.
 
PeopleOccupancyRoomTotal
All value operators
A value
This variable with the total people occupancy of all people internal gains in a room, and compares against the value specified in the 2nd operands.
 
 
Internal gains individual
 
ComputersInternalGainIndividual
Is
The computer internal gains in the model in the following format:
“Reference [ handle ]”
CookingInternalGainIndividual
Is
The cooking internal gains in the model in the following format:
“Reference [ handle ]”
LightingInternalGainIndividual
Is
The lighting internal gains in the model in the following format:
“Reference [ handle ]”
MiscInternalGainIndividual
Is
The misc. internal gains in the model in the following format:
“Reference [ handle ]”
MachineryInternalGainIndividual
Is
The machinery internal gains in the model in the following format:
“Reference [ handle ]”
PeopleInternalGainIndividual
Is
The people internal gains in the model in the following format:
“Reference [ handle ]”
 
 
 
 
Macroflo
 
 
 
MaxAngleOpening
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
OpenableAreaPercentage
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
OpeningVariationProfile
Is
The opening variation profiles assigned to all the openings in the model in the following format:
“Label [ profileID ]”
 
 
Renewables
 
SolarPanelArea
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
SolarPanelAzimuth
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
SolarPanelInclination
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
WindGeneratorRatedPowerKW
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
 
Room conditions
 
AuxEnergyProfile
Is
All the plant (auxiliary energy) profiles assigned in the model in the following format:
“Label [ profileID ]”
 
CoolingProfile
Is
All the cooling profiles assigned in the model in the following format:
“Label [ profileID ]”
 
CoolingSetpointConstant
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
CoolingSetpointTimed
Is
All the profiles assigned to the cooling setpoint ( timed ) in the model in the following format:
“Label [ profileID ]”
 
DHWConsumption
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
DHWProfile
Is
All the profiles assigned to DHW pattern of use in the model in the following format:
“Label [ profileID ]”
 
FurnitureMassFactor
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
HeatingProfile
Is
All the heating profiles assigned in the model in the following format:
“Label [ profileID ]”
 
HeatingSetpointConstant
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
HeatingSetpointTimed
Is
All the profiles assigned to the heating setpoint ( timed ) in the model in the following format:
“Label [ profileID ]”
 
HumidityControlMax
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
HumidityControlMin
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
SolarReflectedFraction
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
 
Shade (cdb)
 
ProjectionsOverhangProjection
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
RecessLeftFinProjection
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
RecessOverhangProjection
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.
 
RecessRightFinProjection
All value operators
 
A value
 
This is to be compared against the value specified in the 2nd operands.