{
"openapi": "3.0.2",
"servers": [],
"info": {
"description": "Documentation for Honeybee model schema",
"version": "2.0.4",
"title": "Honeybee Model Schema",
"contact": {
"name": "Ladybug Tools",
"email": "info@ladybug.tools",
"url": "https://github.com/ladybug-tools/honeybee-schema"
},
"x-logo": {
"url": "https://www.ladybug.tools/assets/img/honeybee-large.png",
"altText": "Honeybee logo"
},
"license": {
"name": "BSD",
"url": "https://github.com/ladybug-tools-in2/honeybee-schema/blob/master/LICENSE"
}
},
"externalDocs": {
"description": "OpenAPI Specification with Inheritance",
"url": "./model_inheritance.json"
},
"tags": [
{
"name": "afncrack_model",
"x-displayName": "AFNCrack",
"description": "\n"
},
{
"name": "adiabatic_model",
"x-displayName": "Adiabatic",
"description": "\n"
},
{
"name": "airboundaryconstruction_model",
"x-displayName": "AirBoundaryConstruction",
"description": "\n"
},
{
"name": "airboundaryconstructionabridged_model",
"x-displayName": "AirBoundaryConstructionAbridged",
"description": "\n"
},
{
"name": "allaireconomizertype_model",
"x-displayName": "AllAirEconomizerType",
"description": "\n"
},
{
"name": "aperture_model",
"x-displayName": "Aperture",
"description": "\n"
},
{
"name": "apertureconstructionset_model",
"x-displayName": "ApertureConstructionSet",
"description": "\n"
},
{
"name": "apertureconstructionsetabridged_model",
"x-displayName": "ApertureConstructionSetAbridged",
"description": "\n"
},
{
"name": "apertureenergypropertiesabridged_model",
"x-displayName": "ApertureEnergyPropertiesAbridged",
"description": "\n"
},
{
"name": "aperturemodifierset_model",
"x-displayName": "ApertureModifierSet",
"description": "\n"
},
{
"name": "aperturemodifiersetabridged_model",
"x-displayName": "ApertureModifierSetAbridged",
"description": "\n"
},
{
"name": "aperturepropertiesabridged_model",
"x-displayName": "AperturePropertiesAbridged",
"description": "\n"
},
{
"name": "apertureradiancepropertiesabridged_model",
"x-displayName": "ApertureRadiancePropertiesAbridged",
"description": "\n"
},
{
"name": "autocalculate_model",
"x-displayName": "Autocalculate",
"description": "\n"
},
{
"name": "autosize_model",
"x-displayName": "Autosize",
"description": "\n"
},
{
"name": "bsdf_model",
"x-displayName": "BSDF",
"description": "\n"
},
{
"name": "basemodifierset_model",
"x-displayName": "BaseModifierSet",
"description": "\n"
},
{
"name": "basemodifiersetabridged_model",
"x-displayName": "BaseModifierSetAbridged",
"description": "\n"
},
{
"name": "baseboard_model",
"x-displayName": "Baseboard",
"description": "\n"
},
{
"name": "baseboardequipmenttype_model",
"x-displayName": "BaseboardEquipmentType",
"description": "\n"
},
{
"name": "buildingtype_model",
"x-displayName": "BuildingType",
"description": "\n"
},
{
"name": "color_model",
"x-displayName": "Color",
"description": "\n"
},
{
"name": "constructionset_model",
"x-displayName": "ConstructionSet",
"description": "\n"
},
{
"name": "constructionsetabridged_model",
"x-displayName": "ConstructionSetAbridged",
"description": "\n"
},
{
"name": "controltype_model",
"x-displayName": "ControlType",
"description": "\n"
},
{
"name": "datedbasemodel_model",
"x-displayName": "DatedBaseModel",
"description": "\n"
},
{
"name": "daylightingcontrol_model",
"x-displayName": "DaylightingControl",
"description": "\n"
},
{
"name": "detailedhvac_model",
"x-displayName": "DetailedHVAC",
"description": "\n"
},
{
"name": "door_model",
"x-displayName": "Door",
"description": "\n"
},
{
"name": "doorconstructionset_model",
"x-displayName": "DoorConstructionSet",
"description": "\n"
},
{
"name": "doorconstructionsetabridged_model",
"x-displayName": "DoorConstructionSetAbridged",
"description": "\n"
},
{
"name": "doorenergypropertiesabridged_model",
"x-displayName": "DoorEnergyPropertiesAbridged",
"description": "\n"
},
{
"name": "doormodifierset_model",
"x-displayName": "DoorModifierSet",
"description": "\n"
},
{
"name": "doormodifiersetabridged_model",
"x-displayName": "DoorModifierSetAbridged",
"description": "\n"
},
{
"name": "doorpropertiesabridged_model",
"x-displayName": "DoorPropertiesAbridged",
"description": "\n"
},
{
"name": "doorradiancepropertiesabridged_model",
"x-displayName": "DoorRadiancePropertiesAbridged",
"description": "\n"
},
{
"name": "economizertype_model",
"x-displayName": "EconomizerType",
"description": "\n"
},
{
"name": "electricequipment_model",
"x-displayName": "ElectricEquipment",
"description": "\n"
},
{
"name": "electricequipmentabridged_model",
"x-displayName": "ElectricEquipmentAbridged",
"description": "\n"
},
{
"name": "electricloadcenter_model",
"x-displayName": "ElectricLoadCenter",
"description": "\n"
},
{
"name": "energybasemodel_model",
"x-displayName": "EnergyBaseModel",
"description": "\n"
},
{
"name": "energymaterial_model",
"x-displayName": "EnergyMaterial",
"description": "\n"
},
{
"name": "energymaterialnomass_model",
"x-displayName": "EnergyMaterialNoMass",
"description": "\n"
},
{
"name": "energymaterialvegetation_model",
"x-displayName": "EnergyMaterialVegetation",
"description": "\n"
},
{
"name": "energywindowframe_model",
"x-displayName": "EnergyWindowFrame",
"description": "\n"
},
{
"name": "energywindowmaterialblind_model",
"x-displayName": "EnergyWindowMaterialBlind",
"description": "\n"
},
{
"name": "energywindowmaterialgas_model",
"x-displayName": "EnergyWindowMaterialGas",
"description": "\n"
},
{
"name": "energywindowmaterialgascustom_model",
"x-displayName": "EnergyWindowMaterialGasCustom",
"description": "\n"
},
{
"name": "energywindowmaterialgasmixture_model",
"x-displayName": "EnergyWindowMaterialGasMixture",
"description": "\n"
},
{
"name": "energywindowmaterialglazing_model",
"x-displayName": "EnergyWindowMaterialGlazing",
"description": "\n"
},
{
"name": "energywindowmaterialshade_model",
"x-displayName": "EnergyWindowMaterialShade",
"description": "\n"
},
{
"name": "energywindowmaterialsimpleglazsys_model",
"x-displayName": "EnergyWindowMaterialSimpleGlazSys",
"description": "\n"
},
{
"name": "evaporativecooler_model",
"x-displayName": "EvaporativeCooler",
"description": "\n"
},
{
"name": "evaporativecoolerequipmenttype_model",
"x-displayName": "EvaporativeCoolerEquipmentType",
"description": "\n"
},
{
"name": "fcu_model",
"x-displayName": "FCU",
"description": "\n"
},
{
"name": "fcuequipmenttype_model",
"x-displayName": "FCUEquipmentType",
"description": "\n"
},
{
"name": "fcuwithdoasabridged_model",
"x-displayName": "FCUwithDOASAbridged",
"description": "\n"
},
{
"name": "fcuwithdoasequipmenttype_model",
"x-displayName": "FCUwithDOASEquipmentType",
"description": "\n"
},
{
"name": "face_model",
"x-displayName": "Face",
"description": "\n"
},
{
"name": "face3d_model",
"x-displayName": "Face3D",
"description": "\n"
},
{
"name": "faceenergypropertiesabridged_model",
"x-displayName": "FaceEnergyPropertiesAbridged",
"description": "\n"
},
{
"name": "facepropertiesabridged_model",
"x-displayName": "FacePropertiesAbridged",
"description": "\n"
},
{
"name": "faceradiancepropertiesabridged_model",
"x-displayName": "FaceRadiancePropertiesAbridged",
"description": "\n"
},
{
"name": "facetype_model",
"x-displayName": "FaceType",
"description": "\n"
},
{
"name": "floorconstructionset_model",
"x-displayName": "FloorConstructionSet",
"description": "\n"
},
{
"name": "floorconstructionsetabridged_model",
"x-displayName": "FloorConstructionSetAbridged",
"description": "\n"
},
{
"name": "floormodifierset_model",
"x-displayName": "FloorModifierSet",
"description": "\n"
},
{
"name": "floormodifiersetabridged_model",
"x-displayName": "FloorModifierSetAbridged",
"description": "\n"
},
{
"name": "forcedairfurnace_model",
"x-displayName": "ForcedAirFurnace",
"description": "\n"
},
{
"name": "fueltypes_model",
"x-displayName": "FuelTypes",
"description": "\n"
},
{
"name": "furnaceequipmenttype_model",
"x-displayName": "FurnaceEquipmentType",
"description": "\n"
},
{
"name": "gasequipment_model",
"x-displayName": "GasEquipment",
"description": "\n"
},
{
"name": "gasequipmentabridged_model",
"x-displayName": "GasEquipmentAbridged",
"description": "\n"
},
{
"name": "gastype_model",
"x-displayName": "GasType",
"description": "\n"
},
{
"name": "gasunitheater_model",
"x-displayName": "GasUnitHeater",
"description": "\n"
},
{
"name": "gasunitheaterequipmenttype_model",
"x-displayName": "GasUnitHeaterEquipmentType",
"description": "\n"
},
{
"name": "glass_model",
"x-displayName": "Glass",
"description": "\n"
},
{
"name": "globalconstructionset_model",
"x-displayName": "GlobalConstructionSet",
"description": "\n"
},
{
"name": "globalmodifierset_model",
"x-displayName": "GlobalModifierSet",
"description": "\n"
},
{
"name": "glow_model",
"x-displayName": "Glow",
"description": "\n"
},
{
"name": "ground_model",
"x-displayName": "Ground",
"description": "\n"
},
{
"name": "iddbasemodel_model",
"x-displayName": "IDdBaseModel",
"description": "\n"
},
{
"name": "iddenergybasemodel_model",
"x-displayName": "IDdEnergyBaseModel",
"description": "\n"
},
{
"name": "iddradiancebasemodel_model",
"x-displayName": "IDdRadianceBaseModel",
"description": "\n"
},
{
"name": "idealairsystemabridged_model",
"x-displayName": "IdealAirSystemAbridged",
"description": "\n"
},
{
"name": "infiltration_model",
"x-displayName": "Infiltration",
"description": "\n"
},
{
"name": "infiltrationabridged_model",
"x-displayName": "InfiltrationAbridged",
"description": "\n"
},
{
"name": "internalmassabridged_model",
"x-displayName": "InternalMassAbridged",
"description": "\n"
},
{
"name": "light_model",
"x-displayName": "Light",
"description": "\n"
},
{
"name": "lighting_model",
"x-displayName": "Lighting",
"description": "\n"
},
{
"name": "lightingabridged_model",
"x-displayName": "LightingAbridged",
"description": "\n"
},
{
"name": "mesh3d_model",
"x-displayName": "Mesh3D",
"description": "\n"
},
{
"name": "metal_model",
"x-displayName": "Metal",
"description": "\n"
},
{
"name": "mirror_model",
"x-displayName": "Mirror",
"description": "\n"
},
{
"name": "model_model",
"x-displayName": "Model",
"description": "\n"
},
{
"name": "modeldoe2properties_model",
"x-displayName": "ModelDoe2Properties",
"description": "\n"
},
{
"name": "modelenergyproperties_model",
"x-displayName": "ModelEnergyProperties",
"description": "\n"
},
{
"name": "modelproperties_model",
"x-displayName": "ModelProperties",
"description": "\n"
},
{
"name": "modelradianceproperties_model",
"x-displayName": "ModelRadianceProperties",
"description": "\n"
},
{
"name": "modifierbase_model",
"x-displayName": "ModifierBase",
"description": "\n"
},
{
"name": "modifierset_model",
"x-displayName": "ModifierSet",
"description": "\n"
},
{
"name": "modifiersetabridged_model",
"x-displayName": "ModifierSetAbridged",
"description": "\n"
},
{
"name": "moduletype_model",
"x-displayName": "ModuleType",
"description": "\n"
},
{
"name": "moisturediffusionmodel_model",
"x-displayName": "MoistureDiffusionModel",
"description": "\n"
},
{
"name": "mountingtype_model",
"x-displayName": "MountingType",
"description": "\n"
},
{
"name": "nolimit_model",
"x-displayName": "NoLimit",
"description": "\n"
},
{
"name": "opaqueconstruction_model",
"x-displayName": "OpaqueConstruction",
"description": "\n"
},
{
"name": "opaqueconstructionabridged_model",
"x-displayName": "OpaqueConstructionAbridged",
"description": "\n"
},
{
"name": "othersidetemperature_model",
"x-displayName": "OtherSideTemperature",
"description": "\n"
},
{
"name": "outdoors_model",
"x-displayName": "Outdoors",
"description": "\n"
},
{
"name": "psz_model",
"x-displayName": "PSZ",
"description": "\n"
},
{
"name": "pszequipmenttype_model",
"x-displayName": "PSZEquipmentType",
"description": "\n"
},
{
"name": "ptac_model",
"x-displayName": "PTAC",
"description": "\n"
},
{
"name": "ptacequipmenttype_model",
"x-displayName": "PTACEquipmentType",
"description": "\n"
},
{
"name": "pvav_model",
"x-displayName": "PVAV",
"description": "\n"
},
{
"name": "pvavequipmenttype_model",
"x-displayName": "PVAVEquipmentType",
"description": "\n"
},
{
"name": "pvproperties_model",
"x-displayName": "PVProperties",
"description": "\n"
},
{
"name": "people_model",
"x-displayName": "People",
"description": "\n"
},
{
"name": "peopleabridged_model",
"x-displayName": "PeopleAbridged",
"description": "\n"
},
{
"name": "plane_model",
"x-displayName": "Plane",
"description": "\n"
},
{
"name": "plastic_model",
"x-displayName": "Plastic",
"description": "\n"
},
{
"name": "processabridged_model",
"x-displayName": "ProcessAbridged",
"description": "\n"
},
{
"name": "programtype_model",
"x-displayName": "ProgramType",
"description": "\n"
},
{
"name": "programtypeabridged_model",
"x-displayName": "ProgramTypeAbridged",
"description": "\n"
},
{
"name": "radianceshadestateabridged_model",
"x-displayName": "RadianceShadeStateAbridged",
"description": "\n"
},
{
"name": "radiancesubfacestateabridged_model",
"x-displayName": "RadianceSubFaceStateAbridged",
"description": "\n"
},
{
"name": "radiant_model",
"x-displayName": "Radiant",
"description": "\n"
},
{
"name": "radiantequipmenttype_model",
"x-displayName": "RadiantEquipmentType",
"description": "\n"
},
{
"name": "radiantfacetypes_model",
"x-displayName": "RadiantFaceTypes",
"description": "\n"
},
{
"name": "radiantwithdoasabridged_model",
"x-displayName": "RadiantwithDOASAbridged",
"description": "\n"
},
{
"name": "radiantwithdoasequipmenttype_model",
"x-displayName": "RadiantwithDOASEquipmentType",
"description": "\n"
},
{
"name": "residential_model",
"x-displayName": "Residential",
"description": "\n"
},
{
"name": "residentialequipmenttype_model",
"x-displayName": "ResidentialEquipmentType",
"description": "\n"
},
{
"name": "roofceilingconstructionset_model",
"x-displayName": "RoofCeilingConstructionSet",
"description": "\n"
},
{
"name": "roofceilingconstructionsetabridged_model",
"x-displayName": "RoofCeilingConstructionSetAbridged",
"description": "\n"
},
{
"name": "roofceilingmodifierset_model",
"x-displayName": "RoofCeilingModifierSet",
"description": "\n"
},
{
"name": "roofceilingmodifiersetabridged_model",
"x-displayName": "RoofCeilingModifierSetAbridged",
"description": "\n"
},
{
"name": "room_model",
"x-displayName": "Room",
"description": "\n"
},
{
"name": "roomdoe2properties_model",
"x-displayName": "RoomDoe2Properties",
"description": "\n"
},
{
"name": "roomenergypropertiesabridged_model",
"x-displayName": "RoomEnergyPropertiesAbridged",
"description": "\n"
},
{
"name": "roompropertiesabridged_model",
"x-displayName": "RoomPropertiesAbridged",
"description": "\n"
},
{
"name": "roomradiancepropertiesabridged_model",
"x-displayName": "RoomRadiancePropertiesAbridged",
"description": "\n"
},
{
"name": "roughness_model",
"x-displayName": "Roughness",
"description": "\n"
},
{
"name": "shwequipmenttype_model",
"x-displayName": "SHWEquipmentType",
"description": "\n"
},
{
"name": "shwsystem_model",
"x-displayName": "SHWSystem",
"description": "\n"
},
{
"name": "scheduleday_model",
"x-displayName": "ScheduleDay",
"description": "\n"
},
{
"name": "schedulefixedinterval_model",
"x-displayName": "ScheduleFixedInterval",
"description": "\n"
},
{
"name": "schedulefixedintervalabridged_model",
"x-displayName": "ScheduleFixedIntervalAbridged",
"description": "\n"
},
{
"name": "schedulenumerictype_model",
"x-displayName": "ScheduleNumericType",
"description": "\n"
},
{
"name": "scheduleruleabridged_model",
"x-displayName": "ScheduleRuleAbridged",
"description": "\n"
},
{
"name": "scheduleruleset_model",
"x-displayName": "ScheduleRuleset",
"description": "\n"
},
{
"name": "schedulerulesetabridged_model",
"x-displayName": "ScheduleRulesetAbridged",
"description": "\n"
},
{
"name": "scheduletypelimit_model",
"x-displayName": "ScheduleTypeLimit",
"description": "\n"
},
{
"name": "scheduleunittype_model",
"x-displayName": "ScheduleUnitType",
"description": "\n"
},
{
"name": "sensor_model",
"x-displayName": "Sensor",
"description": "\n"
},
{
"name": "sensorgrid_model",
"x-displayName": "SensorGrid",
"description": "\n"
},
{
"name": "servicehotwater_model",
"x-displayName": "ServiceHotWater",
"description": "\n"
},
{
"name": "servicehotwaterabridged_model",
"x-displayName": "ServiceHotWaterAbridged",
"description": "\n"
},
{
"name": "setpoint_model",
"x-displayName": "Setpoint",
"description": "\n"
},
{
"name": "setpointabridged_model",
"x-displayName": "SetpointAbridged",
"description": "\n"
},
{
"name": "shade_model",
"x-displayName": "Shade",
"description": "\n"
},
{
"name": "shadeconstruction_model",
"x-displayName": "ShadeConstruction",
"description": "\n"
},
{
"name": "shadeenergypropertiesabridged_model",
"x-displayName": "ShadeEnergyPropertiesAbridged",
"description": "\n"
},
{
"name": "shadelocation_model",
"x-displayName": "ShadeLocation",
"description": "\n"
},
{
"name": "shademesh_model",
"x-displayName": "ShadeMesh",
"description": "\n"
},
{
"name": "shademeshenergypropertiesabridged_model",
"x-displayName": "ShadeMeshEnergyPropertiesAbridged",
"description": "\n"
},
{
"name": "shademeshpropertiesabridged_model",
"x-displayName": "ShadeMeshPropertiesAbridged",
"description": "\n"
},
{
"name": "shademeshradiancepropertiesabridged_model",
"x-displayName": "ShadeMeshRadiancePropertiesAbridged",
"description": "\n"
},
{
"name": "shademodifierset_model",
"x-displayName": "ShadeModifierSet",
"description": "\n"
},
{
"name": "shademodifiersetabridged_model",
"x-displayName": "ShadeModifierSetAbridged",
"description": "\n"
},
{
"name": "shadepropertiesabridged_model",
"x-displayName": "ShadePropertiesAbridged",
"description": "\n"
},
{
"name": "shaderadiancepropertiesabridged_model",
"x-displayName": "ShadeRadiancePropertiesAbridged",
"description": "\n"
},
{
"name": "slatorientation_model",
"x-displayName": "SlatOrientation",
"description": "\n"
},
{
"name": "stategeometryabridged_model",
"x-displayName": "StateGeometryAbridged",
"description": "\n"
},
{
"name": "surface_model",
"x-displayName": "Surface",
"description": "\n"
},
{
"name": "trans_model",
"x-displayName": "Trans",
"description": "\n"
},
{
"name": "units_model",
"x-displayName": "Units",
"description": "\n"
},
{
"name": "vav_model",
"x-displayName": "VAV",
"description": "\n"
},
{
"name": "vavequipmenttype_model",
"x-displayName": "VAVEquipmentType",
"description": "\n"
},
{
"name": "vrf_model",
"x-displayName": "VRF",
"description": "\n"
},
{
"name": "vrfequipmenttype_model",
"x-displayName": "VRFEquipmentType",
"description": "\n"
},
{
"name": "vrfwithdoasabridged_model",
"x-displayName": "VRFwithDOASAbridged",
"description": "\n"
},
{
"name": "vrfwithdoasequipmenttype_model",
"x-displayName": "VRFwithDOASEquipmentType",
"description": "\n"
},
{
"name": "ventilation_model",
"x-displayName": "Ventilation",
"description": "\n"
},
{
"name": "ventilationabridged_model",
"x-displayName": "VentilationAbridged",
"description": "\n"
},
{
"name": "ventilationcontrolabridged_model",
"x-displayName": "VentilationControlAbridged",
"description": "\n"
},
{
"name": "ventilationcontroltype_model",
"x-displayName": "VentilationControlType",
"description": "\n"
},
{
"name": "ventilationfan_model",
"x-displayName": "VentilationFan",
"description": "\n"
},
{
"name": "ventilationmethod_model",
"x-displayName": "VentilationMethod",
"description": "\n"
},
{
"name": "ventilationopening_model",
"x-displayName": "VentilationOpening",
"description": "\n"
},
{
"name": "ventilationsimulationcontrol_model",
"x-displayName": "VentilationSimulationControl",
"description": "\n"
},
{
"name": "ventilationtype_model",
"x-displayName": "VentilationType",
"description": "\n"
},
{
"name": "view_model",
"x-displayName": "View",
"description": "\n"
},
{
"name": "viewtype_model",
"x-displayName": "ViewType",
"description": "\n"
},
{
"name": "vintages_model",
"x-displayName": "Vintages",
"description": "\n"
},
{
"name": "void_model",
"x-displayName": "Void",
"description": "\n"
},
{
"name": "wshp_model",
"x-displayName": "WSHP",
"description": "\n"
},
{
"name": "wshpequipmenttype_model",
"x-displayName": "WSHPEquipmentType",
"description": "\n"
},
{
"name": "wshpwithdoasabridged_model",
"x-displayName": "WSHPwithDOASAbridged",
"description": "\n"
},
{
"name": "wshpwithdoasequipmenttype_model",
"x-displayName": "WSHPwithDOASEquipmentType",
"description": "\n"
},
{
"name": "wallconstructionset_model",
"x-displayName": "WallConstructionSet",
"description": "\n"
},
{
"name": "wallconstructionsetabridged_model",
"x-displayName": "WallConstructionSetAbridged",
"description": "\n"
},
{
"name": "wallmodifierset_model",
"x-displayName": "WallModifierSet",
"description": "\n"
},
{
"name": "wallmodifiersetabridged_model",
"x-displayName": "WallModifierSetAbridged",
"description": "\n"
},
{
"name": "windowac_model",
"x-displayName": "WindowAC",
"description": "\n"
},
{
"name": "windowacequipmenttype_model",
"x-displayName": "WindowACEquipmentType",
"description": "\n"
},
{
"name": "windowconstruction_model",
"x-displayName": "WindowConstruction",
"description": "\n"
},
{
"name": "windowconstructionabridged_model",
"x-displayName": "WindowConstructionAbridged",
"description": "\n"
},
{
"name": "windowconstructiondynamic_model",
"x-displayName": "WindowConstructionDynamic",
"description": "\n"
},
{
"name": "windowconstructiondynamicabridged_model",
"x-displayName": "WindowConstructionDynamicAbridged",
"description": "\n"
},
{
"name": "windowconstructionshade_model",
"x-displayName": "WindowConstructionShade",
"description": "\n"
},
{
"name": "windowconstructionshadeabridged_model",
"x-displayName": "WindowConstructionShadeAbridged",
"description": "\n"
},
{
"name": "_allairbase_model",
"x-displayName": "_AllAirBase",
"description": "\n"
},
{
"name": "_doasbase_model",
"x-displayName": "_DOASBase",
"description": "\n"
},
{
"name": "_equipmentbase_model",
"x-displayName": "_EquipmentBase",
"description": "\n"
},
{
"name": "_facesubset_model",
"x-displayName": "_FaceSubSet",
"description": "\n"
},
{
"name": "_facesubsetabridged_model",
"x-displayName": "_FaceSubSetAbridged",
"description": "\n"
},
{
"name": "_heatcoolbase_model",
"x-displayName": "_HeatCoolBase",
"description": "\n"
},
{
"name": "_openapigenbasemodel_model",
"x-displayName": "_OpenAPIGenBaseModel",
"description": "\n"
},
{
"name": "_propertiesbaseabridged_model",
"x-displayName": "_PropertiesBaseAbridged",
"description": "\n"
},
{
"name": "_radianceasset_model",
"x-displayName": "_RadianceAsset",
"description": "\n"
},
{
"name": "_templatesystem_model",
"x-displayName": "_TemplateSystem",
"description": "\n"
}
],
"x-tagGroups": [
{
"name": "Models",
"tags": [
"_allairbase_model",
"_doasbase_model",
"_equipmentbase_model",
"_facesubset_model",
"_facesubsetabridged_model",
"_heatcoolbase_model",
"_openapigenbasemodel_model",
"_propertiesbaseabridged_model",
"_radianceasset_model",
"_templatesystem_model",
"adiabatic_model",
"afncrack_model",
"airboundaryconstruction_model",
"airboundaryconstructionabridged_model",
"allaireconomizertype_model",
"aperture_model",
"apertureconstructionset_model",
"apertureconstructionsetabridged_model",
"apertureenergypropertiesabridged_model",
"aperturemodifierset_model",
"aperturemodifiersetabridged_model",
"aperturepropertiesabridged_model",
"apertureradiancepropertiesabridged_model",
"autocalculate_model",
"autosize_model",
"baseboard_model",
"baseboardequipmenttype_model",
"basemodifierset_model",
"basemodifiersetabridged_model",
"bsdf_model",
"buildingtype_model",
"color_model",
"constructionset_model",
"constructionsetabridged_model",
"controltype_model",
"datedbasemodel_model",
"daylightingcontrol_model",
"detailedhvac_model",
"door_model",
"doorconstructionset_model",
"doorconstructionsetabridged_model",
"doorenergypropertiesabridged_model",
"doormodifierset_model",
"doormodifiersetabridged_model",
"doorpropertiesabridged_model",
"doorradiancepropertiesabridged_model",
"economizertype_model",
"electricequipment_model",
"electricequipmentabridged_model",
"electricloadcenter_model",
"energybasemodel_model",
"energymaterial_model",
"energymaterialnomass_model",
"energymaterialvegetation_model",
"energywindowframe_model",
"energywindowmaterialblind_model",
"energywindowmaterialgas_model",
"energywindowmaterialgascustom_model",
"energywindowmaterialgasmixture_model",
"energywindowmaterialglazing_model",
"energywindowmaterialshade_model",
"energywindowmaterialsimpleglazsys_model",
"evaporativecooler_model",
"evaporativecoolerequipmenttype_model",
"face3d_model",
"face_model",
"faceenergypropertiesabridged_model",
"facepropertiesabridged_model",
"faceradiancepropertiesabridged_model",
"facetype_model",
"fcu_model",
"fcuequipmenttype_model",
"fcuwithdoasabridged_model",
"fcuwithdoasequipmenttype_model",
"floorconstructionset_model",
"floorconstructionsetabridged_model",
"floormodifierset_model",
"floormodifiersetabridged_model",
"forcedairfurnace_model",
"fueltypes_model",
"furnaceequipmenttype_model",
"gasequipment_model",
"gasequipmentabridged_model",
"gastype_model",
"gasunitheater_model",
"gasunitheaterequipmenttype_model",
"glass_model",
"globalconstructionset_model",
"globalmodifierset_model",
"glow_model",
"ground_model",
"iddbasemodel_model",
"iddenergybasemodel_model",
"iddradiancebasemodel_model",
"idealairsystemabridged_model",
"infiltration_model",
"infiltrationabridged_model",
"internalmassabridged_model",
"light_model",
"lighting_model",
"lightingabridged_model",
"mesh3d_model",
"metal_model",
"mirror_model",
"model_model",
"modeldoe2properties_model",
"modelenergyproperties_model",
"modelproperties_model",
"modelradianceproperties_model",
"modifierbase_model",
"modifierset_model",
"modifiersetabridged_model",
"moduletype_model",
"moisturediffusionmodel_model",
"mountingtype_model",
"nolimit_model",
"opaqueconstruction_model",
"opaqueconstructionabridged_model",
"othersidetemperature_model",
"outdoors_model",
"people_model",
"peopleabridged_model",
"plane_model",
"plastic_model",
"processabridged_model",
"programtype_model",
"programtypeabridged_model",
"psz_model",
"pszequipmenttype_model",
"ptac_model",
"ptacequipmenttype_model",
"pvav_model",
"pvavequipmenttype_model",
"pvproperties_model",
"radianceshadestateabridged_model",
"radiancesubfacestateabridged_model",
"radiant_model",
"radiantequipmenttype_model",
"radiantfacetypes_model",
"radiantwithdoasabridged_model",
"radiantwithdoasequipmenttype_model",
"residential_model",
"residentialequipmenttype_model",
"roofceilingconstructionset_model",
"roofceilingconstructionsetabridged_model",
"roofceilingmodifierset_model",
"roofceilingmodifiersetabridged_model",
"room_model",
"roomdoe2properties_model",
"roomenergypropertiesabridged_model",
"roompropertiesabridged_model",
"roomradiancepropertiesabridged_model",
"roughness_model",
"scheduleday_model",
"schedulefixedinterval_model",
"schedulefixedintervalabridged_model",
"schedulenumerictype_model",
"scheduleruleabridged_model",
"scheduleruleset_model",
"schedulerulesetabridged_model",
"scheduletypelimit_model",
"scheduleunittype_model",
"sensor_model",
"sensorgrid_model",
"servicehotwater_model",
"servicehotwaterabridged_model",
"setpoint_model",
"setpointabridged_model",
"shade_model",
"shadeconstruction_model",
"shadeenergypropertiesabridged_model",
"shadelocation_model",
"shademesh_model",
"shademeshenergypropertiesabridged_model",
"shademeshpropertiesabridged_model",
"shademeshradiancepropertiesabridged_model",
"shademodifierset_model",
"shademodifiersetabridged_model",
"shadepropertiesabridged_model",
"shaderadiancepropertiesabridged_model",
"shwequipmenttype_model",
"shwsystem_model",
"slatorientation_model",
"stategeometryabridged_model",
"surface_model",
"trans_model",
"units_model",
"vav_model",
"vavequipmenttype_model",
"ventilation_model",
"ventilationabridged_model",
"ventilationcontrolabridged_model",
"ventilationcontroltype_model",
"ventilationfan_model",
"ventilationmethod_model",
"ventilationopening_model",
"ventilationsimulationcontrol_model",
"ventilationtype_model",
"view_model",
"viewtype_model",
"vintages_model",
"void_model",
"vrf_model",
"vrfequipmenttype_model",
"vrfwithdoasabridged_model",
"vrfwithdoasequipmenttype_model",
"wallconstructionset_model",
"wallconstructionsetabridged_model",
"wallmodifierset_model",
"wallmodifiersetabridged_model",
"windowac_model",
"windowacequipmenttype_model",
"windowconstruction_model",
"windowconstructionabridged_model",
"windowconstructiondynamic_model",
"windowconstructiondynamicabridged_model",
"windowconstructionshade_model",
"windowconstructionshadeabridged_model",
"wshp_model",
"wshpequipmenttype_model",
"wshpwithdoasabridged_model",
"wshpwithdoasequipmenttype_model"
]
}
],
"paths": {},
"components": {
"schemas": {
"AFNCrack": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"flow_coefficient": {
"description": "A number in kg/s-m at 1 Pa per meter of crack length at the conditions defined in the ReferenceCrack condition; required to run an AirflowNetwork simulation. The DesignBuilder Cracks template defines the flow coefficient for a tight, low-leakage wall to be 0.00001 and 0.001 for external and internal constructions, respectively. Flow coefficients for a very poor, high-leakage wall are defined to be 0.0004 and 0.019 for external and internal constructions, respectively.",
"exclusiveMinimum": 0,
"title": "Flow Coefficient",
"type": "number",
"format": "double"
},
"type": {
"const": "AFNCrack",
"default": "AFNCrack",
"title": "Type",
"type": "string",
"readOnly": true
},
"flow_exponent": {
"default": 0.65,
"description": "An optional dimensionless number between 0.5 and 1 used to calculate the crack mass flow rate; required to run an AirflowNetwork simulation. This value represents the leak geometry impact on airflow, with 0.5 generally corresponding to turbulent orifice flow and 1 generally corresponding to laminar flow. The default of 0.65 is representative of many cases of wall and window leakage, used when the exponent cannot be measured.",
"maximum": 1,
"minimum": 0.5,
"title": "Flow Exponent",
"type": "number",
"format": "double"
}
},
"additionalProperties": false,
"required": [
"flow_coefficient"
]
}
],
"description": "Properties for airflow through a crack.",
"title": "AFNCrack",
"discriminator": {
"propertyName": "type"
}
},
"Adiabatic": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "Adiabatic",
"default": "Adiabatic",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"title": "Adiabatic",
"discriminator": {
"propertyName": "type"
}
},
"AirBoundaryConstruction": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "AirBoundaryConstruction",
"default": "AirBoundaryConstruction",
"title": "Type",
"type": "string",
"readOnly": true
},
"air_mixing_per_area": {
"default": 0.1,
"description": "A positive number for the amount of air mixing between Rooms across the air boundary surface [m3/s-m2]. Default: 0.1 corresponds to average indoor air speeds of 0.1 m/s (roughly 20 fpm), which is typical of what would be induced by a HVAC system.",
"minimum": 0,
"title": "Air Mixing Per Area",
"type": "number",
"format": "double"
},
"air_mixing_schedule": {
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
},
{
"type": "null"
}
],
"default": null,
"description": "A fractional schedule as a ScheduleRuleset or ScheduleFixedInterval for the air mixing schedule across the construction. If unspecified, an Always On schedule will be assumed.",
"title": "Air Mixing Schedule"
}
},
"additionalProperties": false
}
],
"description": "Construction for Air Boundary objects.",
"title": "AirBoundaryConstruction",
"discriminator": {
"propertyName": "type"
}
},
"AirBoundaryConstructionAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "AirBoundaryConstructionAbridged",
"default": "AirBoundaryConstructionAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"air_mixing_per_area": {
"default": 0.1,
"description": "A positive number for the amount of air mixing between Rooms across the air boundary surface [m3/s-m2]. Default: 0.1 corresponds to average indoor air speeds of 0.1 m/s (roughly 20 fpm), which is typical of what would be induced by a HVAC system.",
"minimum": 0,
"title": "Air Mixing Per Area",
"type": "number",
"format": "double"
},
"air_mixing_schedule": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of a fractional schedule for the air mixing schedule across the construction. If unspecified, an Always On schedule will be assumed.",
"title": "Air Mixing Schedule"
}
},
"additionalProperties": false
}
],
"description": "Construction for Air Boundary objects.",
"title": "AirBoundaryConstructionAbridged",
"discriminator": {
"propertyName": "type"
}
},
"AllAirEconomizerType": {
"enum": [
"NoEconomizer",
"DifferentialDryBulb",
"DifferentialEnthalpy",
"DifferentialDryBulbAndEnthalpy",
"FixedDryBulb",
"FixedEnthalpy",
"ElectronicEnthalpy"
],
"title": "AllAirEconomizerType",
"type": "string"
},
"Aperture": {
"allOf": [
{
"$ref": "#/components/schemas/IDdBaseModel"
},
{
"type": "object",
"required": [
"geometry",
"boundary_condition",
"properties"
],
"properties": {
"geometry": {
"$ref": "#/components/schemas/Face3D",
"description": "Planar Face3D for the geometry."
},
"boundary_condition": {
"anyOf": [
{
"$ref": "#/components/schemas/Outdoors"
},
{
"$ref": "#/components/schemas/Surface"
}
],
"title": "Boundary Condition"
},
"properties": {
"$ref": "#/components/schemas/AperturePropertiesAbridged",
"description": "Extension properties for particular simulation engines (Radiance, EnergyPlus)."
},
"type": {
"const": "Aperture",
"default": "Aperture",
"title": "Type",
"type": "string",
"readOnly": true
},
"is_operable": {
"default": false,
"description": "Boolean to note whether the Aperture can be opened for ventilation.",
"title": "Is Operable",
"type": "boolean"
},
"indoor_shades": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Shade"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Shades assigned to the interior side of this object (eg. window sill, light shelf).",
"title": "Indoor Shades"
},
"outdoor_shades": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Shade"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Shades assigned to the exterior side of this object (eg. mullions, louvers).",
"title": "Outdoor Shades"
}
},
"additionalProperties": false
}
],
"title": "Aperture",
"discriminator": {
"propertyName": "type"
}
},
"ApertureConstructionSet": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "ApertureConstructionSet",
"default": "ApertureConstructionSet",
"title": "Type",
"type": "string",
"readOnly": true
},
"interior_construction": {
"anyOf": [
{
"$ref": "#/components/schemas/WindowConstruction"
},
{
"$ref": "#/components/schemas/WindowConstructionShade"
},
{
"$ref": "#/components/schemas/WindowConstructionDynamic"
},
{
"type": "null"
}
],
"default": null,
"description": "A WindowConstruction for all apertures with a Surface boundary condition.",
"title": "Interior Construction"
},
"window_construction": {
"anyOf": [
{
"$ref": "#/components/schemas/WindowConstruction"
},
{
"$ref": "#/components/schemas/WindowConstructionShade"
},
{
"$ref": "#/components/schemas/WindowConstructionDynamic"
},
{
"type": "null"
}
],
"default": null,
"description": "A WindowConstruction for apertures with an Outdoors boundary condition, False is_operable property, and a Wall face type for their parent face.",
"title": "Window Construction"
},
"skylight_construction": {
"anyOf": [
{
"$ref": "#/components/schemas/WindowConstruction"
},
{
"$ref": "#/components/schemas/WindowConstructionShade"
},
{
"$ref": "#/components/schemas/WindowConstructionDynamic"
},
{
"type": "null"
}
],
"default": null,
"description": "A WindowConstruction for apertures with a Outdoors boundary condition, False is_operable property, and a RoofCeiling or Floor face type for their parent face.",
"title": "Skylight Construction"
},
"operable_construction": {
"anyOf": [
{
"$ref": "#/components/schemas/WindowConstruction"
},
{
"$ref": "#/components/schemas/WindowConstructionShade"
},
{
"$ref": "#/components/schemas/WindowConstructionDynamic"
},
{
"type": "null"
}
],
"default": null,
"description": "A WindowConstruction for all apertures with an Outdoors boundary condition and True is_operable property.",
"title": "Operable Construction"
}
},
"additionalProperties": false
}
],
"description": "A set of constructions for aperture assemblies.",
"title": "ApertureConstructionSet",
"discriminator": {
"propertyName": "type"
}
},
"ApertureConstructionSetAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "ApertureConstructionSetAbridged",
"default": "ApertureConstructionSetAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"interior_construction": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier for a WindowConstruction for all apertures with a Surface boundary condition.",
"title": "Interior Construction"
},
"window_construction": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier for a WindowConstruction for apertures with an Outdoors boundary condition, False is_operable property, and a Wall face type for their parent face.",
"title": "Window Construction"
},
"skylight_construction": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier for a WindowConstruction for apertures with a Outdoors boundary condition, False is_operable property, and a RoofCeiling or Floor face type for their parent face.",
"title": "Skylight Construction"
},
"operable_construction": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier for a WindowConstruction for all apertures with an Outdoors boundary condition and True is_operable property.",
"title": "Operable Construction"
}
},
"additionalProperties": false
}
],
"description": "A set of constructions for aperture assemblies.",
"title": "ApertureConstructionSetAbridged",
"discriminator": {
"propertyName": "type"
}
},
"ApertureEnergyPropertiesAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "ApertureEnergyPropertiesAbridged",
"default": "ApertureEnergyPropertiesAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"construction": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of a WindowConstruction for the aperture. If None, the construction is set by the parent Room construction_set or the Model global_construction_set.",
"title": "Construction"
},
"vent_opening": {
"anyOf": [
{
"$ref": "#/components/schemas/VentilationOpening"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional VentilationOpening to specify the operable portion of the Aperture."
}
},
"additionalProperties": false
}
],
"title": "ApertureEnergyPropertiesAbridged",
"discriminator": {
"propertyName": "type"
}
},
"ApertureModifierSet": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "ApertureModifierSet",
"default": "ApertureModifierSet",
"title": "Type",
"type": "string",
"readOnly": true
},
"window_modifier": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
},
{
"type": "null"
}
],
"default": null,
"description": "A modifier object for apertures with an Outdoors boundary condition, False is_operable property, and Wall parent Face.",
"title": "Window Modifier"
},
"interior_modifier": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
},
{
"type": "null"
}
],
"default": null,
"description": "A modifier object for apertures with a Surface boundary condition.",
"title": "Interior Modifier"
},
"skylight_modifier": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
},
{
"type": "null"
}
],
"default": null,
"description": "A modifier object for apertures with an Outdoors boundary condition, False is_operable property, and a RoofCeiling or Floor face type for their parent face.",
"title": "Skylight Modifier"
},
"operable_modifier": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
},
{
"type": "null"
}
],
"default": null,
"description": "A modifier object for apertures with an Outdoors boundary condition and a True is_operable property.",
"title": "Operable Modifier"
}
},
"additionalProperties": false
}
],
"description": "Set containing radiance modifiers needed for a model's Apertures.",
"title": "ApertureModifierSet",
"discriminator": {
"propertyName": "type"
}
},
"ApertureModifierSetAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "ApertureModifierSetAbridged",
"default": "ApertureModifierSetAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"window_modifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of modifier object for apertures with an Outdoors boundary condition, False is_operable property, and Wall parent Face.",
"title": "Window Modifier"
},
"interior_modifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of modifier object for apertures with a Surface boundary condition.",
"title": "Interior Modifier"
},
"skylight_modifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of modifier object for apertures with an Outdoors boundary condition, False is_operable property, and a RoofCeiling or Floor face type for their parent face.",
"title": "Skylight Modifier"
},
"operable_modifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of modifier object for apertures with an Outdoors boundary condition and a True is_operable property.",
"title": "Operable Modifier"
}
},
"additionalProperties": false
}
],
"description": "Abridged set containing radiance modifiers needed for a model's Apertures.",
"title": "ApertureModifierSetAbridged",
"discriminator": {
"propertyName": "type"
}
},
"AperturePropertiesAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "AperturePropertiesAbridged",
"default": "AperturePropertiesAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"energy": {
"anyOf": [
{
"$ref": "#/components/schemas/ApertureEnergyPropertiesAbridged"
},
{
"type": "null"
}
],
"default": null
},
"radiance": {
"anyOf": [
{
"$ref": "#/components/schemas/ApertureRadiancePropertiesAbridged"
},
{
"type": "null"
}
],
"default": null
}
}
}
],
"title": "AperturePropertiesAbridged",
"discriminator": {
"propertyName": "type"
}
},
"ApertureRadiancePropertiesAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_PropertiesBaseAbridged"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "ApertureRadiancePropertiesAbridged",
"default": "ApertureRadiancePropertiesAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"dynamic_group_identifier": {
"default": null,
"description": "An optional string to note the dynamic group ' 'to which the Aperture is a part of. Apertures sharing the same ' 'dynamic_group_identifier will have their states change in unison. ' 'If None, the Aperture is assumed to be static. (default: None).",
"title": "Dynamic Group Identifier",
"type": "string"
},
"states": {
"default": null,
"description": "An optional list of abridged states (default: None).",
"items": {
"$ref": "#/components/schemas/RadianceSubFaceStateAbridged"
},
"title": "States",
"type": "array"
}
},
"additionalProperties": false
}
],
"description": "Radiance Properties for Honeybee Aperture Abridged.",
"title": "ApertureRadiancePropertiesAbridged",
"discriminator": {
"propertyName": "type"
}
},
"Autocalculate": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "Autocalculate",
"default": "Autocalculate",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"title": "Autocalculate",
"discriminator": {
"propertyName": "type"
}
},
"Autosize": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "Autosize",
"default": "Autosize",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"title": "Autosize",
"discriminator": {
"propertyName": "type"
}
},
"BSDF": {
"allOf": [
{
"$ref": "#/components/schemas/ModifierBase"
},
{
"type": "object",
"required": [
"bsdf_data"
],
"properties": {
"bsdf_data": {
"description": "A string with the contents of the BSDF XML file.",
"title": "Bsdf Data",
"type": "string"
},
"modifier": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
},
{
"type": "null"
}
],
"default": {
"type": "Void"
},
"description": "Material modifier.",
"title": "Modifier"
},
"dependencies": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers.",
"title": "Dependencies"
},
"up_orientation": {
"default": [
0.01,
0.01,
1.0
],
"description": "Vector as sequence that sets the hemisphere that the BSDF material faces.",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 3,
"minItems": 3,
"title": "Up Orientation",
"type": "array"
},
"thickness": {
"default": 0,
"description": "Optional number to set the thickness of the BSDF material Sign of thickness indicates whether proxied geometry is behind the BSDF surface (when thickness is positive) or in front (when thickness is negative).",
"title": "Thickness",
"type": "number",
"format": "double"
},
"function_file": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": ".",
"description": "Optional input for function file. Using \".\" will ensure that BSDF data is written to the root of wherever a given study is run.",
"title": "Function File"
},
"transform": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional transform input to scale the thickness and reorient the up vector.",
"title": "Transform"
},
"front_diffuse_reflectance": {
"anyOf": [
{
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional additional front diffuse reflectance as sequence of three RGB numbers.",
"title": "Front Diffuse Reflectance"
},
"back_diffuse_reflectance": {
"anyOf": [
{
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional additional back diffuse reflectance as sequence of three RGB numbers.",
"title": "Back Diffuse Reflectance"
},
"diffuse_transmittance": {
"anyOf": [
{
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional additional diffuse transmittance as sequence of three RGB numbers.",
"title": "Diffuse Transmittance"
},
"type": {
"const": "BSDF",
"default": "BSDF",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Radiance BSDF (Bidirectional Scattering Distribution Function) material.",
"title": "BSDF",
"discriminator": {
"propertyName": "type"
}
},
"BaseModifierSet": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"exterior_modifier": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
},
{
"type": "null"
}
],
"default": null,
"description": "A radiance modifier object for faces with an Outdoors boundary condition.",
"title": "Exterior Modifier"
},
"interior_modifier": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
},
{
"type": "null"
}
],
"default": null,
"description": "A radiance modifier object for faces with a boundary condition other than Outdoors.",
"title": "Interior Modifier"
},
"type": {
"title": "Type",
"default": "BaseModifierSet",
"type": "string",
"pattern": "^BaseModifierSet$",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Base class for the modifier sets assigned to Faces.",
"title": "BaseModifierSet",
"discriminator": {
"propertyName": "type"
}
},
"BaseModifierSetAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"exterior_modifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier for a radiance modifier object for faces with an Outdoors boundary condition.",
"title": "Exterior Modifier"
},
"interior_modifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier for a radiance modifier object for faces with a boundary condition other than Outdoors.",
"title": "Interior Modifier"
},
"type": {
"title": "Type",
"default": "BaseModifierSetAbridged",
"type": "string",
"pattern": "^BaseModifierSetAbridged$",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Base class for the abridged modifier sets assigned to Faces.",
"title": "BaseModifierSetAbridged",
"discriminator": {
"propertyName": "type"
}
},
"Baseboard": {
"allOf": [
{
"$ref": "#/components/schemas/_HeatCoolBase"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "Baseboard",
"default": "Baseboard",
"title": "Type",
"type": "string",
"readOnly": true
},
"equipment_type": {
"$ref": "#/components/schemas/BaseboardEquipmentType",
"default": "ElectricBaseboard",
"description": "Text for the specific type of system equipment from the BaseboardEquipmentType enumeration."
}
},
"additionalProperties": false
}
],
"description": "Baseboard heating system.\n\nBaseboard systems are intended for spaces only requiring heating and\nno ventilation or cooling. Each room/zone will get its own baseboard\nheating unit that satisfies the heating load.",
"title": "Baseboard",
"discriminator": {
"propertyName": "type"
}
},
"BaseboardEquipmentType": {
"enum": [
"ElectricBaseboard",
"BoilerBaseboard",
"ASHPBaseboard",
"DHWBaseboard"
],
"title": "BaseboardEquipmentType",
"type": "string"
},
"BuildingType": {
"enum": [
"LowRise",
"HighRise"
],
"title": "BuildingType",
"type": "string"
},
"Color": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"r": {
"description": "Value for red channel.",
"maximum": 255,
"minimum": 0,
"title": "R",
"type": "integer",
"format": "int32"
},
"g": {
"description": "Value for green channel.",
"maximum": 255,
"minimum": 0,
"title": "G",
"type": "integer",
"format": "int32"
},
"b": {
"description": "Value for blue channel.",
"maximum": 255,
"minimum": 0,
"title": "B",
"type": "integer",
"format": "int32"
},
"type": {
"const": "Color",
"default": "Color",
"title": "Type",
"type": "string",
"readOnly": true
},
"a": {
"default": 255,
"description": "Value for the alpha channel, which defines the opacity as a number between 0 (fully transparent) and 255 (fully opaque).",
"maximum": 255,
"minimum": 0,
"title": "A",
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false,
"required": [
"r",
"g",
"b"
]
}
],
"description": "A RGB color.",
"title": "Color",
"discriminator": {
"propertyName": "type"
}
},
"ConstructionSet": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "ConstructionSet",
"default": "ConstructionSet",
"title": "Type",
"type": "string",
"readOnly": true
},
"wall_set": {
"anyOf": [
{
"$ref": "#/components/schemas/WallConstructionSet"
},
{
"type": "null"
}
],
"default": null,
"description": "A WallConstructionSet object for this ConstructionSet."
},
"floor_set": {
"anyOf": [
{
"$ref": "#/components/schemas/FloorConstructionSet"
},
{
"type": "null"
}
],
"default": null,
"description": "A FloorConstructionSet object for this ConstructionSet."
},
"roof_ceiling_set": {
"anyOf": [
{
"$ref": "#/components/schemas/RoofCeilingConstructionSet"
},
{
"type": "null"
}
],
"default": null,
"description": "A RoofCeilingConstructionSet object for this ConstructionSet."
},
"aperture_set": {
"anyOf": [
{
"$ref": "#/components/schemas/ApertureConstructionSet"
},
{
"type": "null"
}
],
"default": null,
"description": "A ApertureConstructionSet object for this ConstructionSet."
},
"door_set": {
"anyOf": [
{
"$ref": "#/components/schemas/DoorConstructionSet"
},
{
"type": "null"
}
],
"default": null,
"description": "A DoorConstructionSet object for this ConstructionSet."
},
"shade_construction": {
"anyOf": [
{
"$ref": "#/components/schemas/ShadeConstruction"
},
{
"type": "null"
}
],
"default": null,
"description": "A ShadeConstruction to set the reflectance properties of all outdoor shades of all objects to which this ConstructionSet is assigned."
},
"air_boundary_construction": {
"anyOf": [
{
"$ref": "#/components/schemas/AirBoundaryConstruction"
},
{
"$ref": "#/components/schemas/OpaqueConstruction"
},
{
"type": "null"
}
],
"default": null,
"description": "An AirBoundaryConstruction or OpaqueConstruction to set the properties of Faces with an AirBoundary type.",
"title": "Air Boundary Construction"
}
},
"additionalProperties": false
}
],
"description": "A set of constructions for different surface types and boundary conditions.",
"title": "ConstructionSet",
"discriminator": {
"propertyName": "type"
}
},
"ConstructionSetAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "ConstructionSetAbridged",
"default": "ConstructionSetAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"wall_set": {
"anyOf": [
{
"$ref": "#/components/schemas/WallConstructionSetAbridged"
},
{
"type": "null"
}
],
"default": null,
"description": "A WallConstructionSetAbridged object for this ConstructionSet."
},
"floor_set": {
"anyOf": [
{
"$ref": "#/components/schemas/FloorConstructionSetAbridged"
},
{
"type": "null"
}
],
"default": null,
"description": "A FloorConstructionSetAbridged object for this ConstructionSet."
},
"roof_ceiling_set": {
"anyOf": [
{
"$ref": "#/components/schemas/RoofCeilingConstructionSetAbridged"
},
{
"type": "null"
}
],
"default": null,
"description": "A RoofCeilingConstructionSetAbridged object for this ConstructionSet."
},
"aperture_set": {
"anyOf": [
{
"$ref": "#/components/schemas/ApertureConstructionSetAbridged"
},
{
"type": "null"
}
],
"default": null,
"description": "A ApertureConstructionSetAbridged object for this ConstructionSet."
},
"door_set": {
"anyOf": [
{
"$ref": "#/components/schemas/DoorConstructionSetAbridged"
},
{
"type": "null"
}
],
"default": null,
"description": "A DoorConstructionSetAbridged object for this ConstructionSet."
},
"shade_construction": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The identifier of a ShadeConstruction to set the reflectance properties of all outdoor shades of all objects to which this ConstructionSet is assigned.",
"title": "Shade Construction"
},
"air_boundary_construction": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The identifier of an AirBoundaryConstruction or OpaqueConstruction to set the properties of Faces with an AirBoundary type.",
"title": "Air Boundary Construction"
}
},
"additionalProperties": false
}
],
"description": "A set of constructions for different surface types and boundary conditions.",
"title": "ConstructionSetAbridged",
"discriminator": {
"propertyName": "type"
}
},
"ControlType": {
"description": "Choices for how the shading device is controlled.",
"enum": [
"AlwaysOn",
"OnIfHighSolarOnWindow",
"OnIfHighHorizontalSolar",
"OnIfHighOutdoorAirTemperature",
"OnIfHighZoneAirTemperature",
"OnIfHighZoneCooling",
"OnNightIfLowOutdoorTempAndOffDay",
"OnNightIfLowInsideTempAndOffDay",
"OnNightIfHeatingAndOffDay"
],
"title": "ControlType",
"type": "string"
},
"DatedBaseModel": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "DatedBaseModel",
"type": "string",
"pattern": "^DatedBaseModel$",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Base class for all objects needing to check for a valid Date.",
"title": "DatedBaseModel",
"discriminator": {
"propertyName": "type"
}
},
"DaylightingControl": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"sensor_position": {
"description": "A point as 3 (x, y, z) values for the position of the daylight sensor within the parent Room. This point should lie within the Room volume in order for the results to be meaningful.",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 3,
"minItems": 3,
"title": "Sensor Position",
"type": "array"
},
"type": {
"const": "DaylightingControl",
"default": "DaylightingControl",
"title": "Type",
"type": "string",
"readOnly": true
},
"illuminance_setpoint": {
"default": 300,
"description": "A number for the illuminance setpoint in lux beyond which electric lights are dimmed if there is sufficient daylight.",
"exclusiveMinimum": 0,
"title": "Illuminance Setpoint",
"type": "number",
"format": "double"
},
"control_fraction": {
"default": 1,
"description": "A number between 0 and 1 that represents the fraction of the Room lights that are dimmed when the illuminance at the sensor position is at the specified illuminance. 1 indicates that all lights are dim-able while 0 indicates that no lights are dim-able. Deeper rooms should have lower control fractions to account for the face that the lights in the back of the space do not dim in response to suitable daylight at the front of the room.",
"maximum": 1,
"minimum": 0,
"title": "Control Fraction",
"type": "number",
"format": "double"
},
"min_power_input": {
"default": 0.3,
"description": "A number between 0 and 1 for the the lowest power the lighting system can dim down to, expressed as a fraction of maximum input power.",
"maximum": 1,
"minimum": 0,
"title": "Min Power Input",
"type": "number",
"format": "double"
},
"min_light_output": {
"default": 0.2,
"description": "A number between 0 and 1 the lowest lighting output the lighting system can dim down to, expressed as a fraction of maximum light output.",
"maximum": 1,
"minimum": 0,
"title": "Min Light Output",
"type": "number",
"format": "double"
},
"off_at_minimum": {
"default": false,
"description": "Boolean to note whether lights should switch off completely when they get to the minimum power input.",
"title": "Off At Minimum",
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"sensor_position"
]
}
],
"title": "DaylightingControl",
"discriminator": {
"propertyName": "type"
}
},
"DetailedHVAC": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"specification"
],
"properties": {
"specification": {
"additionalProperties": true,
"description": "A JSON-serializable dictionary representing the full specification of the detailed system. This can be obtained by calling the ToJson() method on any IronBug HVAC system and then serializing the resulting JSON string into a Python dictionary using the native Python json package. Note that the Rooms that the HVAC is assigned to must be specified as ThermalZones under this specification in order for the resulting Model this HVAC is a part of to be valid.",
"title": "Specification",
"type": "object"
},
"type": {
"const": "DetailedHVAC",
"default": "DetailedHVAC",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Detailed HVAC system object defined using IronBug or OpenStudio .NET bindings.",
"title": "DetailedHVAC",
"discriminator": {
"propertyName": "type"
}
},
"Door": {
"allOf": [
{
"$ref": "#/components/schemas/IDdBaseModel"
},
{
"type": "object",
"required": [
"geometry",
"boundary_condition",
"properties"
],
"properties": {
"geometry": {
"$ref": "#/components/schemas/Face3D",
"description": "Planar Face3D for the geometry."
},
"boundary_condition": {
"anyOf": [
{
"$ref": "#/components/schemas/Outdoors"
},
{
"$ref": "#/components/schemas/Surface"
}
],
"title": "Boundary Condition"
},
"properties": {
"$ref": "#/components/schemas/DoorPropertiesAbridged",
"description": "Extension properties for particular simulation engines (Radiance, EnergyPlus)."
},
"type": {
"const": "Door",
"default": "Door",
"title": "Type",
"type": "string",
"readOnly": true
},
"is_glass": {
"default": false,
"description": "Boolean to note whether this object is a glass door as opposed to an opaque door.",
"title": "Is Glass",
"type": "boolean"
},
"indoor_shades": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Shade"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Shades assigned to the interior side of this object.",
"title": "Indoor Shades"
},
"outdoor_shades": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Shade"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Shades assigned to the exterior side of this object (eg. entryway awning).",
"title": "Outdoor Shades"
}
},
"additionalProperties": false
}
],
"title": "Door",
"discriminator": {
"propertyName": "type"
}
},
"DoorConstructionSet": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "DoorConstructionSet",
"default": "DoorConstructionSet",
"title": "Type",
"type": "string",
"readOnly": true
},
"interior_construction": {
"anyOf": [
{
"$ref": "#/components/schemas/OpaqueConstruction"
},
{
"type": "null"
}
],
"default": null,
"description": "An OpaqueConstruction for all opaque doors with a Surface boundary condition."
},
"exterior_construction": {
"anyOf": [
{
"$ref": "#/components/schemas/OpaqueConstruction"
},
{
"type": "null"
}
],
"default": null,
"description": "An OpaqueConstruction for opaque doors with an Outdoors boundary condition and a Wall face type for their parent face."
},
"overhead_construction": {
"anyOf": [
{
"$ref": "#/components/schemas/OpaqueConstruction"
},
{
"type": "null"
}
],
"default": null,
"description": "An OpaqueConstruction for opaque doors with an Outdoors boundary condition and a RoofCeiling or Floor type for their parent face."
},
"exterior_glass_construction": {
"anyOf": [
{
"$ref": "#/components/schemas/WindowConstruction"
},
{
"$ref": "#/components/schemas/WindowConstructionShade"
},
{
"$ref": "#/components/schemas/WindowConstructionDynamic"
},
{
"type": "null"
}
],
"default": null,
"description": "A WindowConstruction for all glass doors with an Outdoors boundary condition.",
"title": "Exterior Glass Construction"
},
"interior_glass_construction": {
"anyOf": [
{
"$ref": "#/components/schemas/WindowConstruction"
},
{
"$ref": "#/components/schemas/WindowConstructionShade"
},
{
"$ref": "#/components/schemas/WindowConstructionDynamic"
},
{
"type": "null"
}
],
"default": null,
"description": "A WindowConstruction for all glass doors with a Surface boundary condition.",
"title": "Interior Glass Construction"
}
},
"additionalProperties": false
}
],
"description": "A set of constructions for door assemblies.",
"title": "DoorConstructionSet",
"discriminator": {
"propertyName": "type"
}
},
"DoorConstructionSetAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "DoorConstructionSetAbridged",
"default": "DoorConstructionSetAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"interior_construction": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier for an OpaqueConstruction for all opaque doors with a Surface boundary condition.",
"title": "Interior Construction"
},
"exterior_construction": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier for an OpaqueConstruction for opaque doors with an Outdoors boundary condition and a Wall face type for their parent face.",
"title": "Exterior Construction"
},
"overhead_construction": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier for an OpaqueConstruction for opaque doors with an Outdoors boundary condition and a RoofCeiling or Floor type for their parent face.",
"title": "Overhead Construction"
},
"exterior_glass_construction": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier for a WindowConstruction for all glass doors with an Outdoors boundary condition.",
"title": "Exterior Glass Construction"
},
"interior_glass_construction": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier for a WindowConstruction for all glass doors with a Surface boundary condition.",
"title": "Interior Glass Construction"
}
},
"additionalProperties": false
}
],
"description": "A set of constructions for door assemblies.",
"title": "DoorConstructionSetAbridged",
"discriminator": {
"propertyName": "type"
}
},
"DoorEnergyPropertiesAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "DoorEnergyPropertiesAbridged",
"default": "DoorEnergyPropertiesAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"construction": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of an OpaqueConstruction or WindowConstruction for the door. Note that the host door must have the is_glass property set to True to assign a WindowConstruction. If None, the construction is set by the parent Room construction_set or the Model global_construction_set.",
"title": "Construction"
},
"vent_opening": {
"anyOf": [
{
"$ref": "#/components/schemas/VentilationOpening"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional VentilationOpening to specify the operable portion of the Door."
}
},
"additionalProperties": false
}
],
"title": "DoorEnergyPropertiesAbridged",
"discriminator": {
"propertyName": "type"
}
},
"DoorModifierSet": {
"allOf": [
{
"$ref": "#/components/schemas/BaseModifierSet"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "DoorModifierSet",
"default": "DoorModifierSet",
"title": "Type",
"type": "string",
"readOnly": true
},
"interior_glass_modifier": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
},
{
"type": "null"
}
],
"default": null,
"description": "A modifier object for glass with a Surface boundary condition.",
"title": "Interior Glass Modifier"
},
"exterior_glass_modifier": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
},
{
"type": "null"
}
],
"default": null,
"description": "A modifier object for glass with an Outdoors boundary condition.",
"title": "Exterior Glass Modifier"
},
"overhead_modifier": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
},
{
"type": "null"
}
],
"default": null,
"description": "A window modifier object for doors with an Outdoors boundary condition and a RoofCeiling or Floor face type for their parent face.",
"title": "Overhead Modifier"
}
},
"additionalProperties": false
}
],
"description": "Set containing radiance modifiers needed for a model's Doors.",
"title": "DoorModifierSet",
"discriminator": {
"propertyName": "type"
}
},
"DoorModifierSetAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/BaseModifierSetAbridged"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "DoorModifierSetAbridged",
"default": "DoorModifierSetAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"interior_glass_modifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of modifier object for glass with a Surface boundary condition.",
"title": "Interior Glass Modifier"
},
"exterior_glass_modifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of modifier object for glass with an Outdoors boundary condition.",
"title": "Exterior Glass Modifier"
},
"overhead_modifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of a modifier object for doors with an Outdoors boundary condition and a RoofCeiling or Floor face type for their parent face.",
"title": "Overhead Modifier"
}
},
"additionalProperties": false
}
],
"description": "Abridged set containing radiance modifiers needed for a model's Doors.",
"title": "DoorModifierSetAbridged",
"discriminator": {
"propertyName": "type"
}
},
"DoorPropertiesAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "DoorPropertiesAbridged",
"default": "DoorPropertiesAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"energy": {
"anyOf": [
{
"$ref": "#/components/schemas/DoorEnergyPropertiesAbridged"
},
{
"type": "null"
}
],
"default": null
},
"radiance": {
"anyOf": [
{
"$ref": "#/components/schemas/DoorRadiancePropertiesAbridged"
},
{
"type": "null"
}
],
"default": null
}
}
}
],
"title": "DoorPropertiesAbridged",
"discriminator": {
"propertyName": "type"
}
},
"DoorRadiancePropertiesAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_PropertiesBaseAbridged"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "DoorRadiancePropertiesAbridged",
"default": "DoorRadiancePropertiesAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"dynamic_group_identifier": {
"default": null,
"description": "An optional string to note the dynamic group ' 'to which the Door is a part of. Doors sharing the same ' 'dynamic_group_identifier will have their states change in unison. ' 'If None, the Door is assumed to be static. (default: None).",
"title": "Dynamic Group Identifier",
"type": "string"
},
"states": {
"default": null,
"description": "An optional list of abridged states (default: None).",
"items": {
"$ref": "#/components/schemas/RadianceSubFaceStateAbridged"
},
"title": "States",
"type": "array"
}
},
"additionalProperties": false
}
],
"description": "Radiance Properties for Honeybee Door Abridged.",
"title": "DoorRadiancePropertiesAbridged",
"discriminator": {
"propertyName": "type"
}
},
"EconomizerType": {
"enum": [
"NoEconomizer",
"DifferentialDryBulb",
"DifferentialEnthalpy"
],
"title": "EconomizerType",
"type": "string"
},
"ElectricEquipment": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"watts_per_area"
],
"properties": {
"watts_per_area": {
"description": "Equipment level per floor area as [W/m2].",
"minimum": 0,
"title": "Watts Per Area",
"type": "number",
"format": "double"
},
"schedule": {
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
},
{
"type": "null"
}
],
"default": null,
"description": "The schedule for the use of equipment over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the watts_per_area to yield a complete equipment profile. If None, an Always On schedule will be used.",
"title": "Schedule"
},
"radiant_fraction": {
"default": 0,
"description": "Number for the amount of long-wave radiation heat given off by equipment. Default value is 0.",
"maximum": 1,
"minimum": 0,
"title": "Radiant Fraction",
"type": "number",
"format": "double"
},
"latent_fraction": {
"default": 0,
"description": "Number for the amount of latent heat given off by equipment. Default value is 0.",
"maximum": 1,
"minimum": 0,
"title": "Latent Fraction",
"type": "number",
"format": "double"
},
"lost_fraction": {
"default": 0,
"description": "Number for the amount of \u201clost\u201d heat being given off by equipment. The default value is 0.",
"maximum": 1,
"minimum": 0,
"title": "Lost Fraction",
"type": "number",
"format": "double"
},
"type": {
"const": "ElectricEquipment",
"default": "ElectricEquipment",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"title": "ElectricEquipment",
"discriminator": {
"propertyName": "type"
}
},
"ElectricEquipmentAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_EquipmentBase"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "ElectricEquipmentAbridged",
"default": "ElectricEquipmentAbridged",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"title": "ElectricEquipmentAbridged",
"discriminator": {
"propertyName": "type"
}
},
"ElectricLoadCenter": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "ElectricLoadCenter",
"default": "ElectricLoadCenter",
"title": "Type",
"type": "string",
"readOnly": true
},
"inverter_efficiency": {
"default": 0.96,
"description": "A number between 0 and 1 for the load center inverter nominal rated DC-to-AC conversion efficiency. An inverter converts DC power, such as that output by photovoltaic panels, to AC power, such as that distributed by the electrical grid and is available from standard electrical outlets. Inverter efficiency is defined as the inverter rated AC power output divided by its rated DC power output.",
"exclusiveMinimum": 0,
"maximum": 1,
"title": "Inverter Efficiency",
"type": "number",
"format": "double"
},
"inverter_dc_to_ac_size_ratio": {
"default": 1.1,
"description": "A positive number (typically greater than 1) for the ratio of the inverter DC rated size to its AC rated size. Typically, inverters are not sized to convert the full DC output under standard test conditions (STC) as such conditions rarely occur in reality and therefore unnecessarily add to the size/cost of the inverter. For a system with a high DC to AC size ratio, during times when the DC power output exceeds the inverter rated DC input size, the inverter limits the power output by increasing the DC operating voltage, which moves the arrays operating point down its current-voltage (I-V) curve. In EnergyPlus, this is accomplished by simply limiting the system output to the AC size as dictated by the ratio. The default value of 1.1 is reasonable for most systems. A typical range is 1.1 to 1.25, although some large-scale systems have ratios of as high as 1.5. The optimal value depends on the system location, array orientation, and module cost.",
"exclusiveMinimum": 0,
"title": "Inverter Dc To Ac Size Ratio",
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
],
"title": "ElectricLoadCenter",
"discriminator": {
"propertyName": "type"
}
},
"EnergyBaseModel": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"identifier": {
"description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
"maxLength": 100,
"minLength": 1,
"pattern": "^[^,;!\\n\\t]+$",
"title": "Identifier",
"type": "string"
},
"display_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Display name of the object with no character restrictions.",
"title": "Display Name"
},
"type": {
"title": "Type",
"default": "EnergyBaseModel",
"type": "string",
"pattern": "^EnergyBaseModel$",
"readOnly": true
}
},
"additionalProperties": false,
"required": [
"identifier"
]
}
],
"description": "Base class for all objects requiring a valid EnergyPlus identifier.",
"title": "EnergyBaseModel",
"discriminator": {
"propertyName": "type"
}
},
"EnergyMaterial": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"thickness",
"conductivity",
"density",
"specific_heat"
],
"properties": {
"thickness": {
"description": "Thickness of the material layer in meters.",
"exclusiveMinimum": 0,
"maximum": 3,
"title": "Thickness",
"type": "number",
"format": "double"
},
"conductivity": {
"description": "Thermal conductivity of the material layer in W/m-K.",
"exclusiveMinimum": 0,
"title": "Conductivity",
"type": "number",
"format": "double"
},
"density": {
"description": "Density of the material layer in kg/m3.",
"exclusiveMinimum": 0,
"title": "Density",
"type": "number",
"format": "double"
},
"specific_heat": {
"description": "Specific heat of the material layer in J/kg-K.",
"minimum": 100,
"title": "Specific Heat",
"type": "number",
"format": "double"
},
"type": {
"const": "EnergyMaterial",
"default": "EnergyMaterial",
"title": "Type",
"type": "string",
"readOnly": true
},
"roughness": {
"$ref": "#/components/schemas/Roughness",
"default": "MediumRough"
},
"thermal_absorptance": {
"default": 0.9,
"description": "Fraction of incident long wavelength radiation that is absorbed by the material. Default: 0.9.",
"exclusiveMinimum": 0,
"maximum": 0.99999,
"title": "Thermal Absorptance",
"type": "number",
"format": "double"
},
"solar_absorptance": {
"default": 0.7,
"description": "Fraction of incident solar radiation absorbed by the material. Default: 0.7.",
"maximum": 1,
"minimum": 0,
"title": "Solar Absorptance",
"type": "number",
"format": "double"
},
"visible_absorptance": {
"default": 0.7,
"description": "Fraction of incident visible wavelength radiation absorbed by the material. Default: 0.7.",
"maximum": 1,
"minimum": 0,
"title": "Visible Absorptance",
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
],
"description": "Opaque material representing a layer within an opaque construction.",
"title": "EnergyMaterial",
"discriminator": {
"propertyName": "type"
}
},
"EnergyMaterialNoMass": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"r_value"
],
"properties": {
"r_value": {
"description": "The thermal resistance (R-value) of the material layer [m2-K/W].",
"minimum": 0.001,
"title": "R Value",
"type": "number",
"format": "double"
},
"type": {
"const": "EnergyMaterialNoMass",
"default": "EnergyMaterialNoMass",
"title": "Type",
"type": "string",
"readOnly": true
},
"roughness": {
"$ref": "#/components/schemas/Roughness",
"default": "MediumRough"
},
"thermal_absorptance": {
"default": 0.9,
"description": "Fraction of incident long wavelength radiation that is absorbed by the material. Default: 0.9.",
"exclusiveMinimum": 0,
"maximum": 0.99999,
"title": "Thermal Absorptance",
"type": "number",
"format": "double"
},
"solar_absorptance": {
"default": 0.7,
"description": "Fraction of incident solar radiation absorbed by the material. Default: 0.7.",
"maximum": 1,
"minimum": 0,
"title": "Solar Absorptance",
"type": "number",
"format": "double"
},
"visible_absorptance": {
"default": 0.7,
"description": "Fraction of incident visible wavelength radiation absorbed by the material. Default: 0.7.",
"maximum": 1,
"minimum": 0,
"title": "Visible Absorptance",
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
],
"description": "No mass opaque material representing a layer within an opaque construction.\n\nUsed when only the thermal resistance (R value) of the material is known.",
"title": "EnergyMaterialNoMass",
"discriminator": {
"propertyName": "type"
}
},
"EnergyMaterialVegetation": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "EnergyMaterialVegetation",
"default": "EnergyMaterialVegetation",
"title": "Type",
"type": "string",
"readOnly": true
},
"roughness": {
"$ref": "#/components/schemas/Roughness",
"default": "MediumRough"
},
"thickness": {
"default": 0.1,
"description": "Thickness of the soil layer in meters.",
"exclusiveMinimum": 0,
"maximum": 3,
"title": "Thickness",
"type": "number",
"format": "double"
},
"conductivity": {
"default": 0.35,
"description": "Thermal conductivity of the dry soil in W/m-K.",
"exclusiveMinimum": 0,
"title": "Conductivity",
"type": "number",
"format": "double"
},
"density": {
"default": 1100,
"description": "Density of the dry soil in kg/m3.",
"exclusiveMinimum": 0,
"title": "Density",
"type": "number",
"format": "double"
},
"specific_heat": {
"default": 1200,
"description": "Specific heat of the dry soil in J/kg-K.",
"minimum": 100,
"title": "Specific Heat",
"type": "number",
"format": "double"
},
"soil_thermal_absorptance": {
"default": 0.9,
"description": "Fraction of incident long wavelength radiation that is absorbed by the soil. Default: 0.9.",
"exclusiveMinimum": 0,
"maximum": 0.99999,
"title": "Soil Thermal Absorptance",
"type": "number",
"format": "double"
},
"soil_solar_absorptance": {
"default": 0.7,
"description": "Fraction of incident solar radiation absorbed by the soil. Default: 0.7.",
"maximum": 1,
"minimum": 0,
"title": "Soil Solar Absorptance",
"type": "number",
"format": "double"
},
"soil_visible_absorptance": {
"default": 0.7,
"description": "Fraction of incident visible wavelength radiation absorbed by the material. Default: 0.7.",
"maximum": 1,
"minimum": 0,
"title": "Soil Visible Absorptance",
"type": "number",
"format": "double"
},
"plant_height": {
"default": 0.2,
"description": "The height of plants in the vegetation in meters.",
"maximum": 1.0,
"minimum": 0.005,
"title": "Plant Height",
"type": "number",
"format": "double"
},
"leaf_area_index": {
"default": 1.0,
"description": "The projected leaf area per unit area of soil surface (aka. Leaf Area Index or LAI). Note that the fraction of vegetation cover is calculated directly from LAI using an empirical relation.",
"maximum": 5.0,
"minimum": 0.001,
"title": "Leaf Area Index",
"type": "number",
"format": "double"
},
"leaf_reflectivity": {
"default": 0.22,
"description": "The fraction of incident solar radiation that is reflected by the leaf surfaces. Solar radiation includes the visible spectrum as well as infrared and ultraviolet wavelengths. Typical values are 0.18 to 0.25.",
"maximum": 0.5,
"minimum": 0.005,
"title": "Leaf Reflectivity",
"type": "number",
"format": "double"
},
"leaf_emissivity": {
"default": 0.95,
"description": "The ratio of thermal radiation emitted from leaf surfaces to that emitted by an ideal black body at the same temperature.",
"maximum": 1.0,
"minimum": 0.8,
"title": "Leaf Emissivity",
"type": "number",
"format": "double"
},
"min_stomatal_resist": {
"default": 180,
"description": "The resistance of the plants to moisture transport [s/m]. Plants with low values of stomatal resistance will result in higher evapotranspiration rates than plants with high resistance.",
"maximum": 300,
"minimum": 50,
"title": "Min Stomatal Resist",
"type": "number",
"format": "double"
},
"sat_vol_moist_cont": {
"default": 0.3,
"description": "The saturation moisture content of the soil by volume.",
"maximum": 0.5,
"minimum": 0.1,
"title": "Sat Vol Moist Cont",
"type": "number",
"format": "double"
},
"residual_vol_moist_cont": {
"default": 0.01,
"description": "The residual moisture content of the soil by volume.",
"maximum": 0.1,
"minimum": 0.01,
"title": "Residual Vol Moist Cont",
"type": "number",
"format": "double"
},
"init_vol_moist_cont": {
"default": 0.01,
"description": "The initial moisture content of the soil by volume.",
"maximum": 0.5,
"minimum": 0.05,
"title": "Init Vol Moist Cont",
"type": "number",
"format": "double"
},
"moist_diff_model": {
"$ref": "#/components/schemas/MoistureDiffusionModel",
"default": "Simple"
}
},
"additionalProperties": false
}
],
"description": "Material representing vegetation on the exterior of an opaque construction.",
"title": "EnergyMaterialVegetation",
"discriminator": {
"propertyName": "type"
}
},
"EnergyWindowFrame": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"width",
"conductance"
],
"properties": {
"width": {
"description": "Number for the width of frame in plane of window [m]. The frame width is assumed to be the same on all sides of window..",
"exclusiveMinimum": 0,
"maximum": 1,
"title": "Width",
"type": "number",
"format": "double"
},
"conductance": {
"description": "Number for the thermal conductance of the frame material measured from inside to outside of the frame surface (no air films) and taking 2D conduction effects into account [W/m2-K].",
"exclusiveMinimum": 0,
"title": "Conductance",
"type": "number",
"format": "double"
},
"type": {
"const": "EnergyWindowFrame",
"default": "EnergyWindowFrame",
"title": "Type",
"type": "string",
"readOnly": true
},
"edge_to_center_ratio": {
"default": 1,
"description": "Number between 0 and 4 for the ratio of the glass conductance near the frame (excluding air films) divided by the glass conductance at the center of the glazing (excluding air films). This is used only for multi-pane glazing constructions. This ratio should usually be greater than 1.0 since the spacer material that separates the glass panes is usually more conductive than the gap between panes. A value of 1 effectively indicates no spacer. Values should usually be obtained from the LBNL WINDOW program so that the unique characteristics of the window construction can be accounted for.",
"exclusiveMinimum": 0,
"maximum": 4,
"title": "Edge To Center Ratio",
"type": "number",
"format": "double"
},
"outside_projection": {
"default": 0,
"description": "Number for the distance that the frame projects outward from the outside face of the glazing [m]. This is used to calculate shadowing of frame onto glass, solar absorbed by the frame, IR emitted and absorbed by the frame, and convection from frame.",
"maximum": 0.5,
"minimum": 0,
"title": "Outside Projection",
"type": "number",
"format": "double"
},
"inside_projection": {
"default": 0,
"description": "Number for the distance that the frame projects inward from the inside face of the glazing [m]. This is used to calculate solar absorbed by the frame, IR emitted and absorbed by the frame, and convection from frame.",
"maximum": 0.5,
"minimum": 0,
"title": "Inside Projection",
"type": "number",
"format": "double"
},
"thermal_absorptance": {
"default": 0.9,
"description": "Fraction of incident long wavelength radiation that is absorbed by the frame material.",
"exclusiveMinimum": 0,
"maximum": 0.99999,
"title": "Thermal Absorptance",
"type": "number",
"format": "double"
},
"solar_absorptance": {
"default": 0.7,
"description": "Fraction of incident solar radiation absorbed by the frame material.",
"maximum": 1,
"minimum": 0,
"title": "Solar Absorptance",
"type": "number",
"format": "double"
},
"visible_absorptance": {
"default": 0.7,
"description": "Fraction of incident visible wavelength radiation absorbed by the frame material.",
"maximum": 1,
"minimum": 0,
"title": "Visible Absorptance",
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
],
"description": "Opaque material representing a layer within an opaque construction.",
"title": "EnergyWindowFrame",
"discriminator": {
"propertyName": "type"
}
},
"EnergyWindowMaterialBlind": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "EnergyWindowMaterialBlind",
"default": "EnergyWindowMaterialBlind",
"title": "Type",
"type": "string",
"readOnly": true
},
"slat_orientation": {
"$ref": "#/components/schemas/SlatOrientation",
"default": "Horizontal"
},
"slat_width": {
"default": 0.025,
"description": "The width of slat measured from edge to edge in meters.",
"exclusiveMinimum": 0,
"maximum": 1,
"title": "Slat Width",
"type": "number",
"format": "double"
},
"slat_separation": {
"default": 0.01875,
"description": "The distance between the front of a slat and the back of the adjacent slat in meters.",
"exclusiveMinimum": 0,
"maximum": 1,
"title": "Slat Separation",
"type": "number",
"format": "double"
},
"slat_thickness": {
"default": 0.001,
"description": "The distance between the faces of a slat in meters. The default value is 0.001.",
"exclusiveMinimum": 0,
"maximum": 0.1,
"title": "Slat Thickness",
"type": "number",
"format": "double"
},
"slat_angle": {
"default": 45,
"description": "The angle (degrees) between the glazing outward normal and the slat outward normal where the outward normal points away from the front face of the slat (degrees). The default value is 45.",
"maximum": 180,
"minimum": 0,
"title": "Slat Angle",
"type": "number",
"format": "double"
},
"slat_conductivity": {
"default": 221,
"description": "The thermal conductivity of the slat in W/(m-K). Default: 221.",
"exclusiveMinimum": 0,
"title": "Slat Conductivity",
"type": "number",
"format": "double"
},
"beam_solar_transmittance": {
"default": 0,
"description": "The beam solar transmittance of the slat, assumed to be independent of angle of incidence on the slat. Any transmitted beam radiation is assumed to be 100% diffuse (i.e., slats are translucent). The default value is 0.",
"exclusiveMaximum": 1,
"minimum": 0,
"title": "Beam Solar Transmittance",
"type": "number",
"format": "double"
},
"beam_solar_reflectance": {
"default": 0.5,
"description": "The beam solar reflectance of the front side of the slat, it is assumed to be independent of the angle of incidence. Default: 0.5.",
"exclusiveMaximum": 1,
"minimum": 0,
"title": "Beam Solar Reflectance",
"type": "number",
"format": "double"
},
"beam_solar_reflectance_back": {
"default": 0.5,
"description": "The beam solar reflectance of the back side of the slat, it is assumed to be independent of the angle of incidence. Default: 0.5.",
"exclusiveMaximum": 1,
"minimum": 0,
"title": "Beam Solar Reflectance Back",
"type": "number",
"format": "double"
},
"diffuse_solar_transmittance": {
"default": 0,
"description": "The slat transmittance for hemispherically diffuse solar radiation. Default: 0.",
"exclusiveMaximum": 1,
"minimum": 0,
"title": "Diffuse Solar Transmittance",
"type": "number",
"format": "double"
},
"diffuse_solar_reflectance": {
"default": 0.5,
"description": "The front-side slat reflectance for hemispherically diffuse solar radiation. Default: 0.5.",
"exclusiveMaximum": 1,
"minimum": 0,
"title": "Diffuse Solar Reflectance",
"type": "number",
"format": "double"
},
"diffuse_solar_reflectance_back": {
"default": 0.5,
"description": "The back-side slat reflectance for hemispherically diffuse solar radiation. Default: 0.5.",
"exclusiveMaximum": 1,
"minimum": 0,
"title": "Diffuse Solar Reflectance Back",
"type": "number",
"format": "double"
},
"beam_visible_transmittance": {
"default": 0,
"description": "The beam visible transmittance of the slat, it is assumed to be independent of the angle of incidence. Default: 0.",
"exclusiveMaximum": 1,
"minimum": 0,
"title": "Beam Visible Transmittance",
"type": "number",
"format": "double"
},
"beam_visible_reflectance": {
"default": 0.5,
"description": "The beam visible reflectance on the front side of the slat, it is assumed to be independent of the angle of incidence. Default: 0.5.",
"exclusiveMaximum": 1,
"minimum": 0,
"title": "Beam Visible Reflectance",
"type": "number",
"format": "double"
},
"beam_visible_reflectance_back": {
"default": 0.5,
"description": "The beam visible reflectance on the back side of the slat, it is assumed to be independent of the angle of incidence. Default: 0.5.",
"exclusiveMaximum": 1,
"minimum": 0,
"title": "Beam Visible Reflectance Back",
"type": "number",
"format": "double"
},
"diffuse_visible_transmittance": {
"default": 0,
"description": "The slat transmittance for hemispherically diffuse visible radiation. This value should equal \u201cSlat Beam Visible Transmittance.\u201d",
"exclusiveMaximum": 1,
"minimum": 0,
"title": "Diffuse Visible Transmittance",
"type": "number",
"format": "double"
},
"diffuse_visible_reflectance": {
"default": 0.5,
"description": "The front-side slat reflectance for hemispherically diffuse visible radiation. This value should equal \u201cFront Side Slat Beam Visible Reflectance.\u201d Default: 0.5.",
"exclusiveMaximum": 1,
"minimum": 0,
"title": "Diffuse Visible Reflectance",
"type": "number",
"format": "double"
},
"diffuse_visible_reflectance_back": {
"default": 0.5,
"description": "The back-side slat reflectance for hemispherically diffuse visible radiation. This value should equal \u201cBack Side Slat Beam Visible Reflectance. Default: 0.5.\u201d",
"exclusiveMaximum": 1,
"minimum": 0,
"title": "Diffuse Visible Reflectance Back",
"type": "number",
"format": "double"
},
"infrared_transmittance": {
"default": 0,
"description": "The slat infrared hemispherical transmittance. It is zero for solid metallic, wooden or glass slats, but may be non-zero in some cases such as for thin plastic slats. The default value is 0.",
"exclusiveMaximum": 1,
"minimum": 0,
"title": "Infrared Transmittance",
"type": "number",
"format": "double"
},
"emissivity": {
"default": 0.9,
"description": "Front side hemispherical emissivity of the slat. Default is 0.9 for most materials. The default value is 0.9.",
"exclusiveMaximum": 1,
"minimum": 0,
"title": "Emissivity",
"type": "number",
"format": "double"
},
"emissivity_back": {
"default": 0.9,
"description": "Back side hemispherical emissivity of the slat. Default is 0.9 for most materials. The default value is 0.9.",
"exclusiveMaximum": 1,
"minimum": 0,
"title": "Emissivity Back",
"type": "number",
"format": "double"
},
"distance_to_glass": {
"default": 0.05,
"description": "The distance from the mid-plane of the blind to the adjacent glass in meters. The default value is 0.05.",
"maximum": 1,
"minimum": 0.01,
"title": "Distance To Glass",
"type": "number",
"format": "double"
},
"top_opening_multiplier": {
"default": 0.5,
"description": "The effective area for air flow at the top of the shade, divided by the horizontal area between glass and shade.",
"maximum": 1,
"minimum": 0,
"title": "Top Opening Multiplier",
"type": "number",
"format": "double"
},
"bottom_opening_multiplier": {
"default": 0.5,
"description": "The effective area for air flow at the bottom of the shade, divided by the horizontal area between glass and shade.",
"maximum": 1,
"minimum": 0,
"title": "Bottom Opening Multiplier",
"type": "number",
"format": "double"
},
"left_opening_multiplier": {
"default": 0.5,
"description": "The effective area for air flow at the left side of the shade, divided by the vertical area between glass and shade.",
"maximum": 1,
"minimum": 0,
"title": "Left Opening Multiplier",
"type": "number",
"format": "double"
},
"right_opening_multiplier": {
"default": 0.5,
"description": "The effective area for air flow at the right side of the shade, divided by the vertical area between glass and shade.",
"maximum": 1,
"minimum": 0,
"title": "Right Opening Multiplier",
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
],
"description": "Window blind material consisting of flat, equally-spaced slats.",
"title": "EnergyWindowMaterialBlind",
"discriminator": {
"propertyName": "type"
}
},
"EnergyWindowMaterialGas": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "EnergyWindowMaterialGas",
"default": "EnergyWindowMaterialGas",
"title": "Type",
"type": "string",
"readOnly": true
},
"thickness": {
"default": 0.0125,
"description": "Thickness of the gas layer in meters. Default: 0.0125.",
"exclusiveMinimum": 0,
"title": "Thickness",
"type": "number",
"format": "double"
},
"gas_type": {
"$ref": "#/components/schemas/GasType",
"default": "Air"
}
},
"additionalProperties": false
}
],
"description": "Create single layer of gas in a window construction.\n\nCan be combined with EnergyWindowMaterialGlazing to make multi-pane windows.",
"title": "EnergyWindowMaterialGas",
"discriminator": {
"propertyName": "type"
}
},
"EnergyWindowMaterialGasCustom": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"conductivity_coeff_a",
"viscosity_coeff_a",
"specific_heat_coeff_a",
"specific_heat_ratio",
"molecular_weight"
],
"properties": {
"conductivity_coeff_a": {
"description": "The A coefficient for gas conductivity in W/(m-K).",
"title": "Conductivity Coeff A",
"type": "number",
"format": "double"
},
"viscosity_coeff_a": {
"description": "The A coefficient for gas viscosity in kg/(m-s).",
"exclusiveMinimum": 0,
"title": "Viscosity Coeff A",
"type": "number",
"format": "double"
},
"specific_heat_coeff_a": {
"description": "The A coefficient for gas specific heat in J/(kg-K).",
"exclusiveMinimum": 0,
"title": "Specific Heat Coeff A",
"type": "number",
"format": "double"
},
"specific_heat_ratio": {
"description": "The specific heat ratio for gas.",
"exclusiveMinimum": 1,
"title": "Specific Heat Ratio",
"type": "number",
"format": "double"
},
"molecular_weight": {
"description": "The molecular weight for gas in g/mol.",
"maximum": 200,
"minimum": 20,
"title": "Molecular Weight",
"type": "number",
"format": "double"
},
"type": {
"const": "EnergyWindowMaterialGasCustom",
"default": "EnergyWindowMaterialGasCustom",
"title": "Type",
"type": "string",
"readOnly": true
},
"thickness": {
"default": 0.0125,
"description": "Thickness of the gas layer in meters. Default: 0.0125.",
"exclusiveMinimum": 0,
"title": "Thickness",
"type": "number",
"format": "double"
},
"conductivity_coeff_b": {
"default": 0,
"description": "The B coefficient for gas conductivity in W/(m-K2).",
"title": "Conductivity Coeff B",
"type": "number",
"format": "double"
},
"conductivity_coeff_c": {
"default": 0,
"description": "The C coefficient for gas conductivity in W/(m-K3).",
"title": "Conductivity Coeff C",
"type": "number",
"format": "double"
},
"viscosity_coeff_b": {
"default": 0,
"description": "The B coefficient for gas viscosity in kg/(m-s-K).",
"title": "Viscosity Coeff B",
"type": "number",
"format": "double"
},
"viscosity_coeff_c": {
"default": 0,
"description": "The C coefficient for gas viscosity in kg/(m-s-K2).",
"title": "Viscosity Coeff C",
"type": "number",
"format": "double"
},
"specific_heat_coeff_b": {
"default": 0,
"description": "The B coefficient for gas specific heat in J/(kg-K2).",
"title": "Specific Heat Coeff B",
"type": "number",
"format": "double"
},
"specific_heat_coeff_c": {
"default": 0,
"description": "The C coefficient for gas specific heat in J/(kg-K3).",
"title": "Specific Heat Coeff C",
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
],
"description": "Create single layer of custom gas.",
"title": "EnergyWindowMaterialGasCustom",
"discriminator": {
"propertyName": "type"
}
},
"EnergyWindowMaterialGasMixture": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"gas_types",
"gas_fractions"
],
"properties": {
"gas_types": {
"description": "List of gases in the gas mixture.",
"items": {
"$ref": "#/components/schemas/GasType"
},
"maxItems": 4,
"minItems": 2,
"title": "Gas Types",
"type": "array"
},
"gas_fractions": {
"description": "A list of fractional numbers describing the volumetric fractions of gas types in the mixture. This list must align with the gas_types list and must sum to 1.",
"items": {
"exclusiveMaximum": 1,
"exclusiveMinimum": 0,
"type": "number",
"format": "double"
},
"maxItems": 4,
"minItems": 2,
"title": "Gas Fractions",
"type": "array"
},
"type": {
"const": "EnergyWindowMaterialGasMixture",
"default": "EnergyWindowMaterialGasMixture",
"title": "Type",
"type": "string",
"readOnly": true
},
"thickness": {
"default": 0.0125,
"description": "The thickness of the gas mixture layer in meters.",
"exclusiveMinimum": 0,
"title": "Thickness",
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
],
"description": "Create a mixture of two to four different gases to fill the panes of multiple\npane windows.",
"title": "EnergyWindowMaterialGasMixture",
"discriminator": {
"propertyName": "type"
}
},
"EnergyWindowMaterialGlazing": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "EnergyWindowMaterialGlazing",
"default": "EnergyWindowMaterialGlazing",
"title": "Type",
"type": "string",
"readOnly": true
},
"thickness": {
"default": 0.003,
"description": "The surface-to-surface thickness of the glass in meters. Default: 0.003.",
"exclusiveMinimum": 0,
"title": "Thickness",
"type": "number",
"format": "double"
},
"solar_transmittance": {
"default": 0.85,
"description": "Transmittance of solar radiation through the glass at normal incidence. Default: 0.85 for clear glass.",
"maximum": 1,
"minimum": 0,
"title": "Solar Transmittance",
"type": "number",
"format": "double"
},
"solar_reflectance": {
"default": 0.075,
"description": "Reflectance of solar radiation off of the front side of the glass at normal incidence, averaged over the solar spectrum. Default: 0.075 for clear glass.",
"maximum": 1,
"minimum": 0,
"title": "Solar Reflectance",
"type": "number",
"format": "double"
},
"solar_reflectance_back": {
"anyOf": [
{
"$ref": "#/components/schemas/Autocalculate"
},
{
"type": "number"
}
],
"default": {
"type": "Autocalculate"
},
"description": "Reflectance of solar radiation off of the back side of the glass at normal incidence, averaged over the solar spectrum.",
"ge": 0,
"le": 1,
"title": "Solar Reflectance Back"
},
"visible_transmittance": {
"default": 0.9,
"description": "Transmittance of visible light through the glass at normal incidence. Default: 0.9 for clear glass.",
"maximum": 1,
"minimum": 0,
"title": "Visible Transmittance",
"type": "number",
"format": "double"
},
"visible_reflectance": {
"default": 0.075,
"description": "Reflectance of visible light off of the front side of the glass at normal incidence. Default: 0.075 for clear glass.",
"maximum": 1,
"minimum": 0,
"title": "Visible Reflectance",
"type": "number",
"format": "double"
},
"visible_reflectance_back": {
"anyOf": [
{
"$ref": "#/components/schemas/Autocalculate"
},
{
"type": "number"
}
],
"default": {
"type": "Autocalculate"
},
"description": "Reflectance of visible light off of the back side of the glass at normal incidence averaged over the solar spectrum and weighted by the response of the human eye.",
"ge": 0,
"le": 1,
"title": "Visible Reflectance Back"
},
"infrared_transmittance": {
"default": 0,
"description": "Long-wave transmittance at normal incidence.",
"maximum": 1,
"minimum": 0,
"title": "Infrared Transmittance",
"type": "number",
"format": "double"
},
"emissivity": {
"default": 0.84,
"description": "Infrared hemispherical emissivity of the front (outward facing) side of the glass. Default: 0.84, which is typical for clear glass without a low-e coating.",
"maximum": 1,
"minimum": 0,
"title": "Emissivity",
"type": "number",
"format": "double"
},
"emissivity_back": {
"default": 0.84,
"description": "Infrared hemispherical emissivity of the back (inward facing) side of the glass. Default: 0.84, which is typical for clear glass without a low-e coating.",
"maximum": 1,
"minimum": 0,
"title": "Emissivity Back",
"type": "number",
"format": "double"
},
"conductivity": {
"default": 0.9,
"description": "Thermal conductivity of the glass in W/(m-K). Default: 0.9, which is typical for clear glass without a low-e coating.",
"exclusiveMinimum": 0,
"title": "Conductivity",
"type": "number",
"format": "double"
},
"dirt_correction": {
"default": 1,
"description": "Factor that corrects for the presence of dirt on the glass. A default value of 1 indicates the glass is clean.",
"title": "Dirt Correction",
"type": "number",
"format": "double"
},
"solar_diffusing": {
"default": false,
"description": "If False (default), the beam solar radiation incident on the glass is transmitted as beam radiation with no diffuse component.If True, the beam solar radiation incident on the glass is transmitted as hemispherical diffuse radiation with no beam component.",
"title": "Solar Diffusing",
"type": "boolean"
}
},
"additionalProperties": false
}
],
"description": "Describe a single glass pane corresponding to a layer in a window construction.",
"title": "EnergyWindowMaterialGlazing",
"discriminator": {
"propertyName": "type"
}
},
"EnergyWindowMaterialShade": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "EnergyWindowMaterialShade",
"default": "EnergyWindowMaterialShade",
"title": "Type",
"type": "string",
"readOnly": true
},
"solar_transmittance": {
"default": 0.4,
"description": "The transmittance averaged over the solar spectrum. It is assumed independent of incidence angle. Default: 0.4.",
"exclusiveMaximum": 1,
"minimum": 0,
"title": "Solar Transmittance",
"type": "number",
"format": "double"
},
"solar_reflectance": {
"default": 0.5,
"description": "The reflectance averaged over the solar spectrum. It us assumed same on both sides of shade and independent of incidence angle. Default value is 0.5",
"exclusiveMaximum": 1,
"minimum": 0,
"title": "Solar Reflectance",
"type": "number",
"format": "double"
},
"visible_transmittance": {
"default": 0.4,
"description": "The transmittance averaged over the solar spectrum and weighted by the response of the human eye. It is assumed independent of incidence angle. Default: 0.4.",
"exclusiveMaximum": 1,
"minimum": 0,
"title": "Visible Transmittance",
"type": "number",
"format": "double"
},
"visible_reflectance": {
"default": 0.4,
"description": "The transmittance averaged over the solar spectrum and weighted by the response of the human eye. It is assumed independent of incidence angle. Default: 0.4",
"exclusiveMaximum": 1,
"minimum": 0,
"title": "Visible Reflectance",
"type": "number",
"format": "double"
},
"emissivity": {
"default": 0.9,
"description": "The effective long-wave infrared hemispherical emissivity. It is assumed same on both sides of shade. Default: 0.9.",
"exclusiveMaximum": 1,
"exclusiveMinimum": 0,
"title": "Emissivity",
"type": "number",
"format": "double"
},
"infrared_transmittance": {
"default": 0,
"description": "The effective long-wave transmittance. It is assumed independent of incidence angle. Default: 0.",
"exclusiveMaximum": 1,
"minimum": 0,
"title": "Infrared Transmittance",
"type": "number",
"format": "double"
},
"thickness": {
"default": 0.005,
"description": "The thickness of the shade material in meters. Default: 0.005.",
"exclusiveMinimum": 0,
"title": "Thickness",
"type": "number",
"format": "double"
},
"conductivity": {
"default": 0.1,
"description": "The conductivity of the shade material in W/(m-K). Default value is 0.1.",
"exclusiveMinimum": 0,
"title": "Conductivity",
"type": "number",
"format": "double"
},
"distance_to_glass": {
"default": 0.05,
"description": "The distance from shade to adjacent glass in meters. Default value is 0.05",
"maximum": 1,
"minimum": 0.001,
"title": "Distance To Glass",
"type": "number",
"format": "double"
},
"top_opening_multiplier": {
"default": 0.5,
"description": "The effective area for air flow at the top of the shade, divided by the horizontal area between glass and shade. Default: 0.5.",
"maximum": 1,
"minimum": 0,
"title": "Top Opening Multiplier",
"type": "number",
"format": "double"
},
"bottom_opening_multiplier": {
"default": 0.5,
"description": "The effective area for air flow at the bottom of the shade, divided by the horizontal area between glass and shade. Default: 0.5.",
"maximum": 1,
"minimum": 0,
"title": "Bottom Opening Multiplier",
"type": "number",
"format": "double"
},
"left_opening_multiplier": {
"default": 0.5,
"description": "The effective area for air flow at the left side of the shade, divided by the vertical area between glass and shade. Default: 0.5.",
"maximum": 1,
"minimum": 0,
"title": "Left Opening Multiplier",
"type": "number",
"format": "double"
},
"right_opening_multiplier": {
"default": 0.5,
"description": "The effective area for air flow at the right side of the shade, divided by the vertical area between glass and shade. Default: 0.5.",
"maximum": 1,
"minimum": 0,
"title": "Right Opening Multiplier",
"type": "number",
"format": "double"
},
"airflow_permeability": {
"default": 0,
"description": "The fraction of the shade surface that is open to air flow. If air cannot pass through the shade material, airflow_permeability = 0. Default: 0.",
"maximum": 0.8,
"minimum": 0,
"title": "Airflow Permeability",
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
],
"description": "This object specifies the properties of window shade materials.",
"title": "EnergyWindowMaterialShade",
"discriminator": {
"propertyName": "type"
}
},
"EnergyWindowMaterialSimpleGlazSys": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"u_factor",
"shgc"
],
"properties": {
"u_factor": {
"description": "The overall heat transfer coefficient for window system in W/m2-K. Note that constructions with U-values above 5.8 should not be assigned to skylights as this implies the resistance of the window is negative when air films are subtracted.",
"exclusiveMinimum": 0,
"maximum": 12,
"title": "U Factor",
"type": "number",
"format": "double"
},
"shgc": {
"description": "Unit-less quantity for the Solar Heat Gain Coefficient (solar transmittance + conduction) at normal incidence and vertical orientation.",
"exclusiveMaximum": 1,
"exclusiveMinimum": 0,
"title": "Shgc",
"type": "number",
"format": "double"
},
"type": {
"const": "EnergyWindowMaterialSimpleGlazSys",
"default": "EnergyWindowMaterialSimpleGlazSys",
"title": "Type",
"type": "string",
"readOnly": true
},
"vt": {
"default": 0.54,
"description": "The fraction of visible light falling on the window that makes it through the glass at normal incidence.",
"exclusiveMaximum": 1,
"exclusiveMinimum": 0,
"title": "Vt",
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
],
"description": "Describe an entire glazing system rather than individual layers.\n\nUsed when only very limited information is available on the glazing layers or when\nspecific performance levels are being targeted.",
"title": "EnergyWindowMaterialSimpleGlazSys",
"discriminator": {
"propertyName": "type"
}
},
"EvaporativeCooler": {
"allOf": [
{
"$ref": "#/components/schemas/_HeatCoolBase"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "EvaporativeCooler",
"default": "EvaporativeCooler",
"title": "Type",
"type": "string",
"readOnly": true
},
"equipment_type": {
"$ref": "#/components/schemas/EvaporativeCoolerEquipmentType",
"default": "EvapCoolers_ElectricBaseboard",
"description": "Text for the specific type of system equipment from the EvaporativeCoolerEquipmentType enumeration."
}
},
"additionalProperties": false
}
],
"description": "Direct evaporative cooling systems (with optional heating).\n\nEach room/zone will receive its own air loop sized to meet the sensible load,\nwhich contains an evaporative cooler that directly adds humidity to the room\nair to cool it. The loop contains an outdoor air mixer, which is used whenever\nthe outdoor air has a lower wet bulb temperature than the return air from\nthe room. In the event that the combination of outdoor and room return air\nair is too humid, a backup single-speed direct expansion (DX) cooling coil\nwill be used. Heating loads can be met with various options, including\nseveral types of baseboards, a furnace, or gas unit heaters.",
"title": "EvaporativeCooler",
"discriminator": {
"propertyName": "type"
}
},
"EvaporativeCoolerEquipmentType": {
"enum": [
"EvapCoolers_ElectricBaseboard",
"EvapCoolers_BoilerBaseboard",
"EvapCoolers_ASHPBaseboard",
"EvapCoolers_DHWBaseboard",
"EvapCoolers_Furnace",
"EvapCoolers_UnitHeaters",
"EvapCoolers"
],
"title": "EvaporativeCoolerEquipmentType",
"type": "string"
},
"FCU": {
"allOf": [
{
"$ref": "#/components/schemas/_HeatCoolBase"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "FCU",
"default": "FCU",
"title": "Type",
"type": "string",
"readOnly": true
},
"equipment_type": {
"$ref": "#/components/schemas/FCUEquipmentType",
"default": "FCU_Chiller_Boiler",
"description": "Text for the specific type of system equipment from the FCUEquipmentType enumeration."
}
},
"additionalProperties": false
}
],
"description": "Fan Coil Unit (FCU) heating/cooling system (with no ventilation).\n\nEach room/zone receives its own Fan Coil Unit (FCU), which meets the heating\nand cooling loads of the space. The cooling coil in the FCU is always chilled\nwater cooling coil, which is connected to a chilled water loop operating\nat 6.7C (44F). The heating coil is a hot water coil except when when electric\nbaseboards or gas heaters are specified. Hot water temperature is 82C (180F) for\nboiler/district heating and 49C (120F) when ASHP is used.",
"title": "FCU",
"discriminator": {
"propertyName": "type"
}
},
"FCUEquipmentType": {
"enum": [
"FCU_Chiller_Boiler",
"FCU_Chiller_ASHP",
"FCU_Chiller_DHW",
"FCU_Chiller_ElectricBaseboard",
"FCU_Chiller_GasHeaters",
"FCU_Chiller",
"FCU_ACChiller_Boiler",
"FCU_ACChiller_ASHP",
"FCU_ACChiller_DHW",
"FCU_ACChiller_ElectricBaseboard",
"FCU_ACChiller_GasHeaters",
"FCU_ACChiller",
"FCU_DCW_Boiler",
"FCU_DCW_ASHP",
"FCU_DCW_DHW",
"FCU_DCW_ElectricBaseboard",
"FCU_DCW_GasHeaters",
"FCU_DCW"
],
"title": "FCUEquipmentType",
"type": "string"
},
"FCUwithDOASAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_DOASBase"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "FCUwithDOASAbridged",
"default": "FCUwithDOASAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"equipment_type": {
"$ref": "#/components/schemas/FCUwithDOASEquipmentType",
"default": "DOAS_FCU_Chiller_Boiler",
"description": "Text for the specific type of system equipment from the FCUwithDOASEquipmentType enumeration."
}
},
"additionalProperties": false
}
],
"description": "Fan Coil Unit (FCU) with DOAS HVAC system.\n\nAll rooms/zones in the system are connected to a Dedicated Outdoor Air System\n(DOAS) that supplies a constant volume of ventilation air at the same temperature\nto all rooms/zones. The ventilation air temperature will vary from 21.1C (70F)\nto 15.5C (60F) depending on the outdoor air temperature (the DOAS supplies cooler air\nwhen outdoor conditions are warmer). The ventilation air temperature is maintained\nby a chilled water cooling coil and a heating coil. The heating coil is a hot\nwater coil except when electric baseboards or gas heaters are specified, in\nwhich case the heating coil is a single-speed direct expansion (DX) heat pump\nwith a backup electrical resistance coil.\n\nEach room/zone also receives its own Fan Coil Unit (FCU), which meets the heating\nand cooling loads of the space. The cooling coil in the FCU is always chilled\nwater cooling coil, which is connected to a chilled water loop operating\nat 6.7C (44F). The heating coil is a hot water coil except when when electric\nbaseboards or gas heaters are specified. Hot water temperature is 82C (180F) for\nboiler/district heating and 49C (120F) when ASHP is used.\n\nThe FCU with DOAS template is relatively close in performance to active chilled\nbeams (ACBs). When using this template to represent ACBs, care must be taken\nto ensure that the DOAS ventilation air requirement is sufficient to extract\nthe heating cooling from the ACB. If so, then this FCUwithDOAS template can be\nused but with the energy use of the FCU fans ignored.",
"title": "FCUwithDOASAbridged",
"discriminator": {
"propertyName": "type"
}
},
"FCUwithDOASEquipmentType": {
"enum": [
"DOAS_FCU_Chiller_Boiler",
"DOAS_FCU_Chiller_ASHP",
"DOAS_FCU_Chiller_DHW",
"DOAS_FCU_Chiller_ElectricBaseboard",
"DOAS_FCU_Chiller_GasHeaters",
"DOAS_FCU_Chiller",
"DOAS_FCU_ACChiller_Boiler",
"DOAS_FCU_ACChiller_ASHP",
"DOAS_FCU_ACChiller_DHW",
"DOAS_FCU_ACChiller_ElectricBaseboard",
"DOAS_FCU_ACChiller_GasHeaters",
"DOAS_FCU_ACChiller",
"DOAS_FCU_DCW_Boiler",
"DOAS_FCU_DCW_ASHP",
"DOAS_FCU_DCW_DHW",
"DOAS_FCU_DCW_ElectricBaseboard",
"DOAS_FCU_DCW_GasHeaters",
"DOAS_FCU_DCW"
],
"title": "FCUwithDOASEquipmentType",
"type": "string"
},
"Face": {
"allOf": [
{
"$ref": "#/components/schemas/IDdBaseModel"
},
{
"type": "object",
"required": [
"geometry",
"face_type",
"boundary_condition",
"properties"
],
"properties": {
"geometry": {
"$ref": "#/components/schemas/Face3D",
"description": "Planar Face3D for the geometry."
},
"face_type": {
"$ref": "#/components/schemas/FaceType"
},
"boundary_condition": {
"anyOf": [
{
"$ref": "#/components/schemas/Ground"
},
{
"$ref": "#/components/schemas/Outdoors"
},
{
"$ref": "#/components/schemas/Adiabatic"
},
{
"$ref": "#/components/schemas/Surface"
},
{
"$ref": "#/components/schemas/OtherSideTemperature"
}
],
"title": "Boundary Condition"
},
"properties": {
"$ref": "#/components/schemas/FacePropertiesAbridged",
"description": "Extension properties for particular simulation engines (Radiance, EnergyPlus)."
},
"type": {
"const": "Face",
"default": "Face",
"title": "Type",
"type": "string",
"readOnly": true
},
"apertures": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Aperture"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Apertures assigned to this Face. Should be coplanar with this Face and completely within the boundary of the Face to be valid.",
"title": "Apertures"
},
"doors": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Door"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Doors assigned to this Face. Should be coplanar with this Face and completely within the boundary of the Face to be valid.",
"title": "Doors"
},
"indoor_shades": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Shade"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Shades assigned to the interior side of this object.",
"title": "Indoor Shades"
},
"outdoor_shades": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Shade"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Shades assigned to the exterior side of this object (eg. balcony, overhang).",
"title": "Outdoor Shades"
}
},
"additionalProperties": false
}
],
"title": "Face",
"discriminator": {
"propertyName": "type"
}
},
"Face3D": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"boundary": {
"description": "A list of points representing the outer boundary vertices of the face. The list should include at least 3 points and each point should be a list of 3 (x, y, z) values.",
"items": {
"items": {
"type": "number",
"format": "double"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"minItems": 3,
"title": "Boundary",
"type": "array"
},
"type": {
"const": "Face3D",
"default": "Face3D",
"title": "Type",
"type": "string",
"readOnly": true
},
"holes": {
"anyOf": [
{
"items": {
"items": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"minItems": 3,
"type": "array"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional list of lists with one list for each hole in the face.Each hole should be a list of at least 3 points and each point a list of 3 (x, y, z) values. If None, it will be assumed that there are no holes in the face.",
"title": "Holes"
},
"plane": {
"anyOf": [
{
"$ref": "#/components/schemas/Plane"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional Plane indicating the plane in which the face exists.If None, the plane will usually be derived from the boundary points."
}
},
"additionalProperties": false,
"required": [
"boundary"
]
}
],
"description": "A single planar face in 3D space.",
"title": "Face3D",
"discriminator": {
"propertyName": "type"
}
},
"FaceEnergyPropertiesAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "FaceEnergyPropertiesAbridged",
"default": "FaceEnergyPropertiesAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"construction": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of an OpaqueConstruction for the Face. If None, the construction is set by the parent Room construction_set or the Model global_construction_set.",
"title": "Construction"
},
"vent_crack": {
"anyOf": [
{
"$ref": "#/components/schemas/AFNCrack"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional AFNCrack to specify airflow through a surface crack used by the AirflowNetwork."
}
},
"additionalProperties": false
}
],
"title": "FaceEnergyPropertiesAbridged",
"discriminator": {
"propertyName": "type"
}
},
"FacePropertiesAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "FacePropertiesAbridged",
"default": "FacePropertiesAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"energy": {
"anyOf": [
{
"$ref": "#/components/schemas/FaceEnergyPropertiesAbridged"
},
{
"type": "null"
}
],
"default": null
},
"radiance": {
"anyOf": [
{
"$ref": "#/components/schemas/FaceRadiancePropertiesAbridged"
},
{
"type": "null"
}
],
"default": null
}
}
}
],
"title": "FacePropertiesAbridged",
"discriminator": {
"propertyName": "type"
}
},
"FaceRadiancePropertiesAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_PropertiesBaseAbridged"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "FaceRadiancePropertiesAbridged",
"default": "FaceRadiancePropertiesAbridged",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Radiance Properties for Honeybee Face Abridged.",
"title": "FaceRadiancePropertiesAbridged",
"discriminator": {
"propertyName": "type"
}
},
"FaceType": {
"enum": [
"Wall",
"Floor",
"RoofCeiling",
"AirBoundary"
],
"title": "FaceType",
"type": "string"
},
"FloorConstructionSet": {
"allOf": [
{
"$ref": "#/components/schemas/_FaceSubSet"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "FloorConstructionSet",
"default": "FloorConstructionSet",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "A set of constructions for floor assemblies.",
"title": "FloorConstructionSet",
"discriminator": {
"propertyName": "type"
}
},
"FloorConstructionSetAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_FaceSubSetAbridged"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "FloorConstructionSetAbridged",
"default": "FloorConstructionSetAbridged",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "A set of constructions for floor assemblies.",
"title": "FloorConstructionSetAbridged",
"discriminator": {
"propertyName": "type"
}
},
"FloorModifierSet": {
"allOf": [
{
"$ref": "#/components/schemas/BaseModifierSet"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "FloorModifierSet",
"default": "FloorModifierSet",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Set containing radiance modifiers needed for a model's Floors.",
"title": "FloorModifierSet",
"discriminator": {
"propertyName": "type"
}
},
"FloorModifierSetAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/BaseModifierSetAbridged"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "FloorModifierSetAbridged",
"default": "FloorModifierSetAbridged",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Abridged set containing radiance modifiers needed for a model's Floors.",
"title": "FloorModifierSetAbridged",
"discriminator": {
"propertyName": "type"
}
},
"ForcedAirFurnace": {
"allOf": [
{
"$ref": "#/components/schemas/_TemplateSystem"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "ForcedAirFurnace",
"default": "ForcedAirFurnace",
"title": "Type",
"type": "string",
"readOnly": true
},
"equipment_type": {
"$ref": "#/components/schemas/FurnaceEquipmentType",
"default": "Furnace",
"description": "Text for the specific type of system equipment from the FurnaceEquipmentType enumeration."
}
},
"additionalProperties": false
}
],
"description": "Forced Air Furnace HVAC system (aka. System 9 or 10).\n\nForced air furnaces are intended only for spaces only requiring heating and\nventilation. Each room/zone receives its own air loop with its own gas heating\ncoil, which will supply air at a temperature up to 50C (122F) to meet the\nheating needs of the room/zone. Fans are constant volume.\n\nForcedAirFurnace systems are the traditional baseline system for storage\nspaces that only require heating.",
"title": "ForcedAirFurnace",
"discriminator": {
"propertyName": "type"
}
},
"FuelTypes": {
"description": "Designates the acceptable fuel types for process loads.",
"enum": [
"Electricity",
"NaturalGas",
"Propane",
"FuelOilNo1",
"FuelOilNo2",
"Diesel",
"Gasoline",
"Coal",
"Steam",
"DistrictHeating",
"DistrictCooling",
"OtherFuel1",
"OtherFuel2",
"None"
],
"title": "FuelTypes",
"type": "string"
},
"FurnaceEquipmentType": {
"enum": [
"Furnace",
"Furnace_Electric"
],
"title": "FurnaceEquipmentType",
"type": "string"
},
"GasEquipment": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"watts_per_area"
],
"properties": {
"watts_per_area": {
"description": "Equipment level per floor area as [W/m2].",
"minimum": 0,
"title": "Watts Per Area",
"type": "number",
"format": "double"
},
"schedule": {
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
},
{
"type": "null"
}
],
"default": null,
"description": "The schedule for the use of equipment over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the watts_per_area to yield a complete equipment profile. If None, an Always On schedule will be used.",
"title": "Schedule"
},
"radiant_fraction": {
"default": 0,
"description": "Number for the amount of long-wave radiation heat given off by equipment. Default value is 0.",
"maximum": 1,
"minimum": 0,
"title": "Radiant Fraction",
"type": "number",
"format": "double"
},
"latent_fraction": {
"default": 0,
"description": "Number for the amount of latent heat given off by equipment. Default value is 0.",
"maximum": 1,
"minimum": 0,
"title": "Latent Fraction",
"type": "number",
"format": "double"
},
"lost_fraction": {
"default": 0,
"description": "Number for the amount of \u201clost\u201d heat being given off by equipment. The default value is 0.",
"maximum": 1,
"minimum": 0,
"title": "Lost Fraction",
"type": "number",
"format": "double"
},
"type": {
"const": "GasEquipment",
"default": "GasEquipment",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"title": "GasEquipment",
"discriminator": {
"propertyName": "type"
}
},
"GasEquipmentAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_EquipmentBase"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "GasEquipmentAbridged",
"default": "GasEquipmentAbridged",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"title": "GasEquipmentAbridged",
"discriminator": {
"propertyName": "type"
}
},
"GasType": {
"enum": [
"Air",
"Argon",
"Krypton",
"Xenon"
],
"title": "GasType",
"type": "string"
},
"GasUnitHeater": {
"allOf": [
{
"$ref": "#/components/schemas/_HeatCoolBase"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "GasUnitHeater",
"default": "GasUnitHeater",
"title": "Type",
"type": "string",
"readOnly": true
},
"equipment_type": {
"$ref": "#/components/schemas/GasUnitHeaterEquipmentType",
"default": "GasHeaters",
"description": "Text for the specific type of system equipment from the GasUnitHeaterEquipmentType enumeration."
}
},
"additionalProperties": false
}
],
"description": "Gas unit heating system.\n\nGas unit systems are intended for spaces only requiring heating and no\nventilation or cooling. Each room/zone will get its own gaa heating unit\nthat satisfies the heating load.",
"title": "GasUnitHeater",
"discriminator": {
"propertyName": "type"
}
},
"GasUnitHeaterEquipmentType": {
"enum": [
"GasHeaters"
],
"title": "GasUnitHeaterEquipmentType",
"type": "string"
},
"Glass": {
"allOf": [
{
"$ref": "#/components/schemas/ModifierBase"
},
{
"type": "object",
"required": [],
"properties": {
"modifier": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
},
{
"type": "null"
}
],
"default": {
"type": "Void"
},
"description": "Material modifier.",
"title": "Modifier"
},
"dependencies": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers.",
"title": "Dependencies"
},
"r_transmissivity": {
"default": 0.0,
"description": "A value between 0 and 1 for the red channel transmissivity.",
"maximum": 1,
"minimum": 0,
"title": "R Transmissivity",
"type": "number",
"format": "double"
},
"g_transmissivity": {
"default": 0.0,
"description": "A value between 0 and 1 for the green channel transmissivity.",
"maximum": 1,
"minimum": 0,
"title": "G Transmissivity",
"type": "number",
"format": "double"
},
"b_transmissivity": {
"default": 0.0,
"description": "A value between 0 and 1 for the blue channel transmissivity.",
"maximum": 1,
"minimum": 0,
"title": "B Transmissivity",
"type": "number",
"format": "double"
},
"refraction_index": {
"anyOf": [
{
"exclusiveMinimum": 1,
"type": "number"
},
{
"type": "null"
}
],
"default": 1.52,
"description": "A value greater than 1 for the index of refraction. Typical values are 1.52 for float glass and 1.4 for ETFE.",
"title": "Refraction Index"
},
"type": {
"const": "Glass",
"default": "Glass",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Radiance glass material.",
"title": "Glass",
"discriminator": {
"propertyName": "type"
}
},
"GlobalConstructionSet": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "GlobalConstructionSet",
"default": "GlobalConstructionSet",
"title": "Type",
"type": "string",
"readOnly": true
},
"materials": {
"default": [
{
"identifier": "Generic Roof Membrane",
"display_name": null,
"user_data": null,
"type": "EnergyMaterial",
"roughness": "MediumRough",
"thickness": 0.01,
"conductivity": 0.16,
"density": 1120.0,
"specific_heat": 1460.0,
"thermal_absorptance": 0.9,
"solar_absorptance": 0.65,
"visible_absorptance": 0.65
},
{
"identifier": "Generic Acoustic Tile",
"display_name": null,
"user_data": null,
"type": "EnergyMaterial",
"roughness": "MediumSmooth",
"thickness": 0.02,
"conductivity": 0.06,
"density": 368.0,
"specific_heat": 590.0,
"thermal_absorptance": 0.9,
"solar_absorptance": 0.2,
"visible_absorptance": 0.2
},
{
"identifier": "Generic 25mm Wood",
"display_name": null,
"user_data": null,
"type": "EnergyMaterial",
"roughness": "MediumSmooth",
"thickness": 0.0254,
"conductivity": 0.15,
"density": 608.0,
"specific_heat": 1630.0,
"thermal_absorptance": 0.9,
"solar_absorptance": 0.5,
"visible_absorptance": 0.5
},
{
"identifier": "Generic HW Concrete",
"display_name": null,
"user_data": null,
"type": "EnergyMaterial",
"roughness": "MediumRough",
"thickness": 0.2,
"conductivity": 1.95,
"density": 2240.0,
"specific_heat": 900.0,
"thermal_absorptance": 0.9,
"solar_absorptance": 0.8,
"visible_absorptance": 0.8
},
{
"identifier": "Generic Window Air Gap",
"display_name": null,
"user_data": null,
"type": "EnergyWindowMaterialGas",
"thickness": 0.0127,
"gas_type": "Air"
},
{
"identifier": "Generic Gypsum Board",
"display_name": null,
"user_data": null,
"type": "EnergyMaterial",
"roughness": "MediumSmooth",
"thickness": 0.0127,
"conductivity": 0.16,
"density": 800.0,
"specific_heat": 1090.0,
"thermal_absorptance": 0.9,
"solar_absorptance": 0.5,
"visible_absorptance": 0.5
},
{
"identifier": "Generic Wall Air Gap",
"display_name": null,
"user_data": null,
"type": "EnergyMaterial",
"roughness": "Smooth",
"thickness": 0.1,
"conductivity": 0.667,
"density": 1.28,
"specific_heat": 1000.0,
"thermal_absorptance": 0.9,
"solar_absorptance": 0.7,
"visible_absorptance": 0.7
},
{
"identifier": "Generic Ceiling Air Gap",
"display_name": null,
"user_data": null,
"type": "EnergyMaterial",
"roughness": "Smooth",
"thickness": 0.1,
"conductivity": 0.556,
"density": 1.28,
"specific_heat": 1000.0,
"thermal_absorptance": 0.9,
"solar_absorptance": 0.7,
"visible_absorptance": 0.7
},
{
"identifier": "Generic Brick",
"display_name": null,
"user_data": null,
"type": "EnergyMaterial",
"roughness": "MediumRough",
"thickness": 0.1,
"conductivity": 0.9,
"density": 1920.0,
"specific_heat": 790.0,
"thermal_absorptance": 0.9,
"solar_absorptance": 0.65,
"visible_absorptance": 0.65
},
{
"identifier": "Generic 50mm Insulation",
"display_name": null,
"user_data": null,
"type": "EnergyMaterial",
"roughness": "MediumRough",
"thickness": 0.05,
"conductivity": 0.03,
"density": 43.0,
"specific_heat": 1210.0,
"thermal_absorptance": 0.9,
"solar_absorptance": 0.7,
"visible_absorptance": 0.7
},
{
"identifier": "Generic Low-e Glass",
"display_name": null,
"user_data": null,
"type": "EnergyWindowMaterialGlazing",
"thickness": 0.006,
"solar_transmittance": 0.45,
"solar_reflectance": 0.36,
"solar_reflectance_back": 0.36,
"visible_transmittance": 0.71,
"visible_reflectance": 0.21,
"visible_reflectance_back": 0.21,
"infrared_transmittance": 0.0,
"emissivity": 0.84,
"emissivity_back": 0.047,
"conductivity": 1.0,
"dirt_correction": 1.0,
"solar_diffusing": false
},
{
"identifier": "Generic Painted Metal",
"display_name": null,
"user_data": null,
"type": "EnergyMaterial",
"roughness": "Smooth",
"thickness": 0.0015,
"conductivity": 45.0,
"density": 7690.0,
"specific_heat": 410.0,
"thermal_absorptance": 0.9,
"solar_absorptance": 0.5,
"visible_absorptance": 0.5
},
{
"identifier": "Generic LW Concrete",
"display_name": null,
"user_data": null,
"type": "EnergyMaterial",
"roughness": "MediumRough",
"thickness": 0.1,
"conductivity": 0.53,
"density": 1280.0,
"specific_heat": 840.0,
"thermal_absorptance": 0.9,
"solar_absorptance": 0.8,
"visible_absorptance": 0.8
},
{
"identifier": "Generic 25mm Insulation",
"display_name": null,
"user_data": null,
"type": "EnergyMaterial",
"roughness": "MediumRough",
"thickness": 0.025,
"conductivity": 0.03,
"density": 43.0,
"specific_heat": 1210.0,
"thermal_absorptance": 0.9,
"solar_absorptance": 0.7,
"visible_absorptance": 0.7
},
{
"identifier": "Generic Clear Glass",
"display_name": null,
"user_data": null,
"type": "EnergyWindowMaterialGlazing",
"thickness": 0.006,
"solar_transmittance": 0.77,
"solar_reflectance": 0.07,
"solar_reflectance_back": 0.07,
"visible_transmittance": 0.88,
"visible_reflectance": 0.08,
"visible_reflectance_back": 0.08,
"infrared_transmittance": 0.0,
"emissivity": 0.84,
"emissivity_back": 0.84,
"conductivity": 1.0,
"dirt_correction": 1.0,
"solar_diffusing": false
}
],
"description": "Global Honeybee Energy materials.",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EnergyMaterial"
},
{
"$ref": "#/components/schemas/EnergyMaterialNoMass"
},
{
"$ref": "#/components/schemas/EnergyWindowMaterialGlazing"
},
{
"$ref": "#/components/schemas/EnergyWindowMaterialGas"
}
]
},
"readOnly": true,
"title": "Materials",
"type": "array"
},
"constructions": {
"default": [
{
"identifier": "Generic Interior Door",
"display_name": null,
"user_data": null,
"type": "OpaqueConstructionAbridged",
"materials": [
"Generic 25mm Wood"
]
},
{
"identifier": "Generic Single Pane",
"display_name": null,
"user_data": null,
"type": "WindowConstructionAbridged",
"materials": [
"Generic Clear Glass"
],
"frame": null
},
{
"identifier": "Generic Shade",
"display_name": null,
"user_data": null,
"type": "ShadeConstruction",
"solar_reflectance": 0.35,
"visible_reflectance": 0.35,
"is_specular": false
},
{
"identifier": "Generic Context",
"display_name": null,
"user_data": null,
"type": "ShadeConstruction",
"solar_reflectance": 0.2,
"visible_reflectance": 0.2,
"is_specular": false
},
{
"identifier": "Generic Interior Ceiling",
"display_name": null,
"user_data": null,
"type": "OpaqueConstructionAbridged",
"materials": [
"Generic LW Concrete",
"Generic Ceiling Air Gap",
"Generic Acoustic Tile"
]
},
{
"identifier": "Generic Interior Wall",
"display_name": null,
"user_data": null,
"type": "OpaqueConstructionAbridged",
"materials": [
"Generic Gypsum Board",
"Generic Wall Air Gap",
"Generic Gypsum Board"
]
},
{
"identifier": "Generic Exposed Floor",
"display_name": null,
"user_data": null,
"type": "OpaqueConstructionAbridged",
"materials": [
"Generic Painted Metal",
"Generic Ceiling Air Gap",
"Generic 50mm Insulation",
"Generic LW Concrete"
]
},
{
"identifier": "Generic Interior Floor",
"display_name": null,
"user_data": null,
"type": "OpaqueConstructionAbridged",
"materials": [
"Generic Acoustic Tile",
"Generic Ceiling Air Gap",
"Generic LW Concrete"
]
},
{
"identifier": "Generic Ground Slab",
"display_name": null,
"user_data": null,
"type": "OpaqueConstructionAbridged",
"materials": [
"Generic 50mm Insulation",
"Generic HW Concrete"
]
},
{
"identifier": "Generic Roof",
"display_name": null,
"user_data": null,
"type": "OpaqueConstructionAbridged",
"materials": [
"Generic Roof Membrane",
"Generic 50mm Insulation",
"Generic LW Concrete",
"Generic Ceiling Air Gap",
"Generic Acoustic Tile"
]
},
{
"identifier": "Generic Exterior Wall",
"display_name": null,
"user_data": null,
"type": "OpaqueConstructionAbridged",
"materials": [
"Generic Brick",
"Generic LW Concrete",
"Generic 50mm Insulation",
"Generic Wall Air Gap",
"Generic Gypsum Board"
]
},
{
"identifier": "Generic Underground Wall",
"display_name": null,
"user_data": null,
"type": "OpaqueConstructionAbridged",
"materials": [
"Generic 50mm Insulation",
"Generic HW Concrete",
"Generic Wall Air Gap",
"Generic Gypsum Board"
]
},
{
"identifier": "Generic Air Boundary",
"display_name": null,
"user_data": null,
"type": "AirBoundaryConstructionAbridged",
"air_mixing_per_area": 0.1,
"air_mixing_schedule": "Always On"
},
{
"identifier": "Generic Underground Roof",
"display_name": null,
"user_data": null,
"type": "OpaqueConstructionAbridged",
"materials": [
"Generic 50mm Insulation",
"Generic HW Concrete",
"Generic Ceiling Air Gap",
"Generic Acoustic Tile"
]
},
{
"identifier": "Generic Double Pane",
"display_name": null,
"user_data": null,
"type": "WindowConstructionAbridged",
"materials": [
"Generic Low-e Glass",
"Generic Window Air Gap",
"Generic Clear Glass"
],
"frame": null
},
{
"identifier": "Generic Exterior Door",
"display_name": null,
"user_data": null,
"type": "OpaqueConstructionAbridged",
"materials": [
"Generic Painted Metal",
"Generic 25mm Insulation",
"Generic Painted Metal"
]
}
],
"description": "Global Honeybee Energy constructions.",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/OpaqueConstructionAbridged"
},
{
"$ref": "#/components/schemas/WindowConstructionAbridged"
},
{
"$ref": "#/components/schemas/ShadeConstruction"
},
{
"$ref": "#/components/schemas/AirBoundaryConstructionAbridged"
}
]
},
"readOnly": true,
"title": "Constructions",
"type": "array"
},
"wall_set": {
"$ref": "#/components/schemas/WallConstructionSetAbridged",
"default": {
"interior_construction": "Generic Interior Wall",
"exterior_construction": "Generic Exterior Wall",
"ground_construction": "Generic Underground Wall",
"type": "WallConstructionSetAbridged"
},
"description": "Global Honeybee WallConstructionSet.",
"readOnly": true
},
"floor_set": {
"$ref": "#/components/schemas/FloorConstructionSetAbridged",
"default": {
"interior_construction": "Generic Interior Floor",
"exterior_construction": "Generic Exposed Floor",
"ground_construction": "Generic Ground Slab",
"type": "FloorConstructionSetAbridged"
},
"description": "Global Honeybee FloorConstructionSet.",
"readOnly": true
},
"roof_ceiling_set": {
"$ref": "#/components/schemas/RoofCeilingConstructionSetAbridged",
"default": {
"interior_construction": "Generic Interior Ceiling",
"exterior_construction": "Generic Roof",
"ground_construction": "Generic Underground Roof",
"type": "RoofCeilingConstructionSetAbridged"
},
"description": "Global Honeybee RoofCeilingConstructionSet.",
"readOnly": true
},
"aperture_set": {
"$ref": "#/components/schemas/ApertureConstructionSetAbridged",
"default": {
"type": "ApertureConstructionSetAbridged",
"interior_construction": "Generic Single Pane",
"window_construction": "Generic Double Pane",
"skylight_construction": "Generic Double Pane",
"operable_construction": "Generic Double Pane"
},
"description": "Global Honeybee ApertureConstructionSet.",
"readOnly": true
},
"door_set": {
"$ref": "#/components/schemas/DoorConstructionSetAbridged",
"default": {
"type": "DoorConstructionSetAbridged",
"interior_construction": "Generic Interior Door",
"exterior_construction": "Generic Exterior Door",
"overhead_construction": "Generic Exterior Door",
"exterior_glass_construction": "Generic Double Pane",
"interior_glass_construction": "Generic Single Pane"
},
"description": "Global Honeybee DoorConstructionSet.",
"readOnly": true
},
"shade_construction": {
"default": "Generic Shade",
"description": "Global Honeybee Construction for building-attached Shades.",
"readOnly": true,
"title": "Shade Construction",
"type": "string"
},
"context_construction": {
"default": "Generic Context",
"description": "Global Honeybee Construction for context Shades.",
"readOnly": true,
"title": "Context Construction",
"type": "string"
},
"air_boundary_construction": {
"default": "Generic Air Boundary",
"description": "Global Honeybee Construction for AirBoundary Faces.",
"readOnly": true,
"title": "Air Boundary Construction",
"type": "string"
}
},
"additionalProperties": false
}
],
"title": "GlobalConstructionSet",
"discriminator": {
"propertyName": "type"
}
},
"GlobalModifierSet": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "GlobalModifierSet",
"default": "GlobalModifierSet",
"title": "Type",
"type": "string",
"readOnly": true
},
"modifiers": {
"default": [
{
"identifier": "generic_floor_0.20",
"display_name": null,
"type": "Plastic",
"modifier": null,
"dependencies": [],
"r_reflectance": 0.2,
"g_reflectance": 0.2,
"b_reflectance": 0.2,
"specularity": 0.0,
"roughness": 0.0
},
{
"identifier": "generic_wall_0.50",
"display_name": null,
"type": "Plastic",
"modifier": null,
"dependencies": [],
"r_reflectance": 0.5,
"g_reflectance": 0.5,
"b_reflectance": 0.5,
"specularity": 0.0,
"roughness": 0.0
},
{
"identifier": "generic_ceiling_0.80",
"display_name": null,
"type": "Plastic",
"modifier": null,
"dependencies": [],
"r_reflectance": 0.8,
"g_reflectance": 0.8,
"b_reflectance": 0.8,
"specularity": 0.0,
"roughness": 0.0
},
{
"identifier": "generic_opaque_door_0.50",
"display_name": null,
"type": "Plastic",
"modifier": null,
"dependencies": [],
"r_reflectance": 0.5,
"g_reflectance": 0.5,
"b_reflectance": 0.5,
"specularity": 0.0,
"roughness": 0.0
},
{
"identifier": "generic_interior_shade_0.50",
"display_name": null,
"type": "Plastic",
"modifier": null,
"dependencies": [],
"r_reflectance": 0.5,
"g_reflectance": 0.5,
"b_reflectance": 0.5,
"specularity": 0.0,
"roughness": 0.0
},
{
"identifier": "generic_exterior_shade_0.35",
"display_name": null,
"type": "Plastic",
"modifier": null,
"dependencies": [],
"r_reflectance": 0.35,
"g_reflectance": 0.35,
"b_reflectance": 0.35,
"specularity": 0.0,
"roughness": 0.0
},
{
"identifier": "generic_context_0.20",
"display_name": null,
"type": "Plastic",
"modifier": null,
"dependencies": [],
"r_reflectance": 0.2,
"g_reflectance": 0.2,
"b_reflectance": 0.2,
"specularity": 0.0,
"roughness": 0.0
},
{
"identifier": "generic_interior_window_vis_0.88",
"display_name": null,
"type": "Glass",
"modifier": null,
"dependencies": [],
"r_transmissivity": 0.9584154328610596,
"g_transmissivity": 0.9584154328610596,
"b_transmissivity": 0.9584154328610596,
"refraction_index": null
},
{
"identifier": "generic_exterior_window_vis_0.64",
"display_name": null,
"type": "Glass",
"modifier": null,
"dependencies": [],
"r_transmissivity": 0.6975761815384331,
"g_transmissivity": 0.6975761815384331,
"b_transmissivity": 0.6975761815384331,
"refraction_index": null
},
{
"identifier": "air_boundary",
"display_name": null,
"type": "Trans",
"modifier": null,
"dependencies": [],
"r_reflectance": 1.0,
"g_reflectance": 1.0,
"b_reflectance": 1.0,
"specularity": 0.0,
"roughness": 0.0,
"transmitted_diff": 1.0,
"transmitted_spec": 1.0
}
],
"description": "Global Honeybee Radiance modifiers.",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/Trans"
}
]
},
"readOnly": true,
"title": "Modifiers",
"type": "array"
},
"wall_set": {
"$ref": "#/components/schemas/WallModifierSetAbridged",
"default": {
"exterior_modifier": "generic_wall_0.50",
"interior_modifier": "generic_wall_0.50",
"type": "WallModifierSetAbridged"
},
"description": "Global Honeybee WallModifierSet.",
"readOnly": true
},
"floor_set": {
"$ref": "#/components/schemas/FloorModifierSetAbridged",
"default": {
"exterior_modifier": "generic_floor_0.20",
"interior_modifier": "generic_floor_0.20",
"type": "FloorModifierSetAbridged"
},
"description": "Global Honeybee FloorModifierSet.",
"readOnly": true
},
"roof_ceiling_set": {
"$ref": "#/components/schemas/RoofCeilingModifierSetAbridged",
"default": {
"exterior_modifier": "generic_ceiling_0.80",
"interior_modifier": "generic_ceiling_0.80",
"type": "RoofCeilingModifierSetAbridged"
},
"description": "Global Honeybee RoofCeilingModifierSet.",
"readOnly": true
},
"aperture_set": {
"$ref": "#/components/schemas/ApertureModifierSetAbridged",
"default": {
"type": "ApertureModifierSetAbridged",
"window_modifier": "generic_exterior_window_vis_0.64",
"interior_modifier": "generic_interior_window_vis_0.88",
"skylight_modifier": "generic_exterior_window_vis_0.64",
"operable_modifier": "generic_exterior_window_vis_0.64"
},
"description": "Global Honeybee ApertureModifierSet.",
"readOnly": true
},
"door_set": {
"$ref": "#/components/schemas/DoorModifierSetAbridged",
"default": {
"exterior_modifier": "generic_opaque_door_0.50",
"interior_modifier": "generic_opaque_door_0.50",
"type": "DoorModifierSetAbridged",
"interior_glass_modifier": "generic_interior_window_vis_0.88",
"exterior_glass_modifier": "generic_exterior_window_vis_0.64",
"overhead_modifier": "generic_opaque_door_0.50"
},
"description": "Global Honeybee DoorModifierSet.",
"readOnly": true
},
"shade_set": {
"$ref": "#/components/schemas/ShadeModifierSetAbridged",
"default": {
"exterior_modifier": "generic_exterior_shade_0.35",
"interior_modifier": "generic_interior_shade_0.50",
"type": "ShadeModifierSetAbridged"
},
"description": "Global Honeybee ShadeModifierSet.",
"readOnly": true
},
"air_boundary_modifier": {
"default": "air_boundary",
"description": "Global Honeybee Modifier for AirBoundary Faces.",
"readOnly": true,
"title": "Air Boundary Modifier",
"type": "string"
},
"context_modifier": {
"default": "generic_context_0.20",
"description": "Global Honeybee Modifier for context Shades.",
"readOnly": true,
"title": "Context Modifier",
"type": "string"
}
},
"additionalProperties": false
}
],
"title": "GlobalModifierSet",
"discriminator": {
"propertyName": "type"
}
},
"Glow": {
"allOf": [
{
"$ref": "#/components/schemas/Light"
},
{
"type": "object",
"required": [],
"properties": {
"max_radius": {
"default": 0,
"description": "Maximum radius for shadow testing. Objects with zero radius are permissable and may participate in interreflection calculation (though they are not representative of real light sources). Negative values will never contribute to scene illumination.",
"title": "Max Radius",
"type": "number",
"format": "double"
},
"type": {
"const": "Glow",
"default": "Glow",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Radiance Glow material.",
"title": "Glow",
"discriminator": {
"propertyName": "type"
}
},
"Ground": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "Ground",
"default": "Ground",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"title": "Ground",
"discriminator": {
"propertyName": "type"
}
},
"IDdBaseModel": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"identifier": {
"description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, rad). This identifier is also used to reference the object across a Model. It must be < 100 characters and not contain any spaces or special characters.",
"maxLength": 100,
"minLength": 1,
"pattern": "^[.A-Za-z0-9_-]+$",
"title": "Identifier",
"type": "string"
},
"display_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Display name of the object with no character restrictions.",
"title": "Display Name"
},
"user_data": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
"title": "User Data"
},
"type": {
"title": "Type",
"default": "IDdBaseModel",
"type": "string",
"pattern": "^IDdBaseModel$",
"readOnly": true
}
},
"additionalProperties": false,
"required": [
"identifier"
]
}
],
"description": "Base class for all objects requiring a identifiers acceptable for all engines.",
"title": "IDdBaseModel",
"discriminator": {
"propertyName": "type"
}
},
"IDdEnergyBaseModel": {
"allOf": [
{
"$ref": "#/components/schemas/EnergyBaseModel"
},
{
"type": "object",
"required": [],
"properties": {
"user_data": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
"title": "User Data"
},
"type": {
"title": "Type",
"default": "IDdEnergyBaseModel",
"type": "string",
"pattern": "^IDdEnergyBaseModel$",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Base class for all objects requiring an EnergyPlus identifier and user_data.",
"title": "IDdEnergyBaseModel",
"discriminator": {
"propertyName": "type"
}
},
"IDdRadianceBaseModel": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"identifier": {
"description": "Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.",
"minLength": 1,
"pattern": "^[.A-Za-z0-9_-]+$",
"title": "Identifier",
"type": "string"
},
"display_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Display name of the object with no character restrictions.",
"title": "Display Name"
},
"type": {
"title": "Type",
"default": "IDdRadianceBaseModel",
"type": "string",
"pattern": "^IDdRadianceBaseModel$",
"readOnly": true
}
},
"additionalProperties": false,
"required": [
"identifier"
]
}
],
"description": "Base class for all objects requiring a valid Radiance identifier.",
"title": "IDdRadianceBaseModel",
"discriminator": {
"propertyName": "type"
}
},
"IdealAirSystemAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "IdealAirSystemAbridged",
"default": "IdealAirSystemAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"economizer_type": {
"$ref": "#/components/schemas/EconomizerType",
"default": "DifferentialDryBulb",
"description": "Text to indicate the type of air-side economizer used on the ideal air system. Economizers will mix in a greater amount of outdoor air to cool the zone (rather than running the cooling system) when the zone needs cooling and the outdoor air is cooler than the zone."
},
"demand_controlled_ventilation": {
"default": false,
"description": "Boolean to note whether demand controlled ventilation should be used on the system, which will vary the amount of ventilation air according to the occupancy schedule of the zone.",
"title": "Demand Controlled Ventilation",
"type": "boolean"
},
"sensible_heat_recovery": {
"default": 0,
"description": "A number between 0 and 1 for the effectiveness of sensible heat recovery within the system.",
"maximum": 1,
"minimum": 0,
"title": "Sensible Heat Recovery",
"type": "number",
"format": "double"
},
"latent_heat_recovery": {
"default": 0,
"description": "A number between 0 and 1 for the effectiveness of latent heat recovery within the system.",
"maximum": 1,
"minimum": 0,
"title": "Latent Heat Recovery",
"type": "number",
"format": "double"
},
"heating_air_temperature": {
"default": 50,
"description": "A number for the maximum heating supply air temperature [C].",
"exclusiveMaximum": 100,
"exclusiveMinimum": 0,
"title": "Heating Air Temperature",
"type": "number",
"format": "double"
},
"cooling_air_temperature": {
"default": 13,
"description": "A number for the minimum cooling supply air temperature [C].",
"exclusiveMaximum": 50,
"exclusiveMinimum": -100,
"title": "Cooling Air Temperature",
"type": "number",
"format": "double"
},
"heating_limit": {
"anyOf": [
{
"$ref": "#/components/schemas/Autosize"
},
{
"$ref": "#/components/schemas/NoLimit"
},
{
"minimum": 0,
"type": "number"
}
],
"default": {
"type": "Autosize"
},
"description": "A number for the maximum heating capacity in Watts. This can also be an Autosize object to indicate that the capacity should be determined during the EnergyPlus sizing calculation. This can also be a NoLimit object to indicate no upper limit to the heating capacity.",
"title": "Heating Limit"
},
"cooling_limit": {
"anyOf": [
{
"$ref": "#/components/schemas/Autosize"
},
{
"$ref": "#/components/schemas/NoLimit"
},
{
"minimum": 0,
"type": "number"
}
],
"default": {
"type": "Autosize"
},
"description": "A number for the maximum cooling capacity in Watts. This can also be an Autosize object to indicate that the capacity should be determined during the EnergyPlus sizing calculation. This can also be a NoLimit object to indicate no upper limit to the cooling capacity.",
"title": "Cooling Limit"
},
"heating_availability": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional identifier of a schedule to set the availability of heating over the course of the simulation.",
"title": "Heating Availability"
},
"cooling_availability": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional identifier of a schedule to set the availability of cooling over the course of the simulation.",
"title": "Cooling Availability"
}
},
"additionalProperties": false
}
],
"description": "Provides a model for an ideal HVAC system.",
"title": "IdealAirSystemAbridged",
"discriminator": {
"propertyName": "type"
}
},
"Infiltration": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"flow_per_exterior_area"
],
"properties": {
"flow_per_exterior_area": {
"description": "Number for the infiltration per exterior surface area in m3/s-m2.",
"minimum": 0,
"title": "Flow Per Exterior Area",
"type": "number",
"format": "double"
},
"type": {
"const": "Infiltration",
"default": "Infiltration",
"title": "Type",
"type": "string",
"readOnly": true
},
"schedule": {
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
},
{
"type": "null"
}
],
"default": null,
"description": "The schedule for the infiltration over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the flow_per_exterior_area to yield a complete infiltration profile. If None, an Always On schedule will be used.",
"title": "Schedule"
},
"constant_coefficient": {
"default": 1,
"minimum": 0,
"title": "Constant Coefficient",
"type": "number",
"format": "double"
},
"temperature_coefficient": {
"default": 0,
"minimum": 0,
"title": "Temperature Coefficient",
"type": "number",
"format": "double"
},
"velocity_coefficient": {
"default": 0,
"minimum": 0,
"title": "Velocity Coefficient",
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
],
"title": "Infiltration",
"discriminator": {
"propertyName": "type"
}
},
"InfiltrationAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"flow_per_exterior_area"
],
"properties": {
"flow_per_exterior_area": {
"description": "Number for the infiltration per exterior surface area in m3/s-m2.",
"minimum": 0,
"title": "Flow Per Exterior Area",
"type": "number",
"format": "double"
},
"type": {
"const": "InfiltrationAbridged",
"default": "InfiltrationAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"schedule": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of the schedule for the infiltration over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the flow_per_exterior_area to yield a complete infiltration profile. If None, an Always On schedule will be used.",
"title": "Schedule"
},
"constant_coefficient": {
"default": 1,
"minimum": 0,
"title": "Constant Coefficient",
"type": "number",
"format": "double"
},
"temperature_coefficient": {
"default": 0,
"minimum": 0,
"title": "Temperature Coefficient",
"type": "number",
"format": "double"
},
"velocity_coefficient": {
"default": 0,
"minimum": 0,
"title": "Velocity Coefficient",
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
],
"title": "InfiltrationAbridged",
"discriminator": {
"propertyName": "type"
}
},
"InternalMassAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"construction",
"area"
],
"properties": {
"construction": {
"description": "Identifier for an OpaqueConstruction that represents the material that the internal thermal mass is composed of.",
"maxLength": 100,
"minLength": 1,
"title": "Construction",
"type": "string"
},
"area": {
"description": "A number representing the surface area of the internal mass that is exposed to the Room air. This value should always be in square meters regardless of what units system the parent model is a part of.",
"exclusiveMinimum": 0,
"title": "Area",
"type": "number",
"format": "double"
},
"type": {
"const": "InternalMassAbridged",
"default": "InternalMassAbridged",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"title": "InternalMassAbridged",
"discriminator": {
"propertyName": "type"
}
},
"Light": {
"allOf": [
{
"$ref": "#/components/schemas/ModifierBase"
},
{
"type": "object",
"required": [],
"properties": {
"modifier": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
},
{
"type": "null"
}
],
"default": {
"type": "Void"
},
"description": "Material modifier.",
"title": "Modifier"
},
"dependencies": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers.",
"title": "Dependencies"
},
"r_emittance": {
"default": 0.0,
"description": "A value between 0 and 1 for the red channel of the modifier.",
"maximum": 1,
"minimum": 0,
"title": "R Emittance",
"type": "number",
"format": "double"
},
"g_emittance": {
"default": 0.0,
"description": "A value between 0 and 1 for the green channel of the modifier.",
"maximum": 1,
"minimum": 0,
"title": "G Emittance",
"type": "number",
"format": "double"
},
"b_emittance": {
"default": 0.0,
"description": "A value between 0 and 1 for the blue channel of the modifier.",
"maximum": 1,
"minimum": 0,
"title": "B Emittance",
"type": "number",
"format": "double"
},
"type": {
"const": "Light",
"default": "Light",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Radiance Light material.",
"title": "Light",
"discriminator": {
"propertyName": "type"
}
},
"Lighting": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"watts_per_area"
],
"properties": {
"watts_per_area": {
"description": "Lighting per floor area as [W/m2].",
"minimum": 0,
"title": "Watts Per Area",
"type": "number",
"format": "double"
},
"type": {
"const": "Lighting",
"default": "Lighting",
"title": "Type",
"type": "string",
"readOnly": true
},
"schedule": {
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
},
{
"type": "null"
}
],
"default": null,
"description": "The schedule for the use of lights over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the watts_per_area to yield a complete lighting profile. If None, an Always On schedule will be used.",
"title": "Schedule"
},
"visible_fraction": {
"default": 0.25,
"description": "The fraction of heat from lights that goes into the zone as visible (short-wave) radiation. (Default: 0.25).",
"maximum": 1,
"minimum": 0,
"title": "Visible Fraction",
"type": "number",
"format": "double"
},
"radiant_fraction": {
"default": 0.32,
"description": "The fraction of heat from lights that is long-wave radiation. (Default: 0.32).",
"maximum": 1,
"minimum": 0,
"title": "Radiant Fraction",
"type": "number",
"format": "double"
},
"return_air_fraction": {
"default": 0.0,
"description": "The fraction of the heat from lights that goes into the zone return air. (Default: 0).",
"maximum": 1,
"minimum": 0,
"title": "Return Air Fraction",
"type": "number",
"format": "double"
},
"baseline_watts_per_area": {
"default": 11.84029,
"description": "The baseline lighting power density in [W/m2] of floor area. This baseline is useful to track how much better the installed lights are in comparison to a standard like ASHRAE 90.1. If set to None, it will default to 11.84029 W/m2, which is that ASHRAE 90.1-2004 baseline for an office.",
"minimum": 0,
"title": "Baseline Watts Per Area",
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
],
"title": "Lighting",
"discriminator": {
"propertyName": "type"
}
},
"LightingAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"watts_per_area"
],
"properties": {
"watts_per_area": {
"description": "Lighting per floor area as [W/m2].",
"minimum": 0,
"title": "Watts Per Area",
"type": "number",
"format": "double"
},
"type": {
"const": "LightingAbridged",
"default": "LightingAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"schedule": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of the schedule for the use of lights over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the watts_per_area to yield a complete lighting profile. If None, an Always On schedule will be used.",
"title": "Schedule"
},
"visible_fraction": {
"default": 0.25,
"description": "The fraction of heat from lights that goes into the zone as visible (short-wave) radiation. (Default: 0.25).",
"maximum": 1,
"minimum": 0,
"title": "Visible Fraction",
"type": "number",
"format": "double"
},
"radiant_fraction": {
"default": 0.32,
"description": "The fraction of heat from lights that is long-wave radiation. (Default: 0.32).",
"maximum": 1,
"minimum": 0,
"title": "Radiant Fraction",
"type": "number",
"format": "double"
},
"return_air_fraction": {
"default": 0.0,
"description": "The fraction of the heat from lights that goes into the zone return air. (Default: 0).",
"maximum": 1,
"minimum": 0,
"title": "Return Air Fraction",
"type": "number",
"format": "double"
},
"baseline_watts_per_area": {
"default": 11.84029,
"description": "The baseline lighting power density in [W/m2] of floor area. This baseline is useful to track how much better the installed lights are in comparison to a standard like ASHRAE 90.1. If set to None, it will default to 11.84029 W/m2, which is that ASHRAE 90.1-2004 baseline for an office.",
"minimum": 0,
"title": "Baseline Watts Per Area",
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
],
"title": "LightingAbridged",
"discriminator": {
"propertyName": "type"
}
},
"Mesh3D": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"vertices": {
"description": "A list of points representing the vertices of the mesh. The list should include at least 3 points and each point should be a list of 3 (x, y, z) values.",
"items": {
"items": {
"type": "number",
"format": "double"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"minItems": 3,
"title": "Vertices",
"type": "array"
},
"faces": {
"description": "A list of lists with each sub-list having either 3 or 4 integers. These integers correspond to indices within the list of vertices.",
"items": {
"items": {
"minimum": 0,
"type": "integer",
"format": "int32"
},
"maxItems": 4,
"minItems": 3,
"type": "array"
},
"minItems": 1,
"title": "Faces",
"type": "array"
},
"type": {
"const": "Mesh3D",
"default": "Mesh3D",
"title": "Type",
"type": "string",
"readOnly": true
},
"colors": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Color"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional list of colors that correspond to either the faces of the mesh or the vertices of the mesh.",
"title": "Colors"
}
},
"additionalProperties": false,
"required": [
"vertices",
"faces"
]
}
],
"description": "A mesh in 3D space.",
"title": "Mesh3D",
"discriminator": {
"propertyName": "type"
}
},
"Metal": {
"allOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "Metal",
"default": "Metal",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Radiance metal material.",
"title": "Metal",
"discriminator": {
"propertyName": "type"
}
},
"Mirror": {
"allOf": [
{
"$ref": "#/components/schemas/ModifierBase"
},
{
"type": "object",
"required": [],
"properties": {
"modifier": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
},
{
"type": "null"
}
],
"default": {
"type": "Void"
},
"description": "Material modifier.",
"title": "Modifier"
},
"dependencies": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers.",
"title": "Dependencies"
},
"r_reflectance": {
"default": 1,
"description": "A value between 0 and 1 for the red channel reflectance.",
"maximum": 1,
"minimum": 0,
"title": "R Reflectance",
"type": "number",
"format": "double"
},
"g_reflectance": {
"default": 1,
"description": "A value between 0 and 1 for the green channel reflectance.",
"maximum": 1,
"minimum": 0,
"title": "G Reflectance",
"type": "number",
"format": "double"
},
"b_reflectance": {
"default": 1,
"description": "A value between 0 and 1 for the blue channel reflectance.",
"maximum": 1,
"minimum": 0,
"title": "B Reflectance",
"type": "number",
"format": "double"
},
"alternate_material": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional material (like the illum type) that may be used to specify a different material to be used for shading non-source rays. If None, this will keep the alternate_material as mirror. If this alternate material is given as Void, then the mirror surface will be invisible. Using Void is only appropriate if the surface hides other (more detailed) geometry with the same overall reflectance.",
"title": "Alternate Material"
},
"type": {
"const": "Mirror",
"default": "Mirror",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Radiance mirror material.",
"title": "Mirror",
"discriminator": {
"propertyName": "type"
}
},
"Model": {
"allOf": [
{
"$ref": "#/components/schemas/IDdBaseModel"
},
{
"type": "object",
"required": [
"properties"
],
"properties": {
"properties": {
"$ref": "#/components/schemas/ModelProperties",
"description": "Extension properties for particular simulation engines (Radiance, EnergyPlus)."
},
"type": {
"const": "Model",
"default": "Model",
"title": "Type",
"type": "string",
"readOnly": true
},
"version": {
"default": "2.0.4",
"description": "Text string for the current version of the schema.",
"pattern": "^([0-9]+)\\.([0-9]+)\\.([0-9]+)$",
"title": "Version",
"type": "string",
"readOnly": true
},
"rooms": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Room"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "A list of Rooms in the model.",
"title": "Rooms"
},
"orphaned_faces": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Face"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "A list of Faces in the model that lack a parent Room. Note that orphaned Faces are not acceptable for Models that are to be exported for energy simulation.",
"title": "Orphaned Faces"
},
"orphaned_shades": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Shade"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "A list of Shades in the model that lack a parent.",
"title": "Orphaned Shades"
},
"orphaned_apertures": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Aperture"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "A list of Apertures in the model that lack a parent Face. Note that orphaned Apertures are not acceptable for Models that are to be exported for energy simulation.",
"title": "Orphaned Apertures"
},
"orphaned_doors": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Door"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "A list of Doors in the model that lack a parent Face. Note that orphaned Doors are not acceptable for Models that are to be exported for energy simulation.",
"title": "Orphaned Doors"
},
"shade_meshes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ShadeMesh"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "A list of ShadeMesh in the model.",
"title": "Shade Meshes"
},
"units": {
"$ref": "#/components/schemas/Units",
"default": "Meters",
"description": "Text indicating the units in which the model geometry exists. This is used to scale the geometry to the correct units for simulation engines like EnergyPlus, which requires all geometry be in meters."
},
"tolerance": {
"default": 0.01,
"description": "The maximum difference between x, y, and z values at which vertices are considered equivalent. This value should be in the Model units and it is used in a variety of checks, including checks for whether Room faces form a closed volume and subsequently correcting all face normals point outward from the Room. A value of 0 will result in bypassing all checks so it is recommended that this always be a positive number when such checks have not already been performed on a Model. The default of 0.01 is suitable for models in meters.",
"minimum": 0,
"title": "Tolerance",
"type": "number",
"format": "double"
},
"angle_tolerance": {
"default": 1.0,
"description": "The max angle difference in degrees that vertices are allowed to differ from one another in order to consider them colinear. This value is used in a variety of checks, including checks for whether Room faces form a closed volume and subsequently correcting all face normals point outward from the Room. A value of 0 will result in bypassing all checks so it is recommended that this always be a positive number when such checks have not already been performed on a given Model.",
"minimum": 0,
"title": "Angle Tolerance",
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
],
"title": "Model",
"discriminator": {
"propertyName": "type"
}
},
"ModelDoe2Properties": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "ModelDoe2Properties",
"default": "ModelDoe2Properties",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"title": "ModelDoe2Properties",
"discriminator": {
"propertyName": "type"
}
},
"ModelEnergyProperties": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "ModelEnergyProperties",
"default": "ModelEnergyProperties",
"title": "Type",
"type": "string",
"readOnly": true
},
"global_construction_set": {
"$ref": "#/components/schemas/GlobalConstructionSet",
"default": {
"type": "GlobalConstructionSet",
"materials": [
{
"conductivity": 0.16,
"density": 1120.0,
"display_name": null,
"identifier": "Generic Roof Membrane",
"roughness": "MediumRough",
"solar_absorptance": 0.65,
"specific_heat": 1460.0,
"thermal_absorptance": 0.9,
"thickness": 0.01,
"type": "EnergyMaterial",
"user_data": null,
"visible_absorptance": 0.65
},
{
"conductivity": 0.06,
"density": 368.0,
"display_name": null,
"identifier": "Generic Acoustic Tile",
"roughness": "MediumSmooth",
"solar_absorptance": 0.2,
"specific_heat": 590.0,
"thermal_absorptance": 0.9,
"thickness": 0.02,
"type": "EnergyMaterial",
"user_data": null,
"visible_absorptance": 0.2
},
{
"conductivity": 0.15,
"density": 608.0,
"display_name": null,
"identifier": "Generic 25mm Wood",
"roughness": "MediumSmooth",
"solar_absorptance": 0.5,
"specific_heat": 1630.0,
"thermal_absorptance": 0.9,
"thickness": 0.0254,
"type": "EnergyMaterial",
"user_data": null,
"visible_absorptance": 0.5
},
{
"conductivity": 1.95,
"density": 2240.0,
"display_name": null,
"identifier": "Generic HW Concrete",
"roughness": "MediumRough",
"solar_absorptance": 0.8,
"specific_heat": 900.0,
"thermal_absorptance": 0.9,
"thickness": 0.2,
"type": "EnergyMaterial",
"user_data": null,
"visible_absorptance": 0.8
},
{
"display_name": null,
"gas_type": "Air",
"identifier": "Generic Window Air Gap",
"thickness": 0.0127,
"type": "EnergyWindowMaterialGas",
"user_data": null
},
{
"conductivity": 0.16,
"density": 800.0,
"display_name": null,
"identifier": "Generic Gypsum Board",
"roughness": "MediumSmooth",
"solar_absorptance": 0.5,
"specific_heat": 1090.0,
"thermal_absorptance": 0.9,
"thickness": 0.0127,
"type": "EnergyMaterial",
"user_data": null,
"visible_absorptance": 0.5
},
{
"conductivity": 0.667,
"density": 1.28,
"display_name": null,
"identifier": "Generic Wall Air Gap",
"roughness": "Smooth",
"solar_absorptance": 0.7,
"specific_heat": 1000.0,
"thermal_absorptance": 0.9,
"thickness": 0.1,
"type": "EnergyMaterial",
"user_data": null,
"visible_absorptance": 0.7
},
{
"conductivity": 0.556,
"density": 1.28,
"display_name": null,
"identifier": "Generic Ceiling Air Gap",
"roughness": "Smooth",
"solar_absorptance": 0.7,
"specific_heat": 1000.0,
"thermal_absorptance": 0.9,
"thickness": 0.1,
"type": "EnergyMaterial",
"user_data": null,
"visible_absorptance": 0.7
},
{
"conductivity": 0.9,
"density": 1920.0,
"display_name": null,
"identifier": "Generic Brick",
"roughness": "MediumRough",
"solar_absorptance": 0.65,
"specific_heat": 790.0,
"thermal_absorptance": 0.9,
"thickness": 0.1,
"type": "EnergyMaterial",
"user_data": null,
"visible_absorptance": 0.65
},
{
"conductivity": 0.03,
"density": 43.0,
"display_name": null,
"identifier": "Generic 50mm Insulation",
"roughness": "MediumRough",
"solar_absorptance": 0.7,
"specific_heat": 1210.0,
"thermal_absorptance": 0.9,
"thickness": 0.05,
"type": "EnergyMaterial",
"user_data": null,
"visible_absorptance": 0.7
},
{
"conductivity": 1.0,
"dirt_correction": 1.0,
"display_name": null,
"emissivity": 0.84,
"emissivity_back": 0.047,
"identifier": "Generic Low-e Glass",
"infrared_transmittance": 0.0,
"solar_diffusing": false,
"solar_reflectance": 0.36,
"solar_reflectance_back": 0.36,
"solar_transmittance": 0.45,
"thickness": 0.006,
"type": "EnergyWindowMaterialGlazing",
"user_data": null,
"visible_reflectance": 0.21,
"visible_reflectance_back": 0.21,
"visible_transmittance": 0.71
},
{
"conductivity": 45.0,
"density": 7690.0,
"display_name": null,
"identifier": "Generic Painted Metal",
"roughness": "Smooth",
"solar_absorptance": 0.5,
"specific_heat": 410.0,
"thermal_absorptance": 0.9,
"thickness": 0.0015,
"type": "EnergyMaterial",
"user_data": null,
"visible_absorptance": 0.5
},
{
"conductivity": 0.53,
"density": 1280.0,
"display_name": null,
"identifier": "Generic LW Concrete",
"roughness": "MediumRough",
"solar_absorptance": 0.8,
"specific_heat": 840.0,
"thermal_absorptance": 0.9,
"thickness": 0.1,
"type": "EnergyMaterial",
"user_data": null,
"visible_absorptance": 0.8
},
{
"conductivity": 0.03,
"density": 43.0,
"display_name": null,
"identifier": "Generic 25mm Insulation",
"roughness": "MediumRough",
"solar_absorptance": 0.7,
"specific_heat": 1210.0,
"thermal_absorptance": 0.9,
"thickness": 0.025,
"type": "EnergyMaterial",
"user_data": null,
"visible_absorptance": 0.7
},
{
"conductivity": 1.0,
"dirt_correction": 1.0,
"display_name": null,
"emissivity": 0.84,
"emissivity_back": 0.84,
"identifier": "Generic Clear Glass",
"infrared_transmittance": 0.0,
"solar_diffusing": false,
"solar_reflectance": 0.07,
"solar_reflectance_back": 0.07,
"solar_transmittance": 0.77,
"thickness": 0.006,
"type": "EnergyWindowMaterialGlazing",
"user_data": null,
"visible_reflectance": 0.08,
"visible_reflectance_back": 0.08,
"visible_transmittance": 0.88
}
],
"constructions": [
{
"display_name": null,
"identifier": "Generic Interior Door",
"materials": [
"Generic 25mm Wood"
],
"type": "OpaqueConstructionAbridged",
"user_data": null
},
{
"display_name": null,
"frame": null,
"identifier": "Generic Single Pane",
"materials": [
"Generic Clear Glass"
],
"type": "WindowConstructionAbridged",
"user_data": null
},
{
"display_name": null,
"identifier": "Generic Shade",
"is_specular": false,
"solar_reflectance": 0.35,
"type": "ShadeConstruction",
"user_data": null,
"visible_reflectance": 0.35
},
{
"display_name": null,
"identifier": "Generic Context",
"is_specular": false,
"solar_reflectance": 0.2,
"type": "ShadeConstruction",
"user_data": null,
"visible_reflectance": 0.2
},
{
"display_name": null,
"identifier": "Generic Interior Ceiling",
"materials": [
"Generic LW Concrete",
"Generic Ceiling Air Gap",
"Generic Acoustic Tile"
],
"type": "OpaqueConstructionAbridged",
"user_data": null
},
{
"display_name": null,
"identifier": "Generic Interior Wall",
"materials": [
"Generic Gypsum Board",
"Generic Wall Air Gap",
"Generic Gypsum Board"
],
"type": "OpaqueConstructionAbridged",
"user_data": null
},
{
"display_name": null,
"identifier": "Generic Exposed Floor",
"materials": [
"Generic Painted Metal",
"Generic Ceiling Air Gap",
"Generic 50mm Insulation",
"Generic LW Concrete"
],
"type": "OpaqueConstructionAbridged",
"user_data": null
},
{
"display_name": null,
"identifier": "Generic Interior Floor",
"materials": [
"Generic Acoustic Tile",
"Generic Ceiling Air Gap",
"Generic LW Concrete"
],
"type": "OpaqueConstructionAbridged",
"user_data": null
},
{
"display_name": null,
"identifier": "Generic Ground Slab",
"materials": [
"Generic 50mm Insulation",
"Generic HW Concrete"
],
"type": "OpaqueConstructionAbridged",
"user_data": null
},
{
"display_name": null,
"identifier": "Generic Roof",
"materials": [
"Generic Roof Membrane",
"Generic 50mm Insulation",
"Generic LW Concrete",
"Generic Ceiling Air Gap",
"Generic Acoustic Tile"
],
"type": "OpaqueConstructionAbridged",
"user_data": null
},
{
"display_name": null,
"identifier": "Generic Exterior Wall",
"materials": [
"Generic Brick",
"Generic LW Concrete",
"Generic 50mm Insulation",
"Generic Wall Air Gap",
"Generic Gypsum Board"
],
"type": "OpaqueConstructionAbridged",
"user_data": null
},
{
"display_name": null,
"identifier": "Generic Underground Wall",
"materials": [
"Generic 50mm Insulation",
"Generic HW Concrete",
"Generic Wall Air Gap",
"Generic Gypsum Board"
],
"type": "OpaqueConstructionAbridged",
"user_data": null
},
{
"air_mixing_per_area": 0.1,
"air_mixing_schedule": "Always On",
"display_name": null,
"identifier": "Generic Air Boundary",
"type": "AirBoundaryConstructionAbridged",
"user_data": null
},
{
"display_name": null,
"identifier": "Generic Underground Roof",
"materials": [
"Generic 50mm Insulation",
"Generic HW Concrete",
"Generic Ceiling Air Gap",
"Generic Acoustic Tile"
],
"type": "OpaqueConstructionAbridged",
"user_data": null
},
{
"display_name": null,
"frame": null,
"identifier": "Generic Double Pane",
"materials": [
"Generic Low-e Glass",
"Generic Window Air Gap",
"Generic Clear Glass"
],
"type": "WindowConstructionAbridged",
"user_data": null
},
{
"display_name": null,
"identifier": "Generic Exterior Door",
"materials": [
"Generic Painted Metal",
"Generic 25mm Insulation",
"Generic Painted Metal"
],
"type": "OpaqueConstructionAbridged",
"user_data": null
}
],
"wall_set": {
"exterior_construction": "Generic Exterior Wall",
"ground_construction": "Generic Underground Wall",
"interior_construction": "Generic Interior Wall",
"type": "WallConstructionSetAbridged"
},
"floor_set": {
"exterior_construction": "Generic Exposed Floor",
"ground_construction": "Generic Ground Slab",
"interior_construction": "Generic Interior Floor",
"type": "FloorConstructionSetAbridged"
},
"roof_ceiling_set": {
"exterior_construction": "Generic Roof",
"ground_construction": "Generic Underground Roof",
"interior_construction": "Generic Interior Ceiling",
"type": "RoofCeilingConstructionSetAbridged"
},
"aperture_set": {
"interior_construction": "Generic Single Pane",
"operable_construction": "Generic Double Pane",
"skylight_construction": "Generic Double Pane",
"type": "ApertureConstructionSetAbridged",
"window_construction": "Generic Double Pane"
},
"door_set": {
"exterior_construction": "Generic Exterior Door",
"exterior_glass_construction": "Generic Double Pane",
"interior_construction": "Generic Interior Door",
"interior_glass_construction": "Generic Single Pane",
"overhead_construction": "Generic Exterior Door",
"type": "DoorConstructionSetAbridged"
},
"shade_construction": "Generic Shade",
"context_construction": "Generic Context",
"air_boundary_construction": "Generic Air Boundary"
},
"description": "Global Energy construction set.",
"readOnly": true
},
"construction_sets": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/ConstructionSetAbridged"
},
{
"$ref": "#/components/schemas/ConstructionSet"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "List of all unique ConstructionSets in the Model.",
"title": "Construction Sets"
},
"constructions": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/OpaqueConstructionAbridged"
},
{
"$ref": "#/components/schemas/WindowConstructionAbridged"
},
{
"$ref": "#/components/schemas/WindowConstructionShadeAbridged"
},
{
"$ref": "#/components/schemas/AirBoundaryConstructionAbridged"
},
{
"$ref": "#/components/schemas/OpaqueConstruction"
},
{
"$ref": "#/components/schemas/WindowConstruction"
},
{
"$ref": "#/components/schemas/WindowConstructionShade"
},
{
"$ref": "#/components/schemas/WindowConstructionDynamicAbridged"
},
{
"$ref": "#/components/schemas/WindowConstructionDynamic"
},
{
"$ref": "#/components/schemas/AirBoundaryConstruction"
},
{
"$ref": "#/components/schemas/ShadeConstruction"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "A list of all unique constructions in the model. This includes constructions across all Faces, Apertures, Doors, Shades, Room ConstructionSets, and the global_construction_set.",
"title": "Constructions"
},
"materials": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EnergyMaterial"
},
{
"$ref": "#/components/schemas/EnergyMaterialNoMass"
},
{
"$ref": "#/components/schemas/EnergyMaterialVegetation"
},
{
"$ref": "#/components/schemas/EnergyWindowMaterialGlazing"
},
{
"$ref": "#/components/schemas/EnergyWindowMaterialSimpleGlazSys"
},
{
"$ref": "#/components/schemas/EnergyWindowMaterialGas"
},
{
"$ref": "#/components/schemas/EnergyWindowMaterialGasMixture"
},
{
"$ref": "#/components/schemas/EnergyWindowMaterialGasCustom"
},
{
"$ref": "#/components/schemas/EnergyWindowFrame"
},
{
"$ref": "#/components/schemas/EnergyWindowMaterialBlind"
},
{
"$ref": "#/components/schemas/EnergyWindowMaterialShade"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "A list of all unique materials in the model. This includes materials needed to make the Model constructions.",
"title": "Materials"
},
"hvacs": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/IdealAirSystemAbridged"
},
{
"$ref": "#/components/schemas/VAV"
},
{
"$ref": "#/components/schemas/PVAV"
},
{
"$ref": "#/components/schemas/PSZ"
},
{
"$ref": "#/components/schemas/PTAC"
},
{
"$ref": "#/components/schemas/ForcedAirFurnace"
},
{
"$ref": "#/components/schemas/FCUwithDOASAbridged"
},
{
"$ref": "#/components/schemas/WSHPwithDOASAbridged"
},
{
"$ref": "#/components/schemas/VRFwithDOASAbridged"
},
{
"$ref": "#/components/schemas/RadiantwithDOASAbridged"
},
{
"$ref": "#/components/schemas/FCU"
},
{
"$ref": "#/components/schemas/WSHP"
},
{
"$ref": "#/components/schemas/VRF"
},
{
"$ref": "#/components/schemas/Baseboard"
},
{
"$ref": "#/components/schemas/EvaporativeCooler"
},
{
"$ref": "#/components/schemas/Residential"
},
{
"$ref": "#/components/schemas/WindowAC"
},
{
"$ref": "#/components/schemas/GasUnitHeater"
},
{
"$ref": "#/components/schemas/Radiant"
},
{
"$ref": "#/components/schemas/DetailedHVAC"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "List of all unique HVAC systems in the Model.",
"title": "Hvacs"
},
"shws": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/SHWSystem"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "List of all unique Service Hot Water (SHW) systems in the Model.",
"title": "Shws"
},
"program_types": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/ProgramTypeAbridged"
},
{
"$ref": "#/components/schemas/ProgramType"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "List of all unique ProgramTypes in the Model.",
"title": "Program Types"
},
"schedules": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRulesetAbridged"
},
{
"$ref": "#/components/schemas/ScheduleFixedIntervalAbridged"
},
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "A list of all unique schedules in the model. This includes schedules across all HVAC systems, ProgramTypes, Rooms, and Shades.",
"title": "Schedules"
},
"schedule_type_limits": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ScheduleTypeLimit"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "A list of all unique ScheduleTypeLimits in the model. This all ScheduleTypeLimits needed to make the Model schedules.",
"title": "Schedule Type Limits"
},
"ventilation_simulation_control": {
"anyOf": [
{
"$ref": "#/components/schemas/VentilationSimulationControl"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional parameter to define the global parameters for a ventilation cooling."
},
"electric_load_center": {
"anyOf": [
{
"$ref": "#/components/schemas/ElectricLoadCenter"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional parameter object that defines the properties of the model electric loads center that manages on site electricity generation and conversion."
}
},
"additionalProperties": false
}
],
"title": "ModelEnergyProperties",
"discriminator": {
"propertyName": "type"
}
},
"ModelProperties": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "ModelProperties",
"default": "ModelProperties",
"title": "Type",
"type": "string",
"readOnly": true
},
"energy": {
"anyOf": [
{
"$ref": "#/components/schemas/ModelEnergyProperties"
},
{
"type": "null"
}
],
"default": null
},
"radiance": {
"anyOf": [
{
"$ref": "#/components/schemas/ModelRadianceProperties"
},
{
"type": "null"
}
],
"default": null
},
"doe2": {
"anyOf": [
{
"$ref": "#/components/schemas/ModelDoe2Properties"
},
{
"type": "null"
}
],
"default": null
}
}
}
],
"title": "ModelProperties",
"discriminator": {
"propertyName": "type"
}
},
"ModelRadianceProperties": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "ModelRadianceProperties",
"default": "ModelRadianceProperties",
"title": "Type",
"type": "string",
"readOnly": true
},
"global_modifier_set": {
"$ref": "#/components/schemas/GlobalModifierSet",
"default": {
"type": "GlobalModifierSet",
"modifiers": [
{
"b_reflectance": 0.2,
"dependencies": [],
"display_name": null,
"g_reflectance": 0.2,
"identifier": "generic_floor_0.20",
"modifier": null,
"r_reflectance": 0.2,
"roughness": 0.0,
"specularity": 0.0,
"type": "Plastic"
},
{
"b_reflectance": 0.5,
"dependencies": [],
"display_name": null,
"g_reflectance": 0.5,
"identifier": "generic_wall_0.50",
"modifier": null,
"r_reflectance": 0.5,
"roughness": 0.0,
"specularity": 0.0,
"type": "Plastic"
},
{
"b_reflectance": 0.8,
"dependencies": [],
"display_name": null,
"g_reflectance": 0.8,
"identifier": "generic_ceiling_0.80",
"modifier": null,
"r_reflectance": 0.8,
"roughness": 0.0,
"specularity": 0.0,
"type": "Plastic"
},
{
"b_reflectance": 0.5,
"dependencies": [],
"display_name": null,
"g_reflectance": 0.5,
"identifier": "generic_opaque_door_0.50",
"modifier": null,
"r_reflectance": 0.5,
"roughness": 0.0,
"specularity": 0.0,
"type": "Plastic"
},
{
"b_reflectance": 0.5,
"dependencies": [],
"display_name": null,
"g_reflectance": 0.5,
"identifier": "generic_interior_shade_0.50",
"modifier": null,
"r_reflectance": 0.5,
"roughness": 0.0,
"specularity": 0.0,
"type": "Plastic"
},
{
"b_reflectance": 0.35,
"dependencies": [],
"display_name": null,
"g_reflectance": 0.35,
"identifier": "generic_exterior_shade_0.35",
"modifier": null,
"r_reflectance": 0.35,
"roughness": 0.0,
"specularity": 0.0,
"type": "Plastic"
},
{
"b_reflectance": 0.2,
"dependencies": [],
"display_name": null,
"g_reflectance": 0.2,
"identifier": "generic_context_0.20",
"modifier": null,
"r_reflectance": 0.2,
"roughness": 0.0,
"specularity": 0.0,
"type": "Plastic"
},
{
"b_transmissivity": 0.9584154328610596,
"dependencies": [],
"display_name": null,
"g_transmissivity": 0.9584154328610596,
"identifier": "generic_interior_window_vis_0.88",
"modifier": null,
"r_transmissivity": 0.9584154328610596,
"refraction_index": null,
"type": "Glass"
},
{
"b_transmissivity": 0.6975761815384331,
"dependencies": [],
"display_name": null,
"g_transmissivity": 0.6975761815384331,
"identifier": "generic_exterior_window_vis_0.64",
"modifier": null,
"r_transmissivity": 0.6975761815384331,
"refraction_index": null,
"type": "Glass"
},
{
"b_reflectance": 1.0,
"dependencies": [],
"display_name": null,
"g_reflectance": 1.0,
"identifier": "air_boundary",
"modifier": null,
"r_reflectance": 1.0,
"roughness": 0.0,
"specularity": 0.0,
"transmitted_diff": 1.0,
"transmitted_spec": 1.0,
"type": "Trans"
}
],
"wall_set": {
"exterior_modifier": "generic_wall_0.50",
"interior_modifier": "generic_wall_0.50",
"type": "WallModifierSetAbridged"
},
"floor_set": {
"exterior_modifier": "generic_floor_0.20",
"interior_modifier": "generic_floor_0.20",
"type": "FloorModifierSetAbridged"
},
"roof_ceiling_set": {
"exterior_modifier": "generic_ceiling_0.80",
"interior_modifier": "generic_ceiling_0.80",
"type": "RoofCeilingModifierSetAbridged"
},
"aperture_set": {
"interior_modifier": "generic_interior_window_vis_0.88",
"operable_modifier": "generic_exterior_window_vis_0.64",
"skylight_modifier": "generic_exterior_window_vis_0.64",
"type": "ApertureModifierSetAbridged",
"window_modifier": "generic_exterior_window_vis_0.64"
},
"door_set": {
"exterior_glass_modifier": "generic_exterior_window_vis_0.64",
"exterior_modifier": "generic_opaque_door_0.50",
"interior_glass_modifier": "generic_interior_window_vis_0.88",
"interior_modifier": "generic_opaque_door_0.50",
"overhead_modifier": "generic_opaque_door_0.50",
"type": "DoorModifierSetAbridged"
},
"shade_set": {
"exterior_modifier": "generic_exterior_shade_0.35",
"interior_modifier": "generic_interior_shade_0.50",
"type": "ShadeModifierSetAbridged"
},
"air_boundary_modifier": "air_boundary",
"context_modifier": "generic_context_0.20"
},
"description": "Global Radiance modifier set.",
"readOnly": true
},
"modifiers": {
"default": null,
"description": "A list of all unique modifiers in the model. This includes modifiers across all Faces, Apertures, Doors, Shades, Room ModifierSets, and the global_modifier_set.",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
},
"title": "Modifiers",
"type": "array"
},
"modifier_sets": {
"default": null,
"description": "A list of all unique Room-Assigned ModifierSets in the Model.",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/ModifierSet"
},
{
"$ref": "#/components/schemas/ModifierSetAbridged"
}
]
},
"title": "Modifier Sets",
"type": "array"
},
"sensor_grids": {
"default": null,
"description": "An array of SensorGrids that are associated with the model.",
"items": {
"$ref": "#/components/schemas/SensorGrid"
},
"title": "Sensor Grids",
"type": "array"
},
"views": {
"default": null,
"description": "An array of Views that are associated with the model.",
"items": {
"$ref": "#/components/schemas/View"
},
"title": "Views",
"type": "array"
}
},
"additionalProperties": false
}
],
"description": "Radiance Properties for Honeybee Model.",
"title": "ModelRadianceProperties",
"discriminator": {
"propertyName": "type"
}
},
"ModifierBase": {
"allOf": [
{
"$ref": "#/components/schemas/IDdRadianceBaseModel"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "ModifierBase",
"default": "ModifierBase",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Base class for Radiance Modifiers",
"title": "ModifierBase",
"discriminator": {
"propertyName": "type"
}
},
"ModifierSet": {
"allOf": [
{
"$ref": "#/components/schemas/IDdRadianceBaseModel"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "ModifierSet",
"default": "ModifierSet",
"title": "Type",
"type": "string",
"readOnly": true
},
"wall_set": {
"anyOf": [
{
"$ref": "#/components/schemas/WallModifierSet"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional WallModifierSet object for this ModifierSet. (default: None)."
},
"floor_set": {
"anyOf": [
{
"$ref": "#/components/schemas/FloorModifierSet"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional FloorModifierSet object for this ModifierSet. (default: None)."
},
"roof_ceiling_set": {
"anyOf": [
{
"$ref": "#/components/schemas/RoofCeilingModifierSet"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional RoofCeilingModifierSet object for this ModifierSet. (default: None)."
},
"aperture_set": {
"anyOf": [
{
"$ref": "#/components/schemas/ApertureModifierSet"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional ApertureModifierSet object for this ModifierSet. (default: None)."
},
"door_set": {
"anyOf": [
{
"$ref": "#/components/schemas/DoorModifierSet"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional DoorModifierSet object for this ModifierSet. (default: None)."
},
"shade_set": {
"anyOf": [
{
"$ref": "#/components/schemas/ShadeModifierSet"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional ShadeModifierSet object for this ModifierSet. (default: None)."
},
"air_boundary_modifier": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional Modifier to be used for all Faces with an AirBoundary face type. If None, it will be the honeybee generic air wall modifier.",
"title": "Air Boundary Modifier"
}
},
"additionalProperties": false
}
],
"description": "Set containing all radiance modifiers needed to create a radiance model.",
"title": "ModifierSet",
"discriminator": {
"propertyName": "type"
}
},
"ModifierSetAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/IDdRadianceBaseModel"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "ModifierSetAbridged",
"default": "ModifierSetAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"wall_set": {
"anyOf": [
{
"$ref": "#/components/schemas/WallModifierSetAbridged"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional WallModifierSet object for this ModifierSet (default: None)."
},
"floor_set": {
"anyOf": [
{
"$ref": "#/components/schemas/FloorModifierSetAbridged"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional FloorModifierSet object for this ModifierSet (default: None)."
},
"roof_ceiling_set": {
"anyOf": [
{
"$ref": "#/components/schemas/RoofCeilingModifierSetAbridged"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional RoofCeilingModifierSet object for this ModifierSet (default: None)."
},
"aperture_set": {
"anyOf": [
{
"$ref": "#/components/schemas/ApertureModifierSetAbridged"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional ApertureModifierSet object for this ModifierSet (default: None)."
},
"door_set": {
"anyOf": [
{
"$ref": "#/components/schemas/DoorModifierSetAbridged"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional DoorModifierSet object for this ModifierSet (default: None)."
},
"shade_set": {
"anyOf": [
{
"$ref": "#/components/schemas/ShadeModifierSetAbridged"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional ShadeModifierSet object for this ModifierSet (default: None)."
},
"air_boundary_modifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional Modifier to be used for all Faces with an AirBoundary face type. If None, it will be the honeybee generic air wall modifier.",
"title": "Air Boundary Modifier"
}
},
"additionalProperties": false
}
],
"description": "Abridged set containing all modifiers needed to create a radiance model.",
"title": "ModifierSetAbridged",
"discriminator": {
"propertyName": "type"
}
},
"ModuleType": {
"enum": [
"Standard",
"Premium",
"ThinFilm"
],
"title": "ModuleType",
"type": "string"
},
"MoistureDiffusionModel": {
"description": "Acceptable values for the moisture diffusion model for vegetation.",
"enum": [
"Simple",
"Advanced"
],
"title": "MoistureDiffusionModel",
"type": "string"
},
"MountingType": {
"enum": [
"FixedOpenRack",
"FixedRoofMounted",
"OneAxis",
"OneAxisBacktracking",
"TwoAxis"
],
"title": "MountingType",
"type": "string"
},
"NoLimit": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "NoLimit",
"default": "NoLimit",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"title": "NoLimit",
"discriminator": {
"propertyName": "type"
}
},
"OpaqueConstruction": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"materials"
],
"properties": {
"materials": {
"description": "List of opaque material definitions. The order of the materials is from exterior to interior.",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EnergyMaterial"
},
{
"$ref": "#/components/schemas/EnergyMaterialNoMass"
},
{
"$ref": "#/components/schemas/EnergyMaterialVegetation"
}
]
},
"maxItems": 10,
"minItems": 1,
"title": "Materials",
"type": "array"
},
"type": {
"const": "OpaqueConstruction",
"default": "OpaqueConstruction",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Construction for opaque objects (Face, Shade, Door).",
"title": "OpaqueConstruction",
"discriminator": {
"propertyName": "type"
}
},
"OpaqueConstructionAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"materials"
],
"properties": {
"materials": {
"description": "List of strings for opaque material identifiers. The order of the materials is from exterior to interior.",
"items": {
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"maxItems": 10,
"minItems": 1,
"title": "Materials",
"type": "array"
},
"type": {
"const": "OpaqueConstructionAbridged",
"default": "OpaqueConstructionAbridged",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Construction for opaque objects (Face, Shade, Door).",
"title": "OpaqueConstructionAbridged",
"discriminator": {
"propertyName": "type"
}
},
"OtherSideTemperature": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "OtherSideTemperature",
"default": "OtherSideTemperature",
"title": "Type",
"type": "string",
"readOnly": true
},
"heat_transfer_coefficient": {
"default": 0,
"description": "A value in W/m2-K to indicate the combined convective/radiative film coefficient. If equal to 0, then the specified temperature above is equal to the exterior surface temperature. Otherwise, the temperature above is considered the outside air temperature and this coefficient is used to determine the difference between this outside air temperature and the exterior surface temperature.",
"minimum": 0,
"title": "Heat Transfer Coefficient",
"type": "number",
"format": "double"
},
"temperature": {
"anyOf": [
{
"$ref": "#/components/schemas/Autocalculate"
},
{
"type": "number"
}
],
"default": {
"type": "Autocalculate"
},
"description": "A temperature value in Celsius to note the temperature on the other side of the object. This input can also be an Autocalculate object to signify that the temperature is equal to the outdoor air temperature.",
"title": "Temperature"
}
},
"additionalProperties": false
}
],
"title": "OtherSideTemperature",
"discriminator": {
"propertyName": "type"
}
},
"Outdoors": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "Outdoors",
"default": "Outdoors",
"title": "Type",
"type": "string",
"readOnly": true
},
"sun_exposure": {
"default": true,
"description": "A boolean noting whether the boundary is exposed to sun.",
"title": "Sun Exposure",
"type": "boolean"
},
"wind_exposure": {
"default": true,
"description": "A boolean noting whether the boundary is exposed to wind.",
"title": "Wind Exposure",
"type": "boolean"
},
"view_factor": {
"anyOf": [
{
"$ref": "#/components/schemas/Autocalculate"
},
{
"type": "number"
}
],
"default": {
"type": "Autocalculate"
},
"description": "A number for the view factor to the ground. This can also be an Autocalculate object to have the view factor automatically calculated.",
"title": "View Factor"
}
},
"additionalProperties": false
}
],
"title": "Outdoors",
"discriminator": {
"propertyName": "type"
}
},
"PSZ": {
"allOf": [
{
"$ref": "#/components/schemas/_AllAirBase"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "PSZ",
"default": "PSZ",
"title": "Type",
"type": "string",
"readOnly": true
},
"equipment_type": {
"$ref": "#/components/schemas/PSZEquipmentType",
"default": "PSZAC_ElectricBaseboard",
"description": "Text for the specific type of system equipment from the PVAVEquipmentType enumeration."
}
},
"additionalProperties": false
}
],
"description": "Packaged Single-Zone (PSZ) HVAC system (aka. System 3 or 4).\n\nEach room/zone receives its own air loop with its own single-speed direct expansion\n(DX) cooling coil, which will condition the supply air to a value in between\n12.8C (55F) and 50C (122F) depending on the heating/cooling needs of the room/zone.\nAs long as a Baseboard equipment_type is NOT selected, heating will be supplied\nby a heating coil in the air loop. Otherwise, heating is accomplished with\nbaseboards and the air loop only supplies cooling and ventilation air.\nFans are constant volume.\n\nPSZ systems are the traditional baseline system for commercial buildings\nwith less than 4 stories or less than 2,300 m2 (25,000 ft2) of floor area.\nThey are also the default for all retail with less than 3 stories and all public\nassembly spaces.",
"title": "PSZ",
"discriminator": {
"propertyName": "type"
}
},
"PSZEquipmentType": {
"enum": [
"PSZAC_ElectricBaseboard",
"PSZAC_BoilerBaseboard",
"PSZAC_DHWBaseboard",
"PSZAC_GasHeaters",
"PSZAC_ElectricCoil",
"PSZAC_GasCoil",
"PSZAC_Boiler",
"PSZAC_ASHP",
"PSZAC_DHW",
"PSZAC",
"PSZAC_DCW_ElectricBaseboard",
"PSZAC_DCW_BoilerBaseboard",
"PSZAC_DCW_GasHeaters",
"PSZAC_DCW_ElectricCoil",
"PSZAC_DCW_GasCoil",
"PSZAC_DCW_Boiler",
"PSZAC_DCW_ASHP",
"PSZAC_DCW_DHW",
"PSZAC_DCW",
"PSZHP"
],
"title": "PSZEquipmentType",
"type": "string"
},
"PTAC": {
"allOf": [
{
"$ref": "#/components/schemas/_TemplateSystem"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "PTAC",
"default": "PTAC",
"title": "Type",
"type": "string",
"readOnly": true
},
"equipment_type": {
"$ref": "#/components/schemas/PTACEquipmentType",
"default": "PTAC_ElectricBaseboard",
"description": "Text for the specific type of system equipment from the PTACEquipmentType enumeration."
}
},
"additionalProperties": false
}
],
"description": "Packaged Terminal Air Conditioning (PTAC/HP) HVAC system. (aka. System 1 or 2).\n\nEach room/zone receives its own packaged unit that supplies heating, cooling\nand ventilation. Cooling is always done via a single-speed direct expansion (DX)\ncooling coil. Heating can be done via a heating coil in the unit or via an\nexternal baseboard. Fans are constant volume.\n\nPTAC/HP systems are the traditional baseline system for residential buildings.",
"title": "PTAC",
"discriminator": {
"propertyName": "type"
}
},
"PTACEquipmentType": {
"enum": [
"PTAC_ElectricBaseboard",
"PTAC_BoilerBaseboard",
"PTAC_DHWBaseboard",
"PTAC_GasHeaters",
"PTAC_ElectricCoil",
"PTAC_GasCoil",
"PTAC_Boiler",
"PTAC_ASHP",
"PTAC_DHW",
"PTAC",
"PTHP"
],
"title": "PTACEquipmentType",
"type": "string"
},
"PVAV": {
"allOf": [
{
"$ref": "#/components/schemas/_AllAirBase"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "PVAV",
"default": "PVAV",
"title": "Type",
"type": "string",
"readOnly": true
},
"equipment_type": {
"$ref": "#/components/schemas/PVAVEquipmentType",
"default": "PVAV_Boiler",
"description": "Text for the specific type of system equipment from the VAVEquipmentType enumeration."
}
},
"additionalProperties": false
}
],
"description": "Packaged Variable Air Volume (PVAV) HVAC system (aka. System 5 or 6).\n\nAll rooms/zones are connected to a central air loop that is kept at a constant\ncentral temperature of 12.8C (55F). The central temperature is maintained by a\ncooling coil, which runs whenever the combination of return air and fresh outdoor\nair is greater than 12.8C, as well as a heating coil, which runs whenever\nthe combination of return air and fresh outdoor air is less than 12.8C.\n\nEach air terminal for the connected rooms/zones contains its own reheat coil,\nwhich runs whenever the room is not in need of the cooling supplied by the 12.8C\ncentral air.\n\nThe central cooling coil is always a two-speed direct expansion (DX) coil.\nAll heating coils are hot water coils except when Gas Coil equipment_type is\nused (in which case the central coil is gas and all reheat is electric)\nor when Parallel Fan-Powered (PFP) boxes equipment_type is used (in which case\ncoils are electric resistance). Hot water temperature is 82C (180F) for\nboiler/district heating and 49C (120F) when ASHP is used.\n\nPVAV systems are the traditional baseline system for commercial buildings\nwith than 4-5 stories or between 2,300 m2 and 14,000 m2 (25,000 ft2 and\n150,000 ft2) of floor area.",
"title": "PVAV",
"discriminator": {
"propertyName": "type"
}
},
"PVAVEquipmentType": {
"enum": [
"PVAV_Boiler",
"PVAV_ASHP",
"PVAV_DHW",
"PVAV_PFP",
"PVAV_BoilerElectricReheat"
],
"title": "PVAVEquipmentType",
"type": "string"
},
"PVProperties": {
"allOf": [
{
"$ref": "#/components/schemas/EnergyBaseModel"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "PVProperties",
"default": "PVProperties",
"title": "Type",
"type": "string",
"readOnly": true
},
"rated_efficiency": {
"default": 0.15,
"description": "A number between 0 and 1 for the rated nameplate efficiency of the photovoltaic solar cells under standard test conditions (STC). Standard test conditions are 1,000 Watts per square meter solar irradiance, 25 degrees C cell temperature, and ASTM G173-03 standard spectrum. Nameplate efficiencies reported by manufacturers are typically under STC. Standard poly- or mono-crystalline silicon modules tend to have rated efficiencies in the range of 14-17%. Premium high efficiency mono-crystalline silicon modules with anti-reflective coatings can have efficiencies in the range of 18-20%. Thin film photovoltaic modules typically have efficiencies of 11% or less. (Default: 0.15 for standard silicon solar cells).",
"exclusiveMaximum": 1,
"exclusiveMinimum": 0,
"title": "Rated Efficiency",
"type": "number",
"format": "double"
},
"active_area_fraction": {
"default": 0.9,
"description": "The fraction of the parent Shade geometry that is covered in active solar cells. This fraction includes the difference between the PV panel (aka. PV module) area and the active cells within the panel as well as any losses for how the (typically rectangular) panels can be arranged on the Shade geometry. When the parent Shade geometry represents just the solar panels, this fraction is typically around 0.9 given that the framing elements of the panel reduce the overall active area. (Default: 0.9, assuming parent Shade geometry represents only the PV panel geometry).",
"exclusiveMinimum": 0,
"maximum": 1,
"title": "Active Area Fraction",
"type": "number",
"format": "double"
},
"module_type": {
"$ref": "#/components/schemas/ModuleType",
"default": "Standard",
"description": "Text to indicate the type of solar module. This is used to determine the temperature coefficients used in the simulation of the photovoltaic modules. When the rated_efficiency is between 12-18%, the Standard type is typically most appropriate. When the rated_efficiency is greater than 18%, the Premium type is likely more appropriate. When the rated_efficiency is less than 12%, this likely refers to a case where the ThinFilm module type is most appropriate."
},
"mounting_type": {
"$ref": "#/components/schemas/MountingType",
"default": "FixedOpenRack",
"description": "Text to indicate the type of mounting and/or tracking used for the photovoltaic array. Note that the OneAxis options have an axis of rotation that is determined by the azimuth of the parent Shade geometry. Also note that, in the case of one or two axis tracking, shadows on the (static) parent Shade geometry still reduce the electrical output, enabling the simulation to account for large context geometry casting shadows on the array. However, the effects of smaller detailed shading may be improperly accounted for and self shading of the dynamic panel geometry is only accounted for via the tracking_ground_coverage_ratio property on this object. FixedOpenRack refers to ground or roof mounting where the air flows freely. FixedRoofMounted refers to mounting flush with the roof with limited air flow. OneAxis refers to a fixed tilt and azimuth, which define an axis of rotation. OneAxisBacktracking is the same as OneAxis but with controls to reduce self-shade at low sun angles. TwoAxis refers to a dynamic tilt and azimuth that track the sun."
},
"system_loss_fraction": {
"default": 0.14,
"description": "A number between 0 and 1 for the fraction of the electricity output lost due to factors other than EPW weather conditions, panel efficiency/type, active area, mounting, and inverter conversion from DC to AC. Factors that should be accounted for in this input include soiling, snow, wiring losses, electrical connection losses, manufacturer defects/tolerances/mismatch in cell characteristics, losses from power grid availability, and losses due to age or light-induced degradation. Losses from these factors tend to be between 10-20% but can vary widely depending on the installation, maintenance and the grid to which the panels are connected..",
"maximum": 1,
"minimum": 0,
"title": "System Loss Fraction",
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
],
"title": "PVProperties",
"discriminator": {
"propertyName": "type"
}
},
"People": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"people_per_area"
],
"properties": {
"people_per_area": {
"description": "People per floor area expressed as [people/m2]",
"minimum": 0,
"title": "People Per Area",
"type": "number",
"format": "double"
},
"type": {
"const": "People",
"default": "People",
"title": "Type",
"type": "string",
"readOnly": true
},
"occupancy_schedule": {
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
},
{
"type": "null"
}
],
"default": null,
"description": "A schedule for the occupancy over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the people_per_area to yield a complete occupancy profile. If None, an Always On schedule will be used.",
"title": "Occupancy Schedule"
},
"activity_schedule": {
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
},
{
"type": "null"
}
],
"default": null,
"description": "A schedule for the activity of the occupants over the course of the year. The type of this schedule should be ActivityLevel and the values of the schedule equal to the number of Watts given off by an individual person in the room. If None, a default constant schedule with 120 Watts per person will be used, which is typical of awake, adult humans who are seated.",
"title": "Activity Schedule"
},
"radiant_fraction": {
"default": 0.3,
"description": "The radiant fraction of sensible heat released by people. (Default: 0.3).",
"maximum": 1,
"minimum": 0,
"title": "Radiant Fraction",
"type": "number",
"format": "double"
},
"latent_fraction": {
"anyOf": [
{
"$ref": "#/components/schemas/Autocalculate"
},
{
"maximum": 1,
"minimum": 0,
"type": "number"
}
],
"default": {
"type": "Autocalculate"
},
"description": "Number for the latent fraction of heat gain due to people or an Autocalculate object.",
"title": "Latent Fraction"
}
},
"additionalProperties": false
}
],
"title": "People",
"discriminator": {
"propertyName": "type"
}
},
"PeopleAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"people_per_area"
],
"properties": {
"people_per_area": {
"description": "People per floor area expressed as [people/m2]",
"minimum": 0,
"title": "People Per Area",
"type": "number",
"format": "double"
},
"type": {
"const": "PeopleAbridged",
"default": "PeopleAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"occupancy_schedule": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of a schedule for the occupancy over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the people_per_area to yield a complete occupancy profile. If None, an Always On schedule will be used.",
"title": "Occupancy Schedule"
},
"activity_schedule": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of a schedule for the activity of the occupants over the course of the year. The type of this schedule should be ActivityLevel and the values of the schedule equal to the number of Watts given off by an individual person in the room. If None, a default constant schedule with 120 Watts per person will be used, which is typical of awake, adult humans who are seated.",
"title": "Activity Schedule"
},
"radiant_fraction": {
"default": 0.3,
"description": "The radiant fraction of sensible heat released by people. (Default: 0.3).",
"maximum": 1,
"minimum": 0,
"title": "Radiant Fraction",
"type": "number",
"format": "double"
},
"latent_fraction": {
"anyOf": [
{
"$ref": "#/components/schemas/Autocalculate"
},
{
"maximum": 1,
"minimum": 0,
"type": "number"
}
],
"default": {
"type": "Autocalculate"
},
"description": "Number for the latent fraction of heat gain due to people or an Autocalculate object.",
"title": "Latent Fraction"
}
},
"additionalProperties": false
}
],
"title": "PeopleAbridged",
"discriminator": {
"propertyName": "type"
}
},
"Plane": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"n": {
"description": "Plane normal as 3 (x, y, z) values.",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 3,
"minItems": 3,
"title": "N",
"type": "array"
},
"o": {
"description": "Plane origin as 3 (x, y, z) values",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 3,
"minItems": 3,
"title": "O",
"type": "array"
},
"type": {
"const": "Plane",
"default": "Plane",
"title": "Type",
"type": "string",
"readOnly": true
},
"x": {
"anyOf": [
{
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Plane x-axis as 3 (x, y, z) values. If None, it is autocalculated.",
"title": "X"
}
},
"additionalProperties": false,
"required": [
"n",
"o"
]
}
],
"title": "Plane",
"discriminator": {
"propertyName": "type"
}
},
"Plastic": {
"allOf": [
{
"$ref": "#/components/schemas/ModifierBase"
},
{
"type": "object",
"required": [],
"properties": {
"modifier": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
},
{
"type": "null"
}
],
"default": {
"type": "Void"
},
"description": "Material modifier.",
"title": "Modifier"
},
"dependencies": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers.",
"title": "Dependencies"
},
"r_reflectance": {
"default": 0.0,
"description": "A value between 0 and 1 for the red channel reflectance.",
"maximum": 1,
"minimum": 0,
"title": "R Reflectance",
"type": "number",
"format": "double"
},
"g_reflectance": {
"default": 0.0,
"description": "A value between 0 and 1 for the green channel reflectance.",
"maximum": 1,
"minimum": 0,
"title": "G Reflectance",
"type": "number",
"format": "double"
},
"b_reflectance": {
"default": 0.0,
"description": "A value between 0 and 1 for the blue channel reflectance.",
"maximum": 1,
"minimum": 0,
"title": "B Reflectance",
"type": "number",
"format": "double"
},
"specularity": {
"default": 0,
"description": "A value between 0 and 1 for the fraction of specularity. Specularity fractions greater than 0.1 are not realistic for non-metallic materials.",
"maximum": 1,
"minimum": 0,
"title": "Specularity",
"type": "number",
"format": "double"
},
"roughness": {
"default": 0,
"description": "A value between 0 and 1 for the roughness, specified as the RMS slope of surface facets. Roughness greater than 0.2 are not realistic.",
"maximum": 1,
"minimum": 0,
"title": "Roughness",
"type": "number",
"format": "double"
},
"type": {
"const": "Plastic",
"default": "Plastic",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Radiance plastic material.",
"title": "Plastic",
"discriminator": {
"propertyName": "type"
}
},
"ProcessAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"watts"
],
"properties": {
"watts": {
"description": "A number for the process load power in Watts.",
"minimum": 0,
"title": "Watts",
"type": "number",
"format": "double"
},
"type": {
"const": "ProcessAbridged",
"default": "ProcessAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"schedule": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of the schedule for the use of the process over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the watts to yield a complete equipment profile. If None, an Always On schedule will be used.",
"title": "Schedule"
},
"fuel_type": {
"$ref": "#/components/schemas/FuelTypes",
"default": "Electricity",
"description": "Text to denote the type of fuel consumed by the process. Using the \"None\" type indicates that no end uses will be associated with the process, only the zone gains."
},
"end_use_category": {
"default": "Process",
"description": "Text to indicate the end-use subcategory, which will identify the process load in the end use output. For example, \u201cCooking\u201d, \u201cClothes Drying\u201d, etc. A new meter for reporting is created for each unique subcategory.",
"maxLength": 100,
"minLength": 1,
"title": "End Use Category",
"type": "string"
},
"radiant_fraction": {
"default": 0,
"description": "Number for the amount of long-wave radiation heat given off by the process load. Default value is 0.",
"maximum": 1,
"minimum": 0,
"title": "Radiant Fraction",
"type": "number",
"format": "double"
},
"latent_fraction": {
"default": 0,
"description": "Number for the amount of latent heat given off by the process load. Default value is 0.",
"maximum": 1,
"minimum": 0,
"title": "Latent Fraction",
"type": "number",
"format": "double"
},
"lost_fraction": {
"default": 0,
"description": "Number for the amount of \u201clost\u201d heat being given off by the process load. The default value is 0.",
"maximum": 1,
"minimum": 0,
"title": "Lost Fraction",
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
],
"title": "ProcessAbridged",
"discriminator": {
"propertyName": "type"
}
},
"ProgramType": {
"allOf": [
{
"$ref": "#/components/schemas/ProgramTypeAbridged"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "ProgramType",
"default": "ProgramType",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"title": "ProgramType",
"discriminator": {
"propertyName": "type"
}
},
"ProgramTypeAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "ProgramTypeAbridged",
"default": "ProgramTypeAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"people": {
"anyOf": [
{
"$ref": "#/components/schemas/PeopleAbridged"
},
{
"type": "null"
}
],
"default": null,
"description": "People to describe the occupancy of the program. If None, no occupancy will be assumed for the program."
},
"lighting": {
"anyOf": [
{
"$ref": "#/components/schemas/LightingAbridged"
},
{
"type": "null"
}
],
"default": null,
"description": "Lighting to describe the lighting usage of the program. If None, no lighting will be assumed for the program."
},
"electric_equipment": {
"anyOf": [
{
"$ref": "#/components/schemas/ElectricEquipmentAbridged"
},
{
"type": "null"
}
],
"default": null,
"description": "ElectricEquipment to describe the usage of electric equipment within the program. If None, no electric equipment will be assumed."
},
"gas_equipment": {
"anyOf": [
{
"$ref": "#/components/schemas/GasEquipmentAbridged"
},
{
"type": "null"
}
],
"default": null,
"description": "GasEquipment to describe the usage of gas equipment within the program. If None, no gas equipment will be assumed."
},
"service_hot_water": {
"anyOf": [
{
"$ref": "#/components/schemas/ServiceHotWaterAbridged"
},
{
"type": "null"
}
],
"default": null,
"description": "ServiceHotWater object to describe the usage of hot water within the program. If None, no hot water will be assumed."
},
"infiltration": {
"anyOf": [
{
"$ref": "#/components/schemas/InfiltrationAbridged"
},
{
"type": "null"
}
],
"default": null,
"description": "Infiltration to describe the outdoor air leakage of the program. If None, no infiltration will be assumed for the program."
},
"ventilation": {
"anyOf": [
{
"$ref": "#/components/schemas/VentilationAbridged"
},
{
"type": "null"
}
],
"default": null,
"description": "Ventilation to describe the minimum outdoor air requirement of the program. If None, no ventilation requirement will be assumed."
},
"setpoint": {
"anyOf": [
{
"$ref": "#/components/schemas/SetpointAbridged"
},
{
"type": "null"
}
],
"default": null,
"description": "Setpoint object to describe the temperature and humidity setpoints of the program. If None, the ProgramType cannot be assigned to a Room that is conditioned."
}
},
"additionalProperties": false
}
],
"title": "ProgramTypeAbridged",
"discriminator": {
"propertyName": "type"
}
},
"RadianceShadeStateAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "RadianceShadeStateAbridged",
"default": "RadianceShadeStateAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"modifier": {
"default": null,
"description": "A Radiance Modifier identifier (default: None).",
"title": "Modifier",
"type": "string"
},
"modifier_direct": {
"default": null,
"description": "A Radiance Modifier identifier (default: None).",
"title": "Modifier Direct",
"type": "string"
},
"shades": {
"default": null,
"description": "A list of StateGeometryAbridged objects (default: None).",
"items": {
"$ref": "#/components/schemas/StateGeometryAbridged"
},
"title": "Shades",
"type": "array"
}
},
"additionalProperties": false
}
],
"description": "RadianceShadeStateAbridged represents a single state for a dynamic Shade.",
"title": "RadianceShadeStateAbridged",
"discriminator": {
"propertyName": "type"
}
},
"RadianceSubFaceStateAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/RadianceShadeStateAbridged"
},
{
"type": "object",
"required": [],
"properties": {
"vmtx_geometry": {
"$ref": "#/components/schemas/Face3D",
"default": null,
"description": "A Face3D for the view matrix geometry (default: None)."
},
"dmtx_geometry": {
"$ref": "#/components/schemas/Face3D",
"default": null,
"description": "A Face3D for the daylight matrix geometry (default: None)."
},
"type": {
"const": "RadianceSubFaceStateAbridged",
"default": "RadianceSubFaceStateAbridged",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "RadianceSubFaceStateAbridged is an abridged state for a dynamic Aperture or Door.\n ",
"title": "RadianceSubFaceStateAbridged",
"discriminator": {
"propertyName": "type"
}
},
"Radiant": {
"allOf": [
{
"$ref": "#/components/schemas/_HeatCoolBase"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "Radiant",
"default": "Radiant",
"title": "Type",
"type": "string",
"readOnly": true
},
"equipment_type": {
"$ref": "#/components/schemas/RadiantEquipmentType",
"default": "Radiant_Chiller_Boiler",
"description": "Text for the specific type of system equipment from the RadiantEquipmentType enumeration."
},
"radiant_face_type": {
"$ref": "#/components/schemas/RadiantFaceTypes",
"default": "Floor",
"description": "Text to indicate which faces are thermally active by default. Note that this property has no effect when the rooms to which the HVAC system is assigned have constructions with internal source materials. In this case, those constructions will dictate the thermally active surfaces."
},
"minimum_operation_time": {
"default": 1.0,
"description": "A number for the minimum number of hours of operation for the radiant system before it shuts off.",
"exclusiveMinimum": 0,
"title": "Minimum Operation Time",
"type": "number",
"format": "double"
},
"switch_over_time": {
"default": 24.0,
"description": "A number for the minimum number of hours for when the system can switch between heating and cooling.",
"exclusiveMinimum": 0,
"title": "Switch Over Time",
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
],
"description": "Low temperature radiant HVAC system.\n\nThis HVAC template will change the floor and/or ceiling constructions\nof the Rooms that it is applied to, replacing them with a construction that\naligns with the radiant_type property (eg. CeilingMetalPanel).\n\nThe heating and cooling needs of the space are met with the radiant constructions,\nwhich use chilled water at 12.8C (55F) and a hot water temperature somewhere\nbetween 32.2C (90F) and 49C (120F) (warmer temperatures are used in colder\nclimate zones).\n\nNote that radiant systems are particularly limited in cooling capacity and\nusing them may result in many unmet hours. To reduce unmet hours, one can\nremove carpets, reduce internal loads, reduce solar and envelope gains during\npeak times, add thermal mass, and use an expanded comfort range.",
"title": "Radiant",
"discriminator": {
"propertyName": "type"
}
},
"RadiantEquipmentType": {
"enum": [
"Radiant_Chiller_Boiler",
"Radiant_Chiller_ASHP",
"Radiant_Chiller_DHW",
"Radiant_ACChiller_Boiler",
"Radiant_ACChiller_ASHP",
"Radiant_ACChiller_DHW",
"Radiant_DCW_Boiler",
"Radiant_DCW_ASHP",
"Radiant_DCW_DHW"
],
"title": "RadiantEquipmentType",
"type": "string"
},
"RadiantFaceTypes": {
"enum": [
"Floor",
"Ceiling",
"FloorWithCarpet",
"CeilingMetalPanel",
"FloorWithHardwood"
],
"title": "RadiantFaceTypes",
"type": "string"
},
"RadiantwithDOASAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_DOASBase"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "RadiantwithDOASAbridged",
"default": "RadiantwithDOASAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"equipment_type": {
"$ref": "#/components/schemas/RadiantwithDOASEquipmentType",
"default": "DOAS_Radiant_Chiller_Boiler",
"description": "Text for the specific type of system equipment from the RadiantwithDOASEquipmentType enumeration."
},
"radiant_face_type": {
"$ref": "#/components/schemas/RadiantFaceTypes",
"default": "Floor",
"description": "Text to indicate which faces are thermally active by default. Note that this property has no effect when the rooms to which the HVAC system is assigned have constructions with internal source materials. In this case, those constructions will dictate the thermally active surfaces."
},
"minimum_operation_time": {
"default": 1.0,
"description": "A number for the minimum number of hours of operation for the radiant system before it shuts off.",
"exclusiveMinimum": 0,
"title": "Minimum Operation Time",
"type": "number",
"format": "double"
},
"switch_over_time": {
"default": 24.0,
"description": "A number for the minimum number of hours for when the system can switch between heating and cooling.",
"exclusiveMinimum": 0,
"title": "Switch Over Time",
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
],
"description": "Low Temperature Radiant with DOAS HVAC system.\n\nThis HVAC template will change the floor and/or ceiling constructions\nof the Rooms that it is applied to, replacing them with a construction that\naligns with the radiant_type property (eg. CeilingMetalPanel).\n\nAll rooms/zones in the system are connected to a Dedicated Outdoor Air System\n(DOAS) that supplies a constant volume of ventilation air at the same temperature\nto all rooms/zones. The ventilation air temperature will vary from 21.1C (70F)\nto 15.5C (60F) depending on the outdoor air temperature (the DOAS supplies cooler air\nwhen outdoor conditions are warmer). The ventilation air temperature is maintained\nby a two-speed direct expansion (DX) cooling coil and a single-speed DX\nheating coil with backup electrical resistance heat.\n\nThe heating and cooling needs of the space are met with the radiant constructions,\nwhich use chilled water at 12.8C (55F) and a hot water temperature somewhere\nbetween 32.2C (90F) and 49C (120F) (warmer temperatures are used in colder\nclimate zones).\n\nNote that radiant systems are particularly limited in cooling capacity and\nusing them may result in many unmet hours. To reduce unmet hours, one can\nremove carpets, reduce internal loads, reduce solar and envelope gains during\npeak times, add thermal mass, and use an expanded comfort range.",
"title": "RadiantwithDOASAbridged",
"discriminator": {
"propertyName": "type"
}
},
"RadiantwithDOASEquipmentType": {
"enum": [
"DOAS_Radiant_Chiller_Boiler",
"DOAS_Radiant_Chiller_ASHP",
"DOAS_Radiant_Chiller_DHW",
"DOAS_Radiant_ACChiller_Boiler",
"DOAS_Radiant_ACChiller_ASHP",
"DOAS_Radiant_ACChiller_DHW",
"DOAS_Radiant_DCW_Boiler",
"DOAS_Radiant_DCW_ASHP",
"DOAS_Radiant_DCW_DHW"
],
"title": "RadiantwithDOASEquipmentType",
"type": "string"
},
"Residential": {
"allOf": [
{
"$ref": "#/components/schemas/_HeatCoolBase"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "Residential",
"default": "Residential",
"title": "Type",
"type": "string",
"readOnly": true
},
"equipment_type": {
"$ref": "#/components/schemas/ResidentialEquipmentType",
"default": "ResidentialAC_ElectricBaseboard",
"description": "Text for the specific type of system equipment from the ResidentialEquipmentType enumeration."
}
},
"additionalProperties": false
}
],
"description": "Residential Air Conditioning, Heat Pump or Furnace system.\n\nResidential HVAC systems are intended primarily for single-family homes and\ninclude a wide variety of options. In all cases, each room/zone will receive\nits own air loop WITHOUT an outdoor air inlet (air is simply being recirculated\nthrough the loop). Residential air conditioning (AC) systems are modeled\nusing a unitary system with a single-speed direct expansion (DX) cooling\ncoil in the loop. Residential heat pump (HP) systems use a single-speed DX\nheating coil in the unitary system and the residential furnace option uses\na gas coil in the unitary system. In all cases, the properties of these coils\nare set to reflect a typical residential system.",
"title": "Residential",
"discriminator": {
"propertyName": "type"
}
},
"ResidentialEquipmentType": {
"enum": [
"ResidentialAC_ElectricBaseboard",
"ResidentialAC_BoilerBaseboard",
"ResidentialAC_ASHPBaseboard",
"ResidentialAC_DHWBaseboard",
"ResidentialAC_ResidentialFurnace",
"ResidentialAC",
"ResidentialHP",
"ResidentialHPNoCool",
"ResidentialFurnace"
],
"title": "ResidentialEquipmentType",
"type": "string"
},
"RoofCeilingConstructionSet": {
"allOf": [
{
"$ref": "#/components/schemas/_FaceSubSet"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "RoofCeilingConstructionSet",
"default": "RoofCeilingConstructionSet",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "A set of constructions for roof and ceiling assemblies.",
"title": "RoofCeilingConstructionSet",
"discriminator": {
"propertyName": "type"
}
},
"RoofCeilingConstructionSetAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_FaceSubSetAbridged"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "RoofCeilingConstructionSetAbridged",
"default": "RoofCeilingConstructionSetAbridged",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "A set of constructions for roof and ceiling assemblies.",
"title": "RoofCeilingConstructionSetAbridged",
"discriminator": {
"propertyName": "type"
}
},
"RoofCeilingModifierSet": {
"allOf": [
{
"$ref": "#/components/schemas/BaseModifierSet"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "RoofCeilingModifierSet",
"default": "RoofCeilingModifierSet",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Set containing radiance modifiers needed for a model's roofs.",
"title": "RoofCeilingModifierSet",
"discriminator": {
"propertyName": "type"
}
},
"RoofCeilingModifierSetAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/BaseModifierSetAbridged"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "RoofCeilingModifierSetAbridged",
"default": "RoofCeilingModifierSetAbridged",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Abridged set containing radiance modifiers needed for a model's Roofs.",
"title": "RoofCeilingModifierSetAbridged",
"discriminator": {
"propertyName": "type"
}
},
"Room": {
"allOf": [
{
"$ref": "#/components/schemas/IDdBaseModel"
},
{
"type": "object",
"required": [
"faces",
"properties"
],
"properties": {
"faces": {
"description": "Faces that together form the closed volume of a room.",
"items": {
"$ref": "#/components/schemas/Face"
},
"minItems": 4,
"title": "Faces",
"type": "array"
},
"properties": {
"$ref": "#/components/schemas/RoomPropertiesAbridged",
"description": "Extension properties for particular simulation engines (Radiance, EnergyPlus)."
},
"type": {
"const": "Room",
"default": "Room",
"title": "Type",
"type": "string",
"readOnly": true
},
"indoor_shades": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Shade"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Shades assigned to the interior side of this object (eg. partitions, tables).",
"title": "Indoor Shades"
},
"outdoor_shades": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Shade"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Shades assigned to the exterior side of this object (eg. trees, landscaping).",
"title": "Outdoor Shades"
},
"multiplier": {
"default": 1,
"description": "An integer noting how many times this Room is repeated. Multipliers are used to speed up the calculation when similar Rooms are repeated more than once. Essentially, a given simulation with the Room is run once and then the result is multiplied by the multiplier.",
"minimum": 1,
"title": "Multiplier",
"type": "integer",
"format": "int32"
},
"exclude_floor_area": {
"default": false,
"description": "A boolean for whether the Room floor area contributes to Models it is a part of. Note that this will not affect the floor_area property of this Room itself but it will ensure the Room floor area is excluded from any calculations when the Room is part of a Model, including EUI calculations.",
"title": "Exclude Floor Area",
"type": "boolean"
},
"zone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Text string for for the zone identifier to which this Room belongs. Rooms sharing the same zone identifier are considered part of the same zone in a Model. If the zone identifier has not been specified, it will be the same as the Room identifier in the destination engine. Note that this property has no character restrictions.",
"title": "Zone"
},
"story": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Text string for the story identifier to which this Room belongs. Rooms sharing the same story identifier are considered part of the same story in a Model. Note that this property has no character restrictions.",
"title": "Story"
}
},
"additionalProperties": false
}
],
"title": "Room",
"discriminator": {
"propertyName": "type"
}
},
"RoomDoe2Properties": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "RoomDoe2Properties",
"default": "RoomDoe2Properties",
"title": "Type",
"type": "string",
"readOnly": true
},
"assigned_flow": {
"anyOf": [
{
"$ref": "#/components/schemas/Autocalculate"
},
{
"minimum": 0,
"type": "number"
}
],
"default": {
"type": "Autocalculate"
},
"description": "A number for the design supply air flow rate for the zone the Room is assigned to (cfm). This establishes the minimum allowed design air flow. Note that the actual design flow may be larger. If Autocalculate, this parameter will not be written into the INP.",
"title": "Assigned Flow"
},
"flow_per_area": {
"anyOf": [
{
"$ref": "#/components/schemas/Autocalculate"
},
{
"minimum": 0,
"type": "number"
}
],
"default": {
"type": "Autocalculate"
},
"description": "A number for the design supply air flow rate to the zone per unit floor area (cfm/ft2). If Autocalculate, this parameter will not be written into the INP.",
"title": "Flow Per Area"
},
"min_flow_ratio": {
"anyOf": [
{
"$ref": "#/components/schemas/Autocalculate"
},
{
"maximum": 1,
"minimum": 0,
"type": "number"
}
],
"default": {
"type": "Autocalculate"
},
"description": "A number between 0 and 1 for the minimum allowable zone air supply flow rate, expressed as a fraction of design flow rate. Applicable to variable-volume type systems only. If Autocalculate, this parameter will not be written into the INP.",
"title": "Min Flow Ratio"
},
"min_flow_per_area": {
"anyOf": [
{
"$ref": "#/components/schemas/Autocalculate"
},
{
"minimum": 0,
"type": "number"
}
],
"default": {
"type": "Autocalculate"
},
"description": "A number for the minimum air flow per square foot of floor area (cfm/ft2). This is an alternative way of specifying the min_flow_ratio. If Autocalculate, this parameter will not be written into the INP.",
"title": "Min Flow Per Area"
},
"hmax_flow_ratio": {
"anyOf": [
{
"$ref": "#/components/schemas/Autocalculate"
},
{
"maximum": 1,
"minimum": 0,
"type": "number"
}
],
"default": {
"type": "Autocalculate"
},
"description": "A number between 0 and 1 for the ratio of the maximum (or fixed) heating airflow to the cooling airflow. The specific meaning varies according to the type of zone terminal. If Autocalculate, this parameter will not be written into the INP.",
"title": "Hmax Flow Ratio"
},
"space_polygon_geometry": {
"anyOf": [
{
"$ref": "#/components/schemas/Face3D"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional horizontal Face3D object, which will be used to set the SPACE polygon during export to INP. If None, the SPACE polygon is auto-calculated from the 3D Room geometry. Specifying a geometry here can help overcome some limitations of this auto-calculation, particularly for cases where the floors of the Room are composed of AirBoundaries."
}
},
"additionalProperties": false
}
],
"title": "RoomDoe2Properties",
"discriminator": {
"propertyName": "type"
}
},
"RoomEnergyPropertiesAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "RoomEnergyPropertiesAbridged",
"default": "RoomEnergyPropertiesAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"construction_set": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of a ConstructionSet to specify all default constructions for the Faces, Apertures, and Doors of the Room. If None, the Room will use the Model global_construction_set.",
"title": "Construction Set"
},
"program_type": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of a ProgramType to specify all default schedules and loads for the Room. If None, the Room will have no loads or setpoints.",
"title": "Program Type"
},
"hvac": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional identifier of a HVAC system (such as an IdealAirSystem) that specifies how the Room is conditioned. If None, it will be assumed that the Room is not conditioned.",
"title": "Hvac"
},
"shw": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional identifier of a Service Hot Water (SHW) system that specifies how the hot water load of the Room is met. If None, the hot water load will be met with a generic system that only measures thermal loadand does not account for system efficiencies.",
"title": "Shw"
},
"people": {
"anyOf": [
{
"$ref": "#/components/schemas/PeopleAbridged"
},
{
"type": "null"
}
],
"default": null,
"description": "People object to describe the occupancy of the Room."
},
"lighting": {
"anyOf": [
{
"$ref": "#/components/schemas/LightingAbridged"
},
{
"type": "null"
}
],
"default": null,
"description": "Lighting object to describe the lighting usage of the Room."
},
"electric_equipment": {
"anyOf": [
{
"$ref": "#/components/schemas/ElectricEquipmentAbridged"
},
{
"type": "null"
}
],
"default": null,
"description": "ElectricEquipment object to describe the electric equipment usage."
},
"gas_equipment": {
"anyOf": [
{
"$ref": "#/components/schemas/GasEquipmentAbridged"
},
{
"type": "null"
}
],
"default": null,
"description": "GasEquipment object to describe the gas equipment usage."
},
"service_hot_water": {
"anyOf": [
{
"$ref": "#/components/schemas/ServiceHotWaterAbridged"
},
{
"type": "null"
}
],
"default": null,
"description": "ServiceHotWater object to describe the hot water usage."
},
"infiltration": {
"anyOf": [
{
"$ref": "#/components/schemas/InfiltrationAbridged"
},
{
"type": "null"
}
],
"default": null,
"description": "Infiltration object to to describe the outdoor air leakage."
},
"ventilation": {
"anyOf": [
{
"$ref": "#/components/schemas/VentilationAbridged"
},
{
"type": "null"
}
],
"default": null,
"description": "Ventilation object for the minimum outdoor air requirement."
},
"setpoint": {
"anyOf": [
{
"$ref": "#/components/schemas/SetpointAbridged"
},
{
"type": "null"
}
],
"default": null,
"description": "Setpoint object for the temperature setpoints of the Room."
},
"daylighting_control": {
"anyOf": [
{
"$ref": "#/components/schemas/DaylightingControl"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional DaylightingControl object to dictate the dimming of lights. If None, the lighting will respond only to the schedule and not the daylight conditions within the room."
},
"window_vent_control": {
"anyOf": [
{
"$ref": "#/components/schemas/VentilationControlAbridged"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional VentilationControl object to dictate the opening of windows. If None, the windows will never open."
},
"fans": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/VentilationFan"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional list of VentilationFan objects for fans within the room. Note that these fans are not connected to the heating or cooling system and are meant to represent the intentional circulation of unconditioned outdoor air for the purposes of keeping a space cooler, drier or free of indoor pollutants (as in the case of kitchen or bathroom exhaust fans). For the specification of mechanical ventilation of conditioned outdoor air, the Room.ventilation property should be used and the Room should be given a HVAC that can meet this specification.",
"title": "Fans"
},
"internal_masses": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/InternalMassAbridged"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional list of of InternalMass objects for thermal mass exposed to Room air. Note that internal masses assigned this way cannot \"see\" solar radiation that may potentially hit them and, as such, caution should be taken when using this component with internal mass objects that are not always in shade. Masses are factored into the the thermal calculations of the Room by undergoing heat transfer with the indoor air.",
"title": "Internal Masses"
},
"process_loads": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProcessAbridged"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional list of of Process objects for process loads within the room. These can represent kilns, manufacturing equipment, and various industrial processes. They can also be used to represent wood burning fireplaces or certain pieces of equipment to be separated from the other end uses.",
"title": "Process Loads"
}
},
"additionalProperties": false
}
],
"title": "RoomEnergyPropertiesAbridged",
"discriminator": {
"propertyName": "type"
}
},
"RoomPropertiesAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "RoomPropertiesAbridged",
"default": "RoomPropertiesAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"energy": {
"anyOf": [
{
"$ref": "#/components/schemas/RoomEnergyPropertiesAbridged"
},
{
"type": "null"
}
],
"default": null
},
"radiance": {
"anyOf": [
{
"$ref": "#/components/schemas/RoomRadiancePropertiesAbridged"
},
{
"type": "null"
}
],
"default": null
},
"doe2": {
"anyOf": [
{
"$ref": "#/components/schemas/RoomDoe2Properties"
},
{
"type": "null"
}
],
"default": null
}
}
}
],
"title": "RoomPropertiesAbridged",
"discriminator": {
"propertyName": "type"
}
},
"RoomRadiancePropertiesAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "RoomRadiancePropertiesAbridged",
"default": "RoomRadiancePropertiesAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"modifier_set": {
"default": null,
"description": "An identifier for a unique Room-Assigned ModifierSet (default: None).",
"title": "Modifier Set",
"type": "string"
}
},
"additionalProperties": false
}
],
"description": "Abridged Radiance Properties for Honeybee Room.",
"title": "RoomRadiancePropertiesAbridged",
"discriminator": {
"propertyName": "type"
}
},
"Roughness": {
"description": "Relative roughness of a particular material layer.",
"enum": [
"VeryRough",
"Rough",
"MediumRough",
"MediumSmooth",
"Smooth",
"VerySmooth"
],
"title": "Roughness",
"type": "string"
},
"SHWEquipmentType": {
"enum": [
"Gas_WaterHeater",
"Electric_WaterHeater",
"HeatPump_WaterHeater",
"Gas_TanklessHeater",
"Electric_TanklessHeater"
],
"title": "SHWEquipmentType",
"type": "string"
},
"SHWSystem": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "SHWSystem",
"default": "SHWSystem",
"title": "Type",
"type": "string",
"readOnly": true
},
"equipment_type": {
"$ref": "#/components/schemas/SHWEquipmentType",
"default": "Gas_WaterHeater",
"description": "Text to indicate the type of air-side economizer used on the ideal air system. Economizers will mix in a greater amount of outdoor air to cool the zone (rather than running the cooling system) when the zone needs cooling and the outdoor air is cooler than the zone."
},
"heater_efficiency": {
"anyOf": [
{
"exclusiveMinimum": 0,
"type": "number"
},
{
"$ref": "#/components/schemas/Autocalculate"
}
],
"default": {
"type": "Autocalculate"
},
"description": "A number for the efficiency of the heater within the system. For Gas systems, this is the efficiency of the burner. For HeatPump systems, this is the rated COP of the system. For electric systems, this should usually be set to 1. If set to Autocalculate, this value will automatically be set based on the equipment_type. Gas_WaterHeater - 0.8, Electric_WaterHeater - 1.0, HeatPump_WaterHeater - 3.5, Gas_TanklessHeater - 0.8, Electric_TanklessHeater - 1.0.",
"title": "Heater Efficiency"
},
"ambient_condition": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"default": 22,
"description": "A number for the ambient temperature in which the hot water tank is located [C]. This can also be the identifier of a Room in which the tank is located.",
"title": "Ambient Condition"
},
"ambient_loss_coefficient": {
"default": 6,
"description": "A number for the loss of heat from the water heater tank to the surrounding ambient conditions [W/K].",
"title": "Ambient Loss Coefficient",
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
],
"description": "Provides a model for a Service Hot Water system.",
"title": "SHWSystem",
"discriminator": {
"propertyName": "type"
}
},
"ScheduleDay": {
"allOf": [
{
"$ref": "#/components/schemas/EnergyBaseModel"
},
{
"type": "object",
"required": [
"values"
],
"properties": {
"values": {
"description": "A list of floats or integers for the values of the schedule. The length of this list must match the length of the times list.",
"items": {
"type": "number",
"format": "double"
},
"title": "Values",
"type": "array"
},
"type": {
"const": "ScheduleDay",
"default": "ScheduleDay",
"title": "Type",
"type": "string",
"readOnly": true
},
"times": {
"default": [
[
0,
0
]
],
"description": "A list of lists with each sub-list possessing 2 values for [hour, minute]. The length of the master list must match the length of the values list. Each time in the master list represents the time of day that the corresponding value begins to take effect. For example [(0,0), (9,0), (17,0)] in combination with the values [0, 1, 0] denotes a schedule value of 0 from 0:00 to 9:00, a value of 1 from 9:00 to 17:00 and 0 from 17:00 to the end of the day. Note that this representation of times as the \"time of beginning\" is a different convention than EnergyPlus, which uses \"time until\".",
"items": {
"items": {
"type": "integer",
"format": "int32"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"title": "Times",
"type": "array"
},
"interpolate": {
"default": false,
"description": "Boolean to note whether values in between times should be linearly interpolated or whether successive values should take effect immediately upon the beginning time corresponding to them.",
"title": "Interpolate",
"type": "boolean"
}
},
"additionalProperties": false
}
],
"description": "Used to describe the daily schedule for a single simulation day.",
"title": "ScheduleDay",
"discriminator": {
"propertyName": "type"
}
},
"ScheduleFixedInterval": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"values"
],
"properties": {
"values": {
"description": "A list of timeseries values occurring at each timestep over the course of the simulation.",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 527040,
"minItems": 24,
"title": "Values",
"type": "array"
},
"type": {
"const": "ScheduleFixedInterval",
"default": "ScheduleFixedInterval",
"title": "Type",
"type": "string",
"readOnly": true
},
"schedule_type_limit": {
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleTypeLimit"
},
{
"type": "null"
}
],
"default": null,
"description": "ScheduleTypeLimit object that will be used to validate schedule values against upper/lower limits and assign units to the schedule values. If None, no validation will occur."
},
"timestep": {
"default": 1,
"description": "An integer for the number of steps per hour that the input values correspond to. For example, if each value represents 30 minutes, the timestep is 2. For 15 minutes, it is 4.",
"title": "Timestep",
"type": "integer",
"format": "int32"
},
"start_date": {
"default": [
1,
1
],
"description": "A list of two integers for [month, day], representing the start date when the schedule values begin to take effect.A third integer may be added to denote whether the date should be re-serialized for a leap year (it should be a 1 in this case).",
"items": {
"type": "integer",
"format": "int32"
},
"maxItems": 3,
"minItems": 2,
"title": "Start Date",
"type": "array"
},
"placeholder_value": {
"default": 0,
"description": " A value that will be used for all times not covered by the input values. Typically, your simulation should not need to use this value if the input values completely cover the simulation period.",
"title": "Placeholder Value",
"type": "number",
"format": "double"
},
"interpolate": {
"default": false,
"description": "Boolean to note whether values in between intervals should be linearly interpolated or whether successive values should take effect immediately upon the beginning time corresponding to them.",
"title": "Interpolate",
"type": "boolean"
}
},
"additionalProperties": false
}
],
"description": "Used to specify a start date and a list of values for a period of analysis.",
"title": "ScheduleFixedInterval",
"discriminator": {
"propertyName": "type"
}
},
"ScheduleFixedIntervalAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"values"
],
"properties": {
"values": {
"description": "A list of timeseries values occurring at each timestep over the course of the simulation.",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 527040,
"minItems": 24,
"title": "Values",
"type": "array"
},
"type": {
"const": "ScheduleFixedIntervalAbridged",
"default": "ScheduleFixedIntervalAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"schedule_type_limit": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of a ScheduleTypeLimit that will be used to validate schedule values against upper/lower limits and assign units to the schedule values. If None, no validation will occur.",
"title": "Schedule Type Limit"
},
"timestep": {
"default": 1,
"description": "An integer for the number of steps per hour that the input values correspond to. For example, if each value represents 30 minutes, the timestep is 2. For 15 minutes, it is 4.",
"title": "Timestep",
"type": "integer",
"format": "int32"
},
"start_date": {
"default": [
1,
1
],
"description": "A list of two integers for [month, day], representing the start date when the schedule values begin to take effect.A third integer may be added to denote whether the date should be re-serialized for a leap year (it should be a 1 in this case).",
"items": {
"type": "integer",
"format": "int32"
},
"maxItems": 3,
"minItems": 2,
"title": "Start Date",
"type": "array"
},
"placeholder_value": {
"default": 0,
"description": " A value that will be used for all times not covered by the input values. Typically, your simulation should not need to use this value if the input values completely cover the simulation period.",
"title": "Placeholder Value",
"type": "number",
"format": "double"
},
"interpolate": {
"default": false,
"description": "Boolean to note whether values in between intervals should be linearly interpolated or whether successive values should take effect immediately upon the beginning time corresponding to them.",
"title": "Interpolate",
"type": "boolean"
}
},
"additionalProperties": false
}
],
"description": "Used to specify a start date and a list of values for a period of analysis.",
"title": "ScheduleFixedIntervalAbridged",
"discriminator": {
"propertyName": "type"
}
},
"ScheduleNumericType": {
"description": "Designates how the range values are validated.",
"enum": [
"Continuous",
"Discrete"
],
"title": "ScheduleNumericType",
"type": "string"
},
"ScheduleRuleAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/DatedBaseModel"
},
{
"type": "object",
"required": [
"schedule_day"
],
"properties": {
"schedule_day": {
"description": "The identifier of a ScheduleDay object associated with this rule.",
"maxLength": 100,
"minLength": 1,
"title": "Schedule Day",
"type": "string"
},
"type": {
"const": "ScheduleRuleAbridged",
"default": "ScheduleRuleAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"apply_sunday": {
"default": false,
"description": "Boolean noting whether to apply schedule_day on Sundays.",
"title": "Apply Sunday",
"type": "boolean"
},
"apply_monday": {
"default": false,
"description": "Boolean noting whether to apply schedule_day on Mondays.",
"title": "Apply Monday",
"type": "boolean"
},
"apply_tuesday": {
"default": false,
"description": "Boolean noting whether to apply schedule_day on Tuesdays.",
"title": "Apply Tuesday",
"type": "boolean"
},
"apply_wednesday": {
"default": false,
"description": "Boolean noting whether to apply schedule_day on Wednesdays.",
"title": "Apply Wednesday",
"type": "boolean"
},
"apply_thursday": {
"default": false,
"description": "Boolean noting whether to apply schedule_day on Thursdays.",
"title": "Apply Thursday",
"type": "boolean"
},
"apply_friday": {
"default": false,
"description": "Boolean noting whether to apply schedule_day on Fridays.",
"title": "Apply Friday",
"type": "boolean"
},
"apply_saturday": {
"default": false,
"description": "Boolean noting whether to apply schedule_day on Saturdays.",
"title": "Apply Saturday",
"type": "boolean"
},
"start_date": {
"default": [
1,
1
],
"description": "A list of two integers for [month, day], representing the start date of the period over which the schedule_day will be applied.A third integer may be added to denote whether the date should be re-serialized for a leap year (it should be a 1 in this case).",
"items": {
"type": "integer",
"format": "int32"
},
"maxItems": 3,
"minItems": 2,
"title": "Start Date",
"type": "array"
},
"end_date": {
"default": [
12,
31
],
"description": "A list of two integers for [month, day], representing the end date of the period over which the schedule_day will be applied.A third integer may be added to denote whether the date should be re-serialized for a leap year (it should be a 1 in this case).",
"items": {
"type": "integer",
"format": "int32"
},
"maxItems": 3,
"minItems": 2,
"title": "End Date",
"type": "array"
}
},
"additionalProperties": false
}
],
"description": "Schedule rule including a ScheduleDay and when it should be applied..",
"title": "ScheduleRuleAbridged",
"discriminator": {
"propertyName": "type"
}
},
"ScheduleRuleset": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"day_schedules",
"default_day_schedule"
],
"properties": {
"day_schedules": {
"description": "A list of ScheduleDays that are referenced in the other keys of this ScheduleRulesetAbridged.",
"items": {
"$ref": "#/components/schemas/ScheduleDay"
},
"title": "Day Schedules",
"type": "array"
},
"default_day_schedule": {
"description": "An identifier for the ScheduleDay that will be used for all days when no ScheduleRule is applied. This ScheduleDay must be in the day_schedules.",
"maxLength": 100,
"minLength": 1,
"title": "Default Day Schedule",
"type": "string"
},
"type": {
"const": "ScheduleRuleset",
"default": "ScheduleRuleset",
"title": "Type",
"type": "string",
"readOnly": true
},
"schedule_rules": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ScheduleRuleAbridged"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "A list of ScheduleRuleAbridged that note exceptions to the default_day_schedule. These rules should be ordered from highest to lowest priority.",
"title": "Schedule Rules"
},
"holiday_schedule": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "An identifier for the ScheduleDay that will be used for holidays. This ScheduleDay must be in the day_schedules.",
"title": "Holiday Schedule"
},
"summer_designday_schedule": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "An identifier for the ScheduleDay that will be used for the summer design day. This ScheduleDay must be in the day_schedules.",
"title": "Summer Designday Schedule"
},
"winter_designday_schedule": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "An identifier for the ScheduleDay that will be used for the winter design day. This ScheduleDay must be in the day_schedules.",
"title": "Winter Designday Schedule"
},
"schedule_type_limit": {
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleTypeLimit"
},
{
"type": "null"
}
],
"default": null,
"description": "ScheduleTypeLimit object that will be used to validate schedule values against upper/lower limits and assign units to the schedule values. If None, no validation will occur."
}
},
"additionalProperties": false
}
],
"description": "Used to define a schedule for a default day, further described by ScheduleRule.",
"title": "ScheduleRuleset",
"discriminator": {
"propertyName": "type"
}
},
"ScheduleRulesetAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"day_schedules",
"default_day_schedule"
],
"properties": {
"day_schedules": {
"description": "A list of ScheduleDays that are referenced in the other keys of this ScheduleRulesetAbridged.",
"items": {
"$ref": "#/components/schemas/ScheduleDay"
},
"title": "Day Schedules",
"type": "array"
},
"default_day_schedule": {
"description": "An identifier for the ScheduleDay that will be used for all days when no ScheduleRule is applied. This ScheduleDay must be in the day_schedules.",
"maxLength": 100,
"minLength": 1,
"title": "Default Day Schedule",
"type": "string"
},
"type": {
"const": "ScheduleRulesetAbridged",
"default": "ScheduleRulesetAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"schedule_rules": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ScheduleRuleAbridged"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "A list of ScheduleRuleAbridged that note exceptions to the default_day_schedule. These rules should be ordered from highest to lowest priority.",
"title": "Schedule Rules"
},
"holiday_schedule": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "An identifier for the ScheduleDay that will be used for holidays. This ScheduleDay must be in the day_schedules.",
"title": "Holiday Schedule"
},
"summer_designday_schedule": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "An identifier for the ScheduleDay that will be used for the summer design day. This ScheduleDay must be in the day_schedules.",
"title": "Summer Designday Schedule"
},
"winter_designday_schedule": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "An identifier for the ScheduleDay that will be used for the winter design day. This ScheduleDay must be in the day_schedules.",
"title": "Winter Designday Schedule"
},
"schedule_type_limit": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of a ScheduleTypeLimit that will be used to validate schedule values against upper/lower limits and assign units to the schedule values. If None, no validation will occur.",
"title": "Schedule Type Limit"
}
},
"additionalProperties": false
}
],
"description": "Used to define a schedule for a default day, further described by ScheduleRule.",
"title": "ScheduleRulesetAbridged",
"discriminator": {
"propertyName": "type"
}
},
"ScheduleTypeLimit": {
"allOf": [
{
"$ref": "#/components/schemas/EnergyBaseModel"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "ScheduleTypeLimit",
"default": "ScheduleTypeLimit",
"title": "Type",
"type": "string",
"readOnly": true
},
"lower_limit": {
"anyOf": [
{
"$ref": "#/components/schemas/NoLimit"
},
{
"type": "number"
}
],
"default": {
"type": "NoLimit"
},
"description": "Lower limit for the schedule type or NoLimit.",
"title": "Lower Limit"
},
"upper_limit": {
"anyOf": [
{
"$ref": "#/components/schemas/NoLimit"
},
{
"type": "number"
}
],
"default": {
"type": "NoLimit"
},
"description": "Upper limit for the schedule type or NoLimit.",
"title": "Upper Limit"
},
"numeric_type": {
"$ref": "#/components/schemas/ScheduleNumericType",
"default": "Continuous"
},
"unit_type": {
"$ref": "#/components/schemas/ScheduleUnitType",
"default": "Dimensionless"
}
},
"additionalProperties": false
}
],
"description": "Specifies the data types and limits for values contained in schedules.",
"title": "ScheduleTypeLimit",
"discriminator": {
"propertyName": "type"
}
},
"ScheduleUnitType": {
"enum": [
"Dimensionless",
"Temperature",
"DeltaTemperature",
"PrecipitationRate",
"Angle",
"ConvectionCoefficient",
"ActivityLevel",
"Velocity",
"Capacity",
"Power",
"Availability",
"Percent",
"Control",
"Mode"
],
"title": "ScheduleUnitType",
"type": "string"
},
"Sensor": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"pos": {
"description": "Position of sensor in space as an array of (x, y, z) values.",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 3,
"minItems": 3,
"title": "Pos",
"type": "array"
},
"dir": {
"description": "Direction of sensor as an array of (x, y, z) values.",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 3,
"minItems": 3,
"title": "Dir",
"type": "array"
},
"type": {
"const": "Sensor",
"default": "Sensor",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false,
"required": [
"pos",
"dir"
]
}
],
"description": "A single Radiance of sensors.",
"title": "Sensor",
"discriminator": {
"propertyName": "type"
}
},
"SensorGrid": {
"allOf": [
{
"$ref": "#/components/schemas/_RadianceAsset"
},
{
"type": "object",
"required": [
"sensors"
],
"properties": {
"sensors": {
"description": "A list of sensors that belong to the grid.",
"items": {
"$ref": "#/components/schemas/Sensor"
},
"title": "Sensors",
"type": "array"
},
"type": {
"const": "SensorGrid",
"default": "SensorGrid",
"title": "Type",
"type": "string",
"readOnly": true
},
"mesh": {
"anyOf": [
{
"$ref": "#/components/schemas/Mesh3D"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional Mesh3D that aligns with the sensors and can be used for visualization of the grid. Note that the number of sensors in the grid must match the number of faces or the number vertices within the Mesh3D."
},
"base_geometry": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Face3D"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional array of Face3D used to represent the grid. There are no restrictions on how this property relates to the sensors and it is provided only to assist with the display of the grid when the number of sensors or the mesh is too large to be practically visualized.",
"title": "Base Geometry"
},
"group_identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional string to note the sensor grid group ' 'to which the sensor is a part of. Grids sharing the same ' 'group_identifier will be written to the same subfolder in Radiance ' 'folder (default: None).",
"title": "Group Identifier"
}
},
"additionalProperties": false
}
],
"description": "A grid of sensors.",
"title": "SensorGrid",
"discriminator": {
"propertyName": "type"
}
},
"ServiceHotWater": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"flow_per_area"
],
"properties": {
"flow_per_area": {
"description": "Number for the total volume flow rate of water per unit area of floor [L/h-m2].",
"minimum": 0,
"title": "Flow Per Area",
"type": "number",
"format": "double"
},
"type": {
"const": "ServiceHotWater",
"default": "ServiceHotWater",
"title": "Type",
"type": "string",
"readOnly": true
},
"schedule": {
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
},
{
"type": "null"
}
],
"default": null,
"description": "The schedule for the use of hot water over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the flow_per_area to yield a complete water usage profile. If None, an Always On schedule will be used.",
"title": "Schedule"
},
"target_temperature": {
"default": 60,
"description": "Number for the target temperature of water out of the tap (C). This the temperature after hot water has been mixed with cold water from the water mains. The default is 60C, which essentially assumes that the flow_per_area on this object is only for water straight out of the water heater.",
"exclusiveMinimum": 0,
"title": "Target Temperature",
"type": "number",
"format": "double"
},
"sensible_fraction": {
"default": 0.2,
"description": "A number between 0 and 1 for the fraction of the total hot water load given off as sensible heat in the zone.",
"maximum": 1,
"minimum": 0,
"title": "Sensible Fraction",
"type": "number",
"format": "double"
},
"latent_fraction": {
"default": 0.05,
"description": "A number between 0 and 1 for the fraction of the total hot water load that is latent.",
"maximum": 1,
"minimum": 0,
"title": "Latent Fraction",
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
],
"title": "ServiceHotWater",
"discriminator": {
"propertyName": "type"
}
},
"ServiceHotWaterAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"flow_per_area"
],
"properties": {
"flow_per_area": {
"description": "Number for the total volume flow rate of water per unit area of floor [L/h-m2].",
"minimum": 0,
"title": "Flow Per Area",
"type": "number",
"format": "double"
},
"type": {
"const": "ServiceHotWaterAbridged",
"default": "ServiceHotWaterAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"schedule": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of the schedule for the hot water use over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the flow_per_area to yield a complete water usage profile. If None, an Always On schedule will be used.",
"title": "Schedule"
},
"target_temperature": {
"default": 60,
"description": "Number for the target temperature of water out of the tap (C). This the temperature after hot water has been mixed with cold water from the water mains. The default is 60C, which essentially assumes that the flow_per_area on this object is only for water straight out of the water heater.",
"exclusiveMinimum": 0,
"title": "Target Temperature",
"type": "number",
"format": "double"
},
"sensible_fraction": {
"default": 0.2,
"description": "A number between 0 and 1 for the fraction of the total hot water load given off as sensible heat in the zone.",
"maximum": 1,
"minimum": 0,
"title": "Sensible Fraction",
"type": "number",
"format": "double"
},
"latent_fraction": {
"default": 0.05,
"description": "A number between 0 and 1 for the fraction of the total hot water load that is latent.",
"maximum": 1,
"minimum": 0,
"title": "Latent Fraction",
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
],
"title": "ServiceHotWaterAbridged",
"discriminator": {
"propertyName": "type"
}
},
"Setpoint": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"cooling_schedule",
"heating_schedule"
],
"properties": {
"cooling_schedule": {
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
}
],
"description": "Schedule for the cooling setpoint. The values in this schedule should be temperature in [C].",
"title": "Cooling Schedule"
},
"heating_schedule": {
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
}
],
"description": "Schedule for the heating setpoint. The values in this schedule should be temperature in [C].",
"title": "Heating Schedule"
},
"type": {
"const": "Setpoint",
"default": "Setpoint",
"title": "Type",
"type": "string",
"readOnly": true
},
"humidifying_schedule": {
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
},
{
"type": "null"
}
],
"default": null,
"description": "Schedule for the humidification setpoint. The values in this schedule should be in [%].",
"title": "Humidifying Schedule"
},
"dehumidifying_schedule": {
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
},
{
"type": "null"
}
],
"default": null,
"description": "Schedule for the dehumidification setpoint. The values in this schedule should be in [%].",
"title": "Dehumidifying Schedule"
},
"setpoint_cutout_difference": {
"default": 0,
"description": "An optional positive number for the temperature difference between the cutout temperature and the setpoint temperature. Specifying a non-zero number here is useful for modeling the throttling range associated with a given setup of setpoint controls and HVAC equipment. Throttling ranges describe the range where a zone is slightly over-cooled or over-heated beyond the thermostat setpoint. They are used to avoid situations where HVAC systems turn on only to turn off a few minutes later, thereby wearing out the parts of mechanical systems faster. They can have a minor impact on energy consumption and can often have significant impacts on occupant thermal comfort, though using the default value of zero will often yield results that are close enough when trying to estimate the annual heating/cooling energy use. Specifying a value of zero effectively assumes that the system will turn on whenever conditions are outside the setpoint range and will cut out as soon as the setpoint is reached.",
"minimum": 0,
"title": "Setpoint Cutout Difference",
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
],
"description": "Used to specify information about the setpoint schedule.",
"title": "Setpoint",
"discriminator": {
"propertyName": "type"
}
},
"SetpointAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"cooling_schedule",
"heating_schedule"
],
"properties": {
"cooling_schedule": {
"description": "Identifier of the schedule for the cooling setpoint. The values in this schedule should be temperature in [C].",
"maxLength": 100,
"minLength": 1,
"title": "Cooling Schedule",
"type": "string"
},
"heating_schedule": {
"description": "Identifier of the schedule for the heating setpoint. The values in this schedule should be temperature in [C].",
"maxLength": 100,
"minLength": 1,
"title": "Heating Schedule",
"type": "string"
},
"type": {
"const": "SetpointAbridged",
"default": "SetpointAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"humidifying_schedule": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of the schedule for the humidification setpoint. The values in this schedule should be in [%].",
"title": "Humidifying Schedule"
},
"dehumidifying_schedule": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of the schedule for the dehumidification setpoint. The values in this schedule should be in [%].",
"title": "Dehumidifying Schedule"
},
"setpoint_cutout_difference": {
"default": 0,
"description": "An optional positive number for the temperature difference between the cutout temperature and the setpoint temperature. Specifying a non-zero number here is useful for modeling the throttling range associated with a given setup of setpoint controls and HVAC equipment. Throttling ranges describe the range where a zone is slightly over-cooled or over-heated beyond the thermostat setpoint. They are used to avoid situations where HVAC systems turn on only to turn off a few minutes later, thereby wearing out the parts of mechanical systems faster. They can have a minor impact on energy consumption and can often have significant impacts on occupant thermal comfort, though using the default value of zero will often yield results that are close enough when trying to estimate the annual heating/cooling energy use. Specifying a value of zero effectively assumes that the system will turn on whenever conditions are outside the setpoint range and will cut out as soon as the setpoint is reached.",
"minimum": 0,
"title": "Setpoint Cutout Difference",
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
],
"description": "Used to specify information about the setpoint schedule.",
"title": "SetpointAbridged",
"discriminator": {
"propertyName": "type"
}
},
"Shade": {
"allOf": [
{
"$ref": "#/components/schemas/IDdBaseModel"
},
{
"type": "object",
"required": [
"geometry",
"properties"
],
"properties": {
"geometry": {
"$ref": "#/components/schemas/Face3D",
"description": "Planar Face3D for the geometry."
},
"properties": {
"$ref": "#/components/schemas/ShadePropertiesAbridged",
"description": "Extension properties for particular simulation engines (Radiance, EnergyPlus)."
},
"type": {
"const": "Shade",
"default": "Shade",
"title": "Type",
"type": "string",
"readOnly": true
},
"is_detached": {
"default": false,
"description": "Boolean to note whether this shade is detached from any of the other geometry in the model. Cases where this should be True include shade representing surrounding buildings or context. Note that this should always be False for shades assigned to parent objects.",
"title": "Is Detached",
"type": "boolean"
}
},
"additionalProperties": false
}
],
"title": "Shade",
"discriminator": {
"propertyName": "type"
}
},
"ShadeConstruction": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "ShadeConstruction",
"default": "ShadeConstruction",
"title": "Type",
"type": "string",
"readOnly": true
},
"solar_reflectance": {
"default": 0.2,
"description": "A number for the solar reflectance of the construction.",
"maximum": 1,
"minimum": 0,
"title": "Solar Reflectance",
"type": "number",
"format": "double"
},
"visible_reflectance": {
"default": 0.2,
"description": "A number for the visible reflectance of the construction.",
"maximum": 1,
"minimum": 0,
"title": "Visible Reflectance",
"type": "number",
"format": "double"
},
"is_specular": {
"default": false,
"description": "Boolean to note whether the reflection off the shade is diffuse (False) or specular (True). Set to True if the construction is representing a glass facade or a mirror material.",
"title": "Is Specular",
"type": "boolean"
}
},
"additionalProperties": false
}
],
"description": "Construction for Shade objects.",
"title": "ShadeConstruction",
"discriminator": {
"propertyName": "type"
}
},
"ShadeEnergyPropertiesAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "ShadeEnergyPropertiesAbridged",
"default": "ShadeEnergyPropertiesAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"construction": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of a ShadeConstruction to set the reflectance and specularity of the Shade. If None, the construction is set by theparent Room construction_set, the Model global_construction_set or (in the case fo an orphaned shade) the EnergyPlus default of 0.2 diffuse reflectance.",
"title": "Construction"
},
"transmittance_schedule": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of a schedule to set the transmittance of the shade, which can vary throughout the simulation. If None, the shade will be completely opaque.",
"title": "Transmittance Schedule"
},
"pv_properties": {
"anyOf": [
{
"$ref": "#/components/schemas/PVProperties"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional PVProperties object to specify photovoltaic behavior of the Shade. If None, the Shade will have no Photovoltaic properties. Note that the normal of the Shade is important in determining the performance of the shade as a PV geometry."
}
},
"additionalProperties": false
}
],
"title": "ShadeEnergyPropertiesAbridged",
"discriminator": {
"propertyName": "type"
}
},
"ShadeLocation": {
"description": "Choices for where a shade material is located in a window assembly.",
"enum": [
"Interior",
"Between",
"Exterior"
],
"title": "ShadeLocation",
"type": "string"
},
"ShadeMesh": {
"allOf": [
{
"$ref": "#/components/schemas/IDdBaseModel"
},
{
"type": "object",
"required": [
"geometry",
"properties"
],
"properties": {
"geometry": {
"$ref": "#/components/schemas/Mesh3D",
"description": "A Mesh3D for the geometry."
},
"properties": {
"$ref": "#/components/schemas/ShadeMeshPropertiesAbridged",
"description": "Extension properties for particular simulation engines (Radiance, EnergyPlus)."
},
"type": {
"const": "ShadeMesh",
"default": "ShadeMesh",
"title": "Type",
"type": "string",
"readOnly": true
},
"is_detached": {
"default": true,
"description": "Boolean to note whether this shade is detached from any of the other geometry in the model. Cases where this should be True include shade representing surrounding buildings or context.",
"title": "Is Detached",
"type": "boolean"
}
},
"additionalProperties": false
}
],
"title": "ShadeMesh",
"discriminator": {
"propertyName": "type"
}
},
"ShadeMeshEnergyPropertiesAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "ShadeMeshEnergyPropertiesAbridged",
"default": "ShadeMeshEnergyPropertiesAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"construction": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of a ShadeConstruction to set the reflectance and specularity of the Shade. If None, it will be a generic context construction that is completely diffuse with 0.2 visible and solar reflectance. Unless it is building attached, in which case it will be set by the default generic ConstructionSet.",
"title": "Construction"
},
"transmittance_schedule": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of a schedule to set the transmittance of the shade, which can vary throughout the simulation. If None, the shade will be completely opaque.",
"title": "Transmittance Schedule"
}
},
"additionalProperties": false
}
],
"title": "ShadeMeshEnergyPropertiesAbridged",
"discriminator": {
"propertyName": "type"
}
},
"ShadeMeshPropertiesAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "ShadeMeshPropertiesAbridged",
"default": "ShadeMeshPropertiesAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"energy": {
"anyOf": [
{
"$ref": "#/components/schemas/ShadeMeshEnergyPropertiesAbridged"
},
{
"type": "null"
}
],
"default": null
},
"radiance": {
"anyOf": [
{
"$ref": "#/components/schemas/ShadeMeshRadiancePropertiesAbridged"
},
{
"type": "null"
}
],
"default": null
}
}
}
],
"title": "ShadeMeshPropertiesAbridged",
"discriminator": {
"propertyName": "type"
}
},
"ShadeMeshRadiancePropertiesAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_PropertiesBaseAbridged"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "ShadeMeshRadiancePropertiesAbridged",
"default": "ShadeMeshRadiancePropertiesAbridged",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Radiance Properties for Honeybee ShadeMesh Abridged.",
"title": "ShadeMeshRadiancePropertiesAbridged",
"discriminator": {
"propertyName": "type"
}
},
"ShadeModifierSet": {
"allOf": [
{
"$ref": "#/components/schemas/BaseModifierSet"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "ShadeModifierSet",
"default": "ShadeModifierSet",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Set containing radiance modifiers needed for a model's Shade.",
"title": "ShadeModifierSet",
"discriminator": {
"propertyName": "type"
}
},
"ShadeModifierSetAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/BaseModifierSetAbridged"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "ShadeModifierSetAbridged",
"default": "ShadeModifierSetAbridged",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Abridged set containing radiance modifiers needed for a model's Shade.",
"title": "ShadeModifierSetAbridged",
"discriminator": {
"propertyName": "type"
}
},
"ShadePropertiesAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "ShadePropertiesAbridged",
"default": "ShadePropertiesAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"energy": {
"anyOf": [
{
"$ref": "#/components/schemas/ShadeEnergyPropertiesAbridged"
},
{
"type": "null"
}
],
"default": null
},
"radiance": {
"anyOf": [
{
"$ref": "#/components/schemas/ShadeRadiancePropertiesAbridged"
},
{
"type": "null"
}
],
"default": null
}
}
}
],
"title": "ShadePropertiesAbridged",
"discriminator": {
"propertyName": "type"
}
},
"ShadeRadiancePropertiesAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_PropertiesBaseAbridged"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "ShadeRadiancePropertiesAbridged",
"default": "ShadeRadiancePropertiesAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"dynamic_group_identifier": {
"default": null,
"description": "An optional string to note the dynamic group to which the Shade is a part of. Shades sharing the same dynamic_group_identifier will have their states change in unison. If None, the Shade is assumed to be static.",
"title": "Dynamic Group Identifier",
"type": "string"
},
"states": {
"default": null,
"description": "An optional list of abridged states (default: None).",
"items": {
"$ref": "#/components/schemas/RadianceShadeStateAbridged"
},
"title": "States",
"type": "array"
}
},
"additionalProperties": false
}
],
"description": "Radiance Properties for Honeybee Shade Abridged.",
"title": "ShadeRadiancePropertiesAbridged",
"discriminator": {
"propertyName": "type"
}
},
"SlatOrientation": {
"enum": [
"Horizontal",
"Vertical"
],
"title": "SlatOrientation",
"type": "string"
},
"StateGeometryAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/IDdRadianceBaseModel"
},
{
"type": "object",
"required": [
"geometry"
],
"properties": {
"geometry": {
"$ref": "#/components/schemas/Face3D",
"description": "A ladybug_geometry Face3D."
},
"type": {
"const": "StateGeometryAbridged",
"default": "StateGeometryAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"modifier": {
"default": null,
"description": "A string for a Honeybee Radiance Modifier identifier (default: None).",
"title": "Modifier",
"type": "string"
},
"modifier_direct": {
"default": null,
"description": "A string for Honeybee Radiance Modifier identifiers to be used in direct solar simulations and in isolation studies (assessingthe contribution of individual objects) (default: None).",
"title": "Modifier Direct",
"type": "string"
}
},
"additionalProperties": false
}
],
"description": "A single planar geometry that can be assigned to Radiance states.",
"title": "StateGeometryAbridged",
"discriminator": {
"propertyName": "type"
}
},
"Surface": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"boundary_condition_objects": {
"description": "A list of up to 3 object identifiers that are adjacent to this one. The first object is always the one that is immediately adjacent and is of the same object type (Face, Aperture, Door). When this boundary condition is applied to a Face, the second object in the tuple will be the parent Room of the adjacent object. When the boundary condition is applied to a sub-face (Door or Aperture), the second object will be the parent Face of the adjacent sub-face and the third object will be the parent Room of the adjacent sub-face.",
"items": {
"type": "string"
},
"maxItems": 3,
"minItems": 2,
"title": "Boundary Condition Objects",
"type": "array"
},
"type": {
"const": "Surface",
"default": "Surface",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false,
"required": [
"boundary_condition_objects"
]
}
],
"title": "Surface",
"discriminator": {
"propertyName": "type"
}
},
"Trans": {
"allOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"type": "object",
"required": [],
"properties": {
"transmitted_diff": {
"default": 0,
"description": "The fraction of transmitted light that is transmitted diffusely in a scattering fashion.",
"maximum": 1,
"minimum": 0,
"title": "Transmitted Diff",
"type": "number",
"format": "double"
},
"transmitted_spec": {
"default": 0,
"description": "The fraction of transmitted light that is not diffusely scattered.",
"maximum": 1,
"minimum": 0,
"title": "Transmitted Spec",
"type": "number",
"format": "double"
},
"type": {
"const": "Trans",
"default": "Trans",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Radiance Translucent material.",
"title": "Trans",
"discriminator": {
"propertyName": "type"
}
},
"Units": {
"enum": [
"Meters",
"Millimeters",
"Feet",
"Inches",
"Centimeters"
],
"title": "Units",
"type": "string"
},
"VAV": {
"allOf": [
{
"$ref": "#/components/schemas/_AllAirBase"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "VAV",
"default": "VAV",
"title": "Type",
"type": "string",
"readOnly": true
},
"equipment_type": {
"$ref": "#/components/schemas/VAVEquipmentType",
"default": "VAV_Chiller_Boiler",
"description": "Text for the specific type of system equipment from the VAVEquipmentType enumeration."
}
},
"additionalProperties": false
}
],
"description": "Variable Air Volume (VAV) HVAC system (aka. System 7 or 8).\n\nAll rooms/zones are connected to a central air loop that is kept at a constant\ncentral temperature of 12.8C (55F). The central temperature is maintained by a\ncooling coil, which runs whenever the combination of return air and fresh outdoor\nair is greater than 12.8C, as well as a heating coil, which runs whenever\nthe combination of return air and fresh outdoor air is less than 12.8C.\n\nEach air terminal for the connected rooms/zones contains its own reheat coil,\nwhich runs whenever the room is not in need of the cooling supplied by the 12.8C\ncentral air.\n\nThe central cooling coil is always a chilled water coil, which is connected to a\nchilled water loop operating at 6.7C (44F). All heating coils are hot water coils\nexcept when Gas Coil equipment_type is used (in which case coils are gas)\nor when Parallel Fan-Powered (PFP) boxes equipment_type is used (in which case\ncoils are electric resistance). Hot water temperature is 82C (180F) for\nboiler/district heating and 49C (120F) when ASHP is used.\n\nVAV systems are the traditional baseline system for commercial buildings\ntaller than 5 stories or larger than 14,000 m2 (150,000 ft2) of floor area.",
"title": "VAV",
"discriminator": {
"propertyName": "type"
}
},
"VAVEquipmentType": {
"enum": [
"VAV_Chiller_Boiler",
"VAV_Chiller_ASHP",
"VAV_Chiller_DHW",
"VAV_Chiller_PFP",
"VAV_Chiller_GasCoil",
"VAV_ACChiller_Boiler",
"VAV_ACChiller_ASHP",
"VAV_ACChiller_DHW",
"VAV_ACChiller_PFP",
"VAV_ACChiller_GasCoil",
"VAV_DCW_Boiler",
"VAV_DCW_ASHP",
"VAV_DCW_DHW",
"VAV_DCW_PFP",
"VAV_DCW_GasCoil"
],
"title": "VAVEquipmentType",
"type": "string"
},
"VRF": {
"allOf": [
{
"$ref": "#/components/schemas/_HeatCoolBase"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "VRF",
"default": "VRF",
"title": "Type",
"type": "string",
"readOnly": true
},
"equipment_type": {
"$ref": "#/components/schemas/VRFEquipmentType",
"default": "VRF",
"description": "Text for the specific type of system equipment from the VRFEquipmentType enumeration."
}
},
"additionalProperties": false
}
],
"description": "Variable Refrigerant Flow (VRF) heating/cooling system (with no ventilation).\n\nEach room/zone receives its own Variable Refrigerant Flow (VRF) terminal,\nwhich meets the heating and cooling loads of the space. All room/zone terminals\nare connected to the same outdoor unit, meaning that either all rooms must be\nin cooling or heating mode together.",
"title": "VRF",
"discriminator": {
"propertyName": "type"
}
},
"VRFEquipmentType": {
"enum": [
"VRF"
],
"title": "VRFEquipmentType",
"type": "string"
},
"VRFwithDOASAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_DOASBase"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "VRFwithDOASAbridged",
"default": "VRFwithDOASAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"equipment_type": {
"$ref": "#/components/schemas/VRFwithDOASEquipmentType",
"default": "DOAS_VRF",
"description": "Text for the specific type of system equipment from the VRFwithDOASEquipmentType enumeration."
}
},
"additionalProperties": false
}
],
"description": "Variable Refrigerant Flow (VRF) with DOAS HVAC system.\n\nAll rooms/zones in the system are connected to a Dedicated Outdoor Air System\n(DOAS) that supplies a constant volume of ventilation air at the same temperature\nto all rooms/zones. The ventilation air temperature will vary from 21.1C (70F)\nto 15.5C (60F) depending on the outdoor air temperature (the DOAS supplies cooler air\nwhen outdoor conditions are warmer). The ventilation air temperature is maintained\nby a single speed direct expansion (DX) cooling coil along with a single-speed\ndirect expansion (DX) heat pump with a backup electrical resistance coil.\n\nEach room/zone also receives its own Variable Refrigerant Flow (VRF) terminal,\nwhich meets the heating and cooling loads of the space. All room/zone terminals\nare connected to the same outdoor unit, meaning that either all rooms must be\nin cooling or heating mode together.",
"title": "VRFwithDOASAbridged",
"discriminator": {
"propertyName": "type"
}
},
"VRFwithDOASEquipmentType": {
"enum": [
"DOAS_VRF"
],
"title": "VRFwithDOASEquipmentType",
"type": "string"
},
"Ventilation": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "Ventilation",
"default": "Ventilation",
"title": "Type",
"type": "string",
"readOnly": true
},
"flow_per_person": {
"default": 0,
"description": "Intensity of ventilation in[] m3/s per person]. Note that setting this value does not mean that ventilation is varied based on real-time occupancy but rather that the design level of ventilation is determined using this value and the People object of the Room.",
"minimum": 0,
"title": "Flow Per Person",
"type": "number",
"format": "double"
},
"flow_per_area": {
"default": 0,
"description": "Intensity of ventilation in [m3/s per m2 of floor area].",
"minimum": 0,
"title": "Flow Per Area",
"type": "number",
"format": "double"
},
"air_changes_per_hour": {
"default": 0,
"description": "Intensity of ventilation in air changes per hour (ACH) for the entire Room.",
"minimum": 0,
"title": "Air Changes Per Hour",
"type": "number",
"format": "double"
},
"flow_per_zone": {
"default": 0,
"description": "Intensity of ventilation in m3/s for the entire Room.",
"minimum": 0,
"title": "Flow Per Zone",
"type": "number",
"format": "double"
},
"schedule": {
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
},
{
"type": "null"
}
],
"default": null,
"description": "Schedule for the ventilation over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the total design flow rate (determined from the sum of the other 4 fields) to yield a complete ventilation profile.",
"title": "Schedule"
},
"method": {
"$ref": "#/components/schemas/VentilationMethod",
"default": "Sum",
"description": "Text to set how the ventilation criteria are reconciled against one another."
}
},
"additionalProperties": false
}
],
"title": "Ventilation",
"discriminator": {
"propertyName": "type"
}
},
"VentilationAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "VentilationAbridged",
"default": "VentilationAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"flow_per_person": {
"default": 0,
"description": "Intensity of ventilation in[] m3/s per person]. Note that setting this value does not mean that ventilation is varied based on real-time occupancy but rather that the design level of ventilation is determined using this value and the People object of the Room.",
"minimum": 0,
"title": "Flow Per Person",
"type": "number",
"format": "double"
},
"flow_per_area": {
"default": 0,
"description": "Intensity of ventilation in [m3/s per m2 of floor area].",
"minimum": 0,
"title": "Flow Per Area",
"type": "number",
"format": "double"
},
"air_changes_per_hour": {
"default": 0,
"description": "Intensity of ventilation in air changes per hour (ACH) for the entire Room.",
"minimum": 0,
"title": "Air Changes Per Hour",
"type": "number",
"format": "double"
},
"flow_per_zone": {
"default": 0,
"description": "Intensity of ventilation in m3/s for the entire Room.",
"minimum": 0,
"title": "Flow Per Zone",
"type": "number",
"format": "double"
},
"schedule": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of the schedule for the ventilation over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the total design flow rate (determined from the sum of the other 4 fields) to yield a complete ventilation profile.",
"title": "Schedule"
},
"method": {
"$ref": "#/components/schemas/VentilationMethod",
"default": "Sum",
"description": "Text to set how the ventilation criteria are reconciled against one another."
}
},
"additionalProperties": false
}
],
"title": "VentilationAbridged",
"discriminator": {
"propertyName": "type"
}
},
"VentilationControlAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "VentilationControlAbridged",
"default": "VentilationControlAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"min_indoor_temperature": {
"default": -100,
"description": "A number for the minimum indoor temperature at which to ventilate in Celsius. Typically, this variable is used to initiate ventilation.",
"maximum": 100,
"minimum": -100,
"title": "Min Indoor Temperature",
"type": "number",
"format": "double"
},
"max_indoor_temperature": {
"default": 100,
"description": "A number for the maximum indoor temperature at which to ventilate in Celsius. This can be used to set a maximum temperature at which point ventilation is stopped and a cooling system is turned on.",
"maximum": 100,
"minimum": -100,
"title": "Max Indoor Temperature",
"type": "number",
"format": "double"
},
"min_outdoor_temperature": {
"default": -100,
"description": "A number for the minimum outdoor temperature at which to ventilate in Celsius. This can be used to ensure ventilative cooling does not happen during the winter even if the Room is above the min_indoor_temperature.",
"maximum": 100,
"minimum": -100,
"title": "Min Outdoor Temperature",
"type": "number",
"format": "double"
},
"max_outdoor_temperature": {
"default": 100,
"description": "A number for the maximum indoor temperature at which to ventilate in Celsius. This can be used to set a limit for when it is considered too hot outside for ventilative cooling.",
"maximum": 100,
"minimum": -100,
"title": "Max Outdoor Temperature",
"type": "number",
"format": "double"
},
"delta_temperature": {
"default": -100,
"description": "A number for the temperature differential in Celsius between indoor and outdoor below which ventilation is shut off. This should usually be a positive number so that ventilation only occurs when the outdoors is cooler than the indoors. Negative numbers indicate how much hotter the outdoors can be than the indoors before ventilation is stopped.",
"maximum": 100,
"minimum": -100,
"title": "Delta Temperature",
"type": "number",
"format": "double"
},
"schedule": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of the schedule for the ventilation over the course of the year. Note that this is applied on top of any setpoints. The type of this schedule should be On/Off and values should be either 0 (no possibility of ventilation) or 1 (ventilation possible).",
"title": "Schedule"
}
},
"additionalProperties": false
}
],
"title": "VentilationControlAbridged",
"discriminator": {
"propertyName": "type"
}
},
"VentilationControlType": {
"enum": [
"SingleZone",
"MultiZoneWithDistribution",
"MultiZoneWithoutDistribution"
],
"title": "VentilationControlType",
"type": "string"
},
"VentilationFan": {
"allOf": [
{
"$ref": "#/components/schemas/EnergyBaseModel"
},
{
"type": "object",
"required": [
"flow_rate",
"pressure_rise",
"efficiency"
],
"properties": {
"flow_rate": {
"description": "A number for the flow rate of the fan in m3/s.",
"exclusiveMinimum": 0,
"title": "Flow Rate",
"type": "number",
"format": "double"
},
"pressure_rise": {
"description": "A number for the the pressure rise across the fan in Pascals (N/m2). This is often a function of the fan speed and the conditions in which the fan is operating since having the fan blow air through filters or narrow ducts will increase the pressure rise that is needed to deliver the input flow rate. The pressure rise plays an important role in determining the amount of energy consumed by the fan. Smaller fans like a 0.05 m3/s desk fan tend to have lower pressure rises around 60 Pa. Larger fans, such as a 6 m3/s fan used for ventilating a large room tend to have higher pressure rises around 400 Pa. The highest pressure rises are typically for large fans blowing air through ducts and filters, which can have pressure rises as high as 1000 Pa.",
"exclusiveMinimum": 0,
"title": "Pressure Rise",
"type": "number",
"format": "double"
},
"efficiency": {
"description": "A number between 0 and 1 for the overall efficiency of the fan. Specifically, this is the ratio of the power delivered to the fluid to the electrical input power. It is the product of the fan motor efficiency and the fan impeller efficiency. Fans that have a higher blade diameter and operate at lower speeds with smaller pressure rises for their size tend to have higher efficiencies. Because motor efficiencies are typically between 0.8 and 0.9, the best overall fan efficiencies tend to be around 0.7 with most typical fan efficiencies between 0.5 and 0.7. The lowest efficiencies often happen for small fans in situations with high pressure rises for their size, which can result in efficiencies as low as 0.15.",
"maximum": 1,
"minimum": 0,
"title": "Efficiency",
"type": "number",
"format": "double"
},
"type": {
"const": "VentilationFan",
"default": "VentilationFan",
"title": "Type",
"type": "string",
"readOnly": true
},
"ventilation_type": {
"$ref": "#/components/schemas/VentilationType",
"default": "Balanced",
"description": "Text to indicate the type of type of ventilation. Choose from the options below. For either Exhaust or Intake, values for fan pressure and efficiency define the fan electric consumption. For Exhaust ventilation, the conditions of the air entering the space are assumed to be equivalent to outside air conditions. For Intake and Balanced ventilation, an appropriate amount of fan heat is added to the entering air stream. For Balanced ventilation, both an intake fan and an exhaust fan are assumed to co-exist, both having the same flow rate and power consumption (using the entered values for fan pressure rise and fan total efficiency). Thus, the fan electric consumption for Balanced ventilation is twice that for the Exhaust or Intake ventilation types which employ only a single fan."
},
"control": {
"anyOf": [
{
"$ref": "#/components/schemas/VentilationControlAbridged"
},
{
"type": "null"
}
],
"default": null,
"description": "A VentilationControl object that dictates the conditions under which the fan is turned on. If None, a default VentilationControl will be generated, which will keep the fan on all of the time."
}
},
"additionalProperties": false
}
],
"title": "VentilationFan",
"discriminator": {
"propertyName": "type"
}
},
"VentilationMethod": {
"enum": [
"Sum",
"Max"
],
"title": "VentilationMethod",
"type": "string"
},
"VentilationOpening": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "VentilationOpening",
"default": "VentilationOpening",
"title": "Type",
"type": "string",
"readOnly": true
},
"fraction_area_operable": {
"default": 0.5,
"description": "A number for the fraction of the window area that is operable.",
"maximum": 1,
"minimum": 0,
"title": "Fraction Area Operable",
"type": "number",
"format": "double"
},
"fraction_height_operable": {
"default": 1.0,
"description": "A number for the fraction of the distance from the bottom of the window to the top that is operable",
"maximum": 1,
"minimum": 0,
"title": "Fraction Height Operable",
"type": "number",
"format": "double"
},
"discharge_coefficient": {
"default": 0.45,
"description": "A number that will be multiplied by the area of the window in the stack (buoyancy-driven) part of the equation to account for additional friction from window geometry, insect screens, etc. Typical values include 0.45, for unobstructed windows WITH insect screens and 0.65 for unobstructed windows WITHOUT insect screens. This value should be lowered if windows are of an awning or casement type and are not allowed to fully open.",
"maximum": 1,
"minimum": 0,
"title": "Discharge Coefficient",
"type": "number",
"format": "double"
},
"wind_cross_vent": {
"default": false,
"description": "Boolean to indicate if there is an opening of roughly equal area on the opposite side of the Room such that wind-driven cross ventilation will be induced. If False, the assumption is that the operable area is primarily on one side of the Room and there is no wind-driven ventilation.",
"title": "Wind Cross Vent",
"type": "boolean"
},
"flow_coefficient_closed": {
"default": 0,
"description": "An optional number in kg/s-m, at 1 Pa per meter of crack length, used to calculate the mass flow rate when the opening is closed; required to run an AirflowNetwork simulation. The DesignBuilder Cracks template defines the flow coefficient for a tight, low-leakage closed external window to be 0.00001, and the flow coefficient for a very poor, high-leakage closed external window to be 0.003.",
"minimum": 0,
"title": "Flow Coefficient Closed",
"type": "number",
"format": "double"
},
"flow_exponent_closed": {
"default": 0.65,
"description": "An optional dimensionless number between 0.5 and 1 used to calculate the mass flow rate when the opening is closed; required to run an AirflowNetwork simulation. This value represents the leak geometry impact on airflow, with 0.5 generally corresponding to turbulent orifice flow and 1 generally corresponding to laminar flow. The default of 0.65 is representative of many cases of wall and window leakage, used when the exponent cannot be measured.",
"maximum": 1,
"minimum": 0.5,
"title": "Flow Exponent Closed",
"type": "number",
"format": "double"
},
"two_way_threshold": {
"default": 0.0001,
"description": "A number in kg/m3 indicating the minimum density difference above which two-way flow may occur due to stack effect, required to run an AirflowNetwork simulation. This value is required because the air density difference between two zones (which drives two-way air flow) will tend towards division by zero errors as the air density difference approaches zero. The default of 0.0001 is a typical default value used for AirflowNetwork openings.",
"exclusiveMinimum": 0,
"title": "Two Way Threshold",
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
],
"title": "VentilationOpening",
"discriminator": {
"propertyName": "type"
}
},
"VentilationSimulationControl": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "VentilationSimulationControl",
"default": "VentilationSimulationControl",
"title": "Type",
"type": "string",
"readOnly": true
},
"vent_control_type": {
"$ref": "#/components/schemas/VentilationControlType",
"default": "SingleZone",
"description": "Text indicating type of ventilation control. Choices are: SingleZone, MultiZoneWithDistribution, MultiZoneWithoutDistribution. The MultiZone options will model air flow with the AirflowNetwork model, which is generally more accurate then the SingleZone option, but will take considerably longer to simulate, and requires defining more ventilation parameters to explicitly account for weather and building-induced pressure differences, and the leakage geometry corresponding to specific windows, doors, and surface cracks."
},
"reference_temperature": {
"default": 20,
"description": "Reference temperature measurement in Celsius under which the surface crack data were obtained.",
"minimum": -273.15,
"title": "Reference Temperature",
"type": "number",
"format": "double"
},
"reference_pressure": {
"default": 101325,
"description": "Reference barometric pressure measurement in Pascals under which the surface crack data were obtained.",
"maximum": 120000,
"minimum": 31000,
"title": "Reference Pressure",
"type": "number",
"format": "double"
},
"reference_humidity_ratio": {
"default": 0,
"description": "Reference humidity ratio measurement in kgWater/kgDryAir under which the surface crack data were obtained.",
"minimum": 0,
"title": "Reference Humidity Ratio",
"type": "number",
"format": "double"
},
"building_type": {
"$ref": "#/components/schemas/BuildingType",
"default": "LowRise",
"description": "Text indicating relationship between building footprint and height used to calculate the wind pressure coefficients for exterior surfaces.Choices are: LowRise and HighRise. LowRise corresponds to rectangular building whose height is less then three times the width and length of the footprint. HighRise corresponds to a rectangular building whose height is more than three times the width and length of the footprint. This parameter is required to automatically calculate wind pressure coefficients for the AirflowNetwork simulation. If used for complex building geometries that cannot be described as a highrise or lowrise rectangular mass, the resulting air flow and pressure simulated on the building surfaces may be inaccurate."
},
"long_axis_angle": {
"default": 0,
"description": "The clockwise rotation in degrees from true North of the long axis of the building. This parameter is required to automatically calculate wind pressure coefficients for the AirflowNetwork simulation. If used for complex building geometries that cannot be described as a highrise or lowrise rectangular mass, the resulting air flow and pressure simulated on the building surfaces may be inaccurate.",
"maximum": 180,
"minimum": 0,
"title": "Long Axis Angle",
"type": "number",
"format": "double"
},
"aspect_ratio": {
"default": 1,
"description": "Aspect ratio of a rectangular footprint, defined as the ratio of length of the short axis divided by the length of the long axis. This parameter is required to automatically calculate wind pressure coefficients for the AirflowNetwork simulation. If used for complex building geometries that cannot be described as a highrise or lowrise rectangular mass, the resulting air flow and pressure simulated on the building surfaces may be inaccurate.",
"exclusiveMinimum": 0,
"maximum": 1,
"title": "Aspect Ratio",
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
],
"description": "The global parameters used in the ventilation simulation.",
"title": "VentilationSimulationControl",
"discriminator": {
"propertyName": "type"
}
},
"VentilationType": {
"enum": [
"Exhaust",
"Intake",
"Balanced"
],
"title": "VentilationType",
"type": "string"
},
"View": {
"allOf": [
{
"$ref": "#/components/schemas/_RadianceAsset"
},
{
"type": "object",
"required": [
"position",
"direction",
"up_vector"
],
"properties": {
"position": {
"description": "The view position (-vp) as an array of (x, y, z) values.This is the focal point of a perspective view or the center of a parallel projection.",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 3,
"minItems": 3,
"title": "Position",
"type": "array"
},
"direction": {
"description": "The view direction (-vd) as an array of (x, y, z) values.The length of this vector indicates the focal distance as needed by the pixel depth of field (-pd) in rpict.",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 3,
"minItems": 3,
"title": "Direction",
"type": "array"
},
"up_vector": {
"description": "The view up (-vu) vector as an array of (x, y, z) values.",
"items": {
"type": "number",
"format": "double"
},
"maxItems": 3,
"minItems": 3,
"title": "Up Vector",
"type": "array"
},
"type": {
"const": "View",
"default": "View",
"title": "Type",
"type": "string",
"readOnly": true
},
"view_type": {
"$ref": "#/components/schemas/ViewType",
"default": "v"
},
"h_size": {
"default": 60,
"description": "A number for the horizontal field of view in degrees (for all perspective projections including fisheye). For a parallel projection, this is the view width in world coordinates.",
"title": "H Size",
"type": "number",
"format": "double"
},
"v_size": {
"default": 60,
"description": "A number for the vertical field of view in degrees (for all perspective projections including fisheye). For a parallel projection, this is the view width in world coordinates.",
"title": "V Size",
"type": "number",
"format": "double"
},
"shift": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The view shift (-vs). This is the amount the actual image will be shifted to the right of the specified view. This option is useful for generating skewed perspectives or rendering an image a piece at a time. A value of 1 means that the rendered image starts just to the right of the normal view. A value of -1 would be to the left. Larger or fractional values are permitted as well.",
"title": "Shift"
},
"lift": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The view lift (-vl). This is the amount the actual image will be lifted up from the specified view. This option is useful for generating skewed perspectives or rendering an image a piece at a time. A value of 1 means that the rendered image starts just to the right of the normal view. A value of -1 would be to the left. Larger or fractional values are permitted as well.",
"title": "Lift"
},
"fore_clip": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "View fore clip (-vo) at a distance from the view point.The plane will be perpendicular to the view direction for perspective and parallel view types. For fisheye view types, the clipping plane is actually a clipping sphere, centered on the view point with fore_clip radius. Objects in front of this imaginary surface will not be visible.",
"title": "Fore Clip"
},
"aft_clip": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "View aft clip (-va) at a distance from the view point.Like the view fore plane, it will be perpendicular to the view direction for perspective and parallel view types. For fisheye view types, the clipping plane is actually a clipping sphere, centered on the view point with radius val.",
"title": "Aft Clip"
},
"group_identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional string to note the view group ' 'to which the sensor is a part of. Views sharing the same ' 'group_identifier will be written to the same subfolder in Radiance ' 'folder (default: None).",
"title": "Group Identifier"
}
},
"additionalProperties": false
}
],
"description": "A single Radiance of sensors.",
"title": "View",
"discriminator": {
"propertyName": "type"
}
},
"ViewType": {
"description": "A single character for the view type (-vt).",
"enum": [
"v",
"h",
"l",
"c",
"a",
"s"
],
"title": "ViewType",
"type": "string"
},
"Vintages": {
"enum": [
"ASHRAE_2019",
"ASHRAE_2016",
"ASHRAE_2013",
"ASHRAE_2010",
"ASHRAE_2007",
"ASHRAE_2004",
"DOE_Ref_1980_2004",
"DOE_Ref_Pre_1980"
],
"title": "Vintages",
"type": "string"
},
"Void": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"type": {
"const": "Void",
"default": "Void",
"title": "Type",
"type": "string",
"readOnly": true
}
}
}
],
"description": "Void modifier",
"title": "Void",
"discriminator": {
"propertyName": "type"
}
},
"WSHP": {
"allOf": [
{
"$ref": "#/components/schemas/_HeatCoolBase"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "WSHP",
"default": "WSHP",
"title": "Type",
"type": "string",
"readOnly": true
},
"equipment_type": {
"$ref": "#/components/schemas/WSHPEquipmentType",
"default": "WSHP_FluidCooler_Boiler",
"description": "Text for the specific type of system equipment from the WSHPEquipmentType enumeration."
}
},
"additionalProperties": false
}
],
"description": "Water Source Heat Pump (WSHP) heating/cooling system (with no ventilation).\n\nEach room/zone receives its own Water Source Heat Pump (WSHP), which meets\nthe heating and cooling loads of the space. All WSHPs are connected to the\nsame water condenser loop, which has its temperature maintained by the\nequipment_type (eg. Boiler with Cooling Tower).",
"title": "WSHP",
"discriminator": {
"propertyName": "type"
}
},
"WSHPEquipmentType": {
"enum": [
"WSHP_FluidCooler_Boiler",
"WSHP_CoolingTower_Boiler",
"WSHP_GSHP",
"WSHP_DCW_DHW"
],
"title": "WSHPEquipmentType",
"type": "string"
},
"WSHPwithDOASAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_DOASBase"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "WSHPwithDOASAbridged",
"default": "WSHPwithDOASAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"equipment_type": {
"$ref": "#/components/schemas/WSHPwithDOASEquipmentType",
"default": "DOAS_WSHP_FluidCooler_Boiler",
"description": "Text for the specific type of system equipment from the WSHPwithDOASEquipmentType enumeration."
}
},
"additionalProperties": false
}
],
"description": "Water Source Heat Pump (WSHP) with DOAS HVAC system.\n\nAll rooms/zones in the system are connected to a Dedicated Outdoor Air System\n(DOAS) that supplies a constant volume of ventilation air at the same temperature\nto all rooms/zones. The ventilation air temperature will vary from 21.1C (70F)\nto 15.5C (60F) depending on the outdoor air temperature (the DOAS supplies cooler air\nwhen outdoor conditions are warmer). The ventilation air temperature is maintained\nby a chilled water cooling coil and a hot water heating coil except when the\nground source heat pump (GSHP) option is selected. In this case, the ventilation\nair temperature is maintained by a two-speed direct expansion (DX) cooling coil\nand a single-speed DX heating coil with backup electrical resistance heat.\n\nEach room/zone also receives its own Water Source Heat Pump (WSHP), which meets\nthe heating and cooling loads of the space. All WSHPs are connected to the\nsame water condenser loop, which has its temperature maintained by the\nequipment_type (eg. Boiler with Cooling Tower).",
"title": "WSHPwithDOASAbridged",
"discriminator": {
"propertyName": "type"
}
},
"WSHPwithDOASEquipmentType": {
"enum": [
"DOAS_WSHP_FluidCooler_Boiler",
"DOAS_WSHP_CoolingTower_Boiler",
"DOAS_WSHP_GSHP",
"DOAS_WSHP_DCW_DHW"
],
"title": "WSHPwithDOASEquipmentType",
"type": "string"
},
"WallConstructionSet": {
"allOf": [
{
"$ref": "#/components/schemas/_FaceSubSet"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "WallConstructionSet",
"default": "WallConstructionSet",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "A set of constructions for wall assemblies.",
"title": "WallConstructionSet",
"discriminator": {
"propertyName": "type"
}
},
"WallConstructionSetAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_FaceSubSetAbridged"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "WallConstructionSetAbridged",
"default": "WallConstructionSetAbridged",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "A set of constructions for wall assemblies.",
"title": "WallConstructionSetAbridged",
"discriminator": {
"propertyName": "type"
}
},
"WallModifierSet": {
"allOf": [
{
"$ref": "#/components/schemas/BaseModifierSet"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "WallModifierSet",
"default": "WallModifierSet",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Set containing radiance modifiers needed for a model's Walls.",
"title": "WallModifierSet",
"discriminator": {
"propertyName": "type"
}
},
"WallModifierSetAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/BaseModifierSetAbridged"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "WallModifierSetAbridged",
"default": "WallModifierSetAbridged",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Abridged set containing radiance modifiers needed for a model's Walls.",
"title": "WallModifierSetAbridged",
"discriminator": {
"propertyName": "type"
}
},
"WindowAC": {
"allOf": [
{
"$ref": "#/components/schemas/_HeatCoolBase"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"const": "WindowAC",
"default": "WindowAC",
"title": "Type",
"type": "string",
"readOnly": true
},
"equipment_type": {
"$ref": "#/components/schemas/WindowACEquipmentType",
"default": "WindowAC_ElectricBaseboard",
"description": "Text for the specific type of system equipment from the WindowACEquipmentType enumeration."
}
},
"additionalProperties": false
}
],
"description": "Window Air Conditioning cooling system (with optional heating).\n\nEach room/zone will receive its own Packaged Terminal Air Conditioner (PTAC)\nwith properties set to reflect a typical window air conditioning (AC) unit.\nNo ventilation air is supplied by the unit and the cooling coil within the\nunit is a single-speed direct expansion (DX) cooling coil. Heating loads\ncan be met with various options, including several types of baseboards,\na furnace, or gas unit heaters.",
"title": "WindowAC",
"discriminator": {
"propertyName": "type"
}
},
"WindowACEquipmentType": {
"enum": [
"WindowAC_ElectricBaseboard",
"WindowAC_BoilerBaseboard",
"WindowAC_ASHPBaseboard",
"WindowAC_DHWBaseboard",
"WindowAC_Furnace",
"WindowAC_GasHeaters",
"WindowAC"
],
"title": "WindowACEquipmentType",
"type": "string"
},
"WindowConstruction": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"materials"
],
"properties": {
"materials": {
"description": "List of glazing and gas material definitions. The order of the materials is from exterior to interior. If a SimpleGlazSys material is used, it must be the only material in the construction. For multi-layered constructions, adjacent glass layers must be separated by one and only one gas layer.",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EnergyWindowMaterialSimpleGlazSys"
},
{
"$ref": "#/components/schemas/EnergyWindowMaterialGlazing"
},
{
"$ref": "#/components/schemas/EnergyWindowMaterialGas"
},
{
"$ref": "#/components/schemas/EnergyWindowMaterialGasCustom"
},
{
"$ref": "#/components/schemas/EnergyWindowMaterialGasMixture"
}
]
},
"maxItems": 8,
"minItems": 1,
"title": "Materials",
"type": "array"
},
"type": {
"const": "WindowConstruction",
"default": "WindowConstruction",
"title": "Type",
"type": "string",
"readOnly": true
},
"frame": {
"anyOf": [
{
"$ref": "#/components/schemas/EnergyWindowFrame"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional window frame material for the frame that surrounds the window construction."
}
},
"additionalProperties": false
}
],
"description": "Construction for window objects (Aperture, Door).",
"title": "WindowConstruction",
"discriminator": {
"propertyName": "type"
}
},
"WindowConstructionAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"materials"
],
"properties": {
"materials": {
"description": "List of strings for glazing or gas material identifiers. The order of the materials is from exterior to interior. If a SimpleGlazSys material is used, it must be the only material in the construction. For multi-layered constructions, adjacent glass layers must be separated by one and only one gas layer.",
"items": {
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"maxItems": 8,
"minItems": 1,
"title": "Materials",
"type": "array"
},
"type": {
"const": "WindowConstructionAbridged",
"default": "WindowConstructionAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"frame": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional identifier for a frame material that surrounds the window construction.",
"title": "Frame"
}
},
"additionalProperties": false
}
],
"description": "Construction for window objects (Aperture, Door).",
"title": "WindowConstructionAbridged",
"discriminator": {
"propertyName": "type"
}
},
"WindowConstructionDynamic": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"constructions",
"schedule"
],
"properties": {
"constructions": {
"description": "A list of WindowConstruction objects that define the various states that the dynamic window can assume.",
"items": {
"$ref": "#/components/schemas/WindowConstruction"
},
"title": "Constructions",
"type": "array"
},
"schedule": {
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
}
],
"description": "A control schedule that dictates which constructions are active at given times throughout the simulation. The values of the schedule should be integers and range from 0 to one less then the number of constructions. Zero indicates that the first construction is active, one indicates that the second on is active, etc. The schedule type limits of this schedule should be \"Control Level.\" If building custom schedule type limits that describe a particular range of states, the type limits should be \"Discrete\" and the unit type should be \"Mode,\" \"Control,\" or some other fractional unit.",
"title": "Schedule"
},
"type": {
"const": "WindowConstructionDynamic",
"default": "WindowConstructionDynamic",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Construction for window objects with an included shade layer.",
"title": "WindowConstructionDynamic",
"discriminator": {
"propertyName": "type"
}
},
"WindowConstructionDynamicAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"constructions",
"schedule"
],
"properties": {
"constructions": {
"description": "A list of WindowConstructionAbridged objects that define the various states that the dynamic window can assume.",
"items": {
"$ref": "#/components/schemas/WindowConstructionAbridged"
},
"title": "Constructions",
"type": "array"
},
"schedule": {
"description": "An identifier for a control schedule that dictates which constructions are active at given times throughout the simulation. The values of the schedule should be integers and range from 0 to one less then the number of constructions. Zero indicates that the first construction is active, one indicates that the second on is active, etc. The schedule type limits of this schedule should be \"Control Level.\" If building custom schedule type limits that describe a particular range of states, the type limits should be \"Discrete\" and the unit type should be \"Mode,\" \"Control,\" or some other fractional unit.",
"maxLength": 100,
"minLength": 1,
"title": "Schedule",
"type": "string"
},
"type": {
"const": "WindowConstructionDynamicAbridged",
"default": "WindowConstructionDynamicAbridged",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Construction for window objects with an included shade layer.",
"title": "WindowConstructionDynamicAbridged",
"discriminator": {
"propertyName": "type"
}
},
"WindowConstructionShade": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"window_construction",
"shade_material"
],
"properties": {
"window_construction": {
"$ref": "#/components/schemas/WindowConstruction",
"description": "A WindowConstruction object that serves as the \"switched off\" version of the construction (aka. the \"bare construction\"). The shade_material and shade_location will be used to modify this starting construction."
},
"shade_material": {
"anyOf": [
{
"$ref": "#/components/schemas/EnergyWindowMaterialShade"
},
{
"$ref": "#/components/schemas/EnergyWindowMaterialBlind"
},
{
"$ref": "#/components/schemas/EnergyWindowMaterialGlazing"
}
],
"description": "Identifier of a An EnergyWindowMaterialShade or an EnergyWindowMaterialBlind that serves as the shading layer for this construction. This can also be an EnergyWindowMaterialGlazing, which will indicate that the WindowConstruction has a dynamically-controlled glass pane like an electrochromic window assembly.",
"title": "Shade Material"
},
"type": {
"const": "WindowConstructionShade",
"default": "WindowConstructionShade",
"title": "Type",
"type": "string",
"readOnly": true
},
"shade_location": {
"$ref": "#/components/schemas/ShadeLocation",
"default": "Interior",
"description": "Text to indicate where in the window assembly the shade_material is located. Note that the WindowConstruction must have at least one gas gap to use the \"Between\" option. Also note that, for a WindowConstruction with more than one gas gap, the \"Between\" option defaults to using the inner gap as this is the only option that EnergyPlus supports."
},
"control_type": {
"$ref": "#/components/schemas/ControlType",
"default": "AlwaysOn",
"description": "Text to indicate how the shading device is controlled, which determines when the shading is \u201con\u201d or \u201coff.\u201d"
},
"setpoint": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "A number that corresponds to the specified control_type. This can be a value in (W/m2), (C) or (W) depending upon the control type.Note that this value cannot be None for any control type except \"AlwaysOn.\"",
"title": "Setpoint"
},
"schedule": {
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional ScheduleRuleset or ScheduleFixedInterval to be applied on top of the control_type. If None, the control_type will govern all behavior of the construction.",
"title": "Schedule"
}
},
"additionalProperties": false
}
],
"description": "Construction for window objects (Aperture, Door).",
"title": "WindowConstructionShade",
"discriminator": {
"propertyName": "type"
}
},
"WindowConstructionShadeAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"window_construction",
"shade_material"
],
"properties": {
"window_construction": {
"$ref": "#/components/schemas/WindowConstructionAbridged",
"description": "A WindowConstructionAbridged object that serves as the \"switched off\" version of the construction (aka. the \"bare construction\"). The shade_material and shade_location will be used to modify this starting construction."
},
"shade_material": {
"description": "Identifier of a An EnergyWindowMaterialShade or an EnergyWindowMaterialBlind that serves as the shading layer for this construction. This can also be an EnergyWindowMaterialGlazing, which will indicate that the WindowConstruction has a dynamically-controlled glass pane like an electrochromic window assembly.",
"maxLength": 100,
"minLength": 1,
"title": "Shade Material",
"type": "string"
},
"type": {
"const": "WindowConstructionShadeAbridged",
"default": "WindowConstructionShadeAbridged",
"title": "Type",
"type": "string",
"readOnly": true
},
"shade_location": {
"$ref": "#/components/schemas/ShadeLocation",
"default": "Interior",
"description": "Text to indicate where in the window assembly the shade_material is located. Note that the WindowConstruction must have at least one gas gap to use the \"Between\" option. Also note that, for a WindowConstruction with more than one gas gap, the \"Between\" option defaults to using the inner gap as this is the only option that EnergyPlus supports."
},
"control_type": {
"$ref": "#/components/schemas/ControlType",
"default": "AlwaysOn",
"description": "Text to indicate how the shading device is controlled, which determines when the shading is \u201con\u201d or \u201coff.\u201d"
},
"setpoint": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "A number that corresponds to the specified control_type. This can be a value in (W/m2), (C) or (W) depending upon the control type.Note that this value cannot be None for any control type except \"AlwaysOn.\"",
"title": "Setpoint"
},
"schedule": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional schedule identifier to be applied on top of the control_type. If None, the control_type will govern all behavior of the construction.",
"title": "Schedule"
}
},
"additionalProperties": false
}
],
"description": "Construction for window objects with an included shade layer.",
"title": "WindowConstructionShadeAbridged",
"discriminator": {
"propertyName": "type"
}
},
"_AllAirBase": {
"allOf": [
{
"$ref": "#/components/schemas/_TemplateSystem"
},
{
"type": "object",
"required": [],
"properties": {
"economizer_type": {
"$ref": "#/components/schemas/AllAirEconomizerType",
"default": "NoEconomizer",
"description": "Text to indicate the type of air-side economizer used on the system (from the AllAirEconomizerType enumeration)."
},
"sensible_heat_recovery": {
"default": 0,
"description": "A number between 0 and 1 for the effectiveness of sensible heat recovery within the system.",
"maximum": 1,
"minimum": 0,
"title": "Sensible Heat Recovery",
"type": "number",
"format": "double"
},
"latent_heat_recovery": {
"default": 0,
"description": "A number between 0 and 1 for the effectiveness of latent heat recovery within the system.",
"maximum": 1,
"minimum": 0,
"title": "Latent Heat Recovery",
"type": "number",
"format": "double"
},
"demand_controlled_ventilation": {
"default": false,
"description": "Boolean to note whether demand controlled ventilation should be used on the system, which will vary the amount of ventilation air according to the occupancy schedule of the Rooms.",
"title": "Demand Controlled Ventilation",
"type": "boolean"
},
"type": {
"title": "Type",
"default": "_AllAirBase",
"type": "string",
"pattern": "^_AllAirBase$",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Base class for all-air systems.\n\nAll-air systems provide both ventilation and heating + cooling demand with\nthe same stream of warm/cool air. As such, they often grant tight control\nover zone humidity. However, because such systems often involve the\ncooling of air only to reheat it again, they are often more energy intensive\nthan systems that separate ventilation from the meeting of thermal loads.",
"title": "_AllAirBase",
"discriminator": {
"propertyName": "type"
}
},
"_DOASBase": {
"allOf": [
{
"$ref": "#/components/schemas/_TemplateSystem"
},
{
"type": "object",
"required": [],
"properties": {
"sensible_heat_recovery": {
"default": 0,
"description": "A number between 0 and 1 for the effectiveness of sensible heat recovery within the system.",
"maximum": 1,
"minimum": 0,
"title": "Sensible Heat Recovery",
"type": "number",
"format": "double"
},
"latent_heat_recovery": {
"default": 0,
"description": "A number between 0 and 1 for the effectiveness of latent heat recovery within the system.",
"maximum": 1,
"minimum": 0,
"title": "Latent Heat Recovery",
"type": "number",
"format": "double"
},
"demand_controlled_ventilation": {
"default": false,
"description": "Boolean to note whether demand controlled ventilation should be used on the system, which will vary the amount of ventilation air according to the occupancy schedule of the Rooms.",
"title": "Demand Controlled Ventilation",
"type": "boolean"
},
"doas_availability_schedule": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "An optional On/Off discrete schedule to set when the dedicated outdoor air system (DOAS) shuts off. This will not only prevent any outdoor air from flowing thorough the system but will also shut off the fans, which can result in more energy savings when spaces served by the DOAS are completely unoccupied. If None, the DOAS will be always on.",
"title": "Doas Availability Schedule"
},
"type": {
"title": "Type",
"default": "_DOASBase",
"type": "string",
"pattern": "^_DOASBase$",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Base class for Dedicated Outdoor Air System (DOAS) HVACs.\n\nDOAS systems separate minimum ventilation supply from the satisfaction of heating\n+ cooling demand. Ventilation air tends to be supplied at neutral temperatures\n(close to room air temperature) and heating / cooling loads are met with additional\npieces of zone equipment (eg. Fan Coil Units (FCUs)).\n\nBecause DOAS systems only have to cool down and re-heat the minimum ventilation air,\nthey tend to use less energy than all-air systems. They also tend to use less energy\nto distribute heating + cooling by pumping around hot/cold water or refrigerant\ninstead of blowing hot/cold air. However, they do not provide as good of control\nover humidity and so they may not be appropriate for rooms with high latent loads\nlike auditoriums, kitchens, laundromats, etc.",
"title": "_DOASBase",
"discriminator": {
"propertyName": "type"
}
},
"_EquipmentBase": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [
"watts_per_area"
],
"properties": {
"watts_per_area": {
"description": "Equipment level per floor area as [W/m2].",
"minimum": 0,
"title": "Watts Per Area",
"type": "number",
"format": "double"
},
"schedule": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier of the schedule for the use of equipment over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the watts_per_area to yield a complete equipment profile. If None, an Always On schedule will be used.",
"title": "Schedule"
},
"radiant_fraction": {
"default": 0,
"description": "Number for the amount of long-wave radiation heat given off by equipment. Default value is 0.",
"maximum": 1,
"minimum": 0,
"title": "Radiant Fraction",
"type": "number",
"format": "double"
},
"latent_fraction": {
"default": 0,
"description": "Number for the amount of latent heat given off by equipment. Default value is 0.",
"maximum": 1,
"minimum": 0,
"title": "Latent Fraction",
"type": "number",
"format": "double"
},
"lost_fraction": {
"default": 0,
"description": "Number for the amount of \u201clost\u201d heat being given off by equipment. The default value is 0.",
"maximum": 1,
"minimum": 0,
"title": "Lost Fraction",
"type": "number",
"format": "double"
},
"type": {
"title": "Type",
"default": "_EquipmentBase",
"type": "string",
"pattern": "^_EquipmentBase$",
"readOnly": true
}
},
"additionalProperties": false
}
],
"title": "_EquipmentBase",
"discriminator": {
"propertyName": "type"
}
},
"_FaceSubSet": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"interior_construction": {
"anyOf": [
{
"$ref": "#/components/schemas/OpaqueConstruction"
},
{
"type": "null"
}
],
"default": null,
"description": "An OpaqueConstruction for walls with a Surface or Adiabatic boundary condition."
},
"exterior_construction": {
"anyOf": [
{
"$ref": "#/components/schemas/OpaqueConstruction"
},
{
"type": "null"
}
],
"default": null,
"description": "An OpaqueConstruction for walls with an Outdoors boundary condition."
},
"ground_construction": {
"anyOf": [
{
"$ref": "#/components/schemas/OpaqueConstruction"
},
{
"type": "null"
}
],
"default": null,
"description": "An OpaqueConstruction for walls with a Ground boundary condition."
},
"type": {
"title": "Type",
"default": "_FaceSubSet",
"type": "string",
"pattern": "^_FaceSubSet$",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "A set of constructions for wall, floor, or roof assemblies.",
"title": "_FaceSubSet",
"discriminator": {
"propertyName": "type"
}
},
"_FaceSubSetAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"interior_construction": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier for an OpaqueConstruction for faces with a Surface or Adiabatic boundary condition.",
"title": "Interior Construction"
},
"exterior_construction": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier for an OpaqueConstruction for faces with an Outdoors boundary condition.",
"title": "Exterior Construction"
},
"ground_construction": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Identifier for an OpaqueConstruction for faces with a Ground boundary condition.",
"title": "Ground Construction"
},
"type": {
"title": "Type",
"default": "_FaceSubSetAbridged",
"type": "string",
"pattern": "^_FaceSubSetAbridged$",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "A set of constructions for wall, floor, or roof assemblies.",
"title": "_FaceSubSetAbridged",
"discriminator": {
"propertyName": "type"
}
},
"_HeatCoolBase": {
"allOf": [
{
"$ref": "#/components/schemas/_TemplateSystem"
},
{
"type": "object",
"required": [],
"properties": {
"type": {
"title": "Type",
"default": "_HeatCoolBase",
"type": "string",
"pattern": "^_HeatCoolBase$",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Base class for all heating/cooling systems without any ventilation.\n\nThese systems are only designed to satisfy heating + cooling demand and they\ncannot meet any minimum ventilation requirements.\n\nAs such, these systems tend to be used in residential or storage settings where\nmeeting minimum ventilation requirements may not be required or the density\nof occupancy is so low that infiltration is enough to meet fresh air demand.",
"title": "_HeatCoolBase",
"discriminator": {
"propertyName": "type"
}
},
"_PropertiesBaseAbridged": {
"allOf": [
{
"$ref": "#/components/schemas/_OpenAPIGenBaseModel"
},
{
"type": "object",
"properties": {
"modifier": {
"default": null,
"description": "A string for a Honeybee Radiance Modifier (default: None).",
"title": "Modifier",
"type": "string"
},
"modifier_blk": {
"default": null,
"description": "A string for a Honeybee Radiance Modifier to be used in direct solar simulations and in isolation studies (assessingthe contribution of individual objects) (default: None).",
"title": "Modifier Blk",
"type": "string"
},
"type": {
"title": "Type",
"default": "_PropertiesBaseAbridged",
"type": "string",
"pattern": "^_PropertiesBaseAbridged$",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Base class of Abridged Radiance Properties.",
"title": "_PropertiesBaseAbridged",
"discriminator": {
"propertyName": "type"
}
},
"_RadianceAsset": {
"allOf": [
{
"$ref": "#/components/schemas/IDdRadianceBaseModel"
},
{
"type": "object",
"required": [],
"properties": {
"room_identifier": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"pattern": "^[.A-Za-z0-9_-]+$",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional text string for the Room identifier to which this object belongs. This will be used to narrow down the number of aperture groups that have to be run with this sensor grid. If None, the grid will be run with all aperture groups in the model.",
"title": "Room Identifier"
},
"light_path": {
"anyOf": [
{
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Get or set a list of lists for the light path from the object to the sky. Each sub-list contains identifiers of aperture groups through which light passes. (eg. [[\"SouthWindow1\"], [\"static_apertures\", \"NorthWindow2\"]]).Setting this property will override any auto-calculation of the light path from the model and room_identifier upon export to the simulation.",
"title": "Light Path"
},
"type": {
"title": "Type",
"default": "_RadianceAsset",
"type": "string",
"pattern": "^_RadianceAsset$",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Hidden base class for all Radiance Assets.",
"title": "_RadianceAsset",
"discriminator": {
"propertyName": "type"
}
},
"_TemplateSystem": {
"allOf": [
{
"$ref": "#/components/schemas/IDdEnergyBaseModel"
},
{
"type": "object",
"required": [],
"properties": {
"vintage": {
"$ref": "#/components/schemas/Vintages",
"default": "ASHRAE_2019",
"description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards"
},
"type": {
"title": "Type",
"default": "_TemplateSystem",
"type": "string",
"pattern": "^_TemplateSystem$",
"readOnly": true
}
},
"additionalProperties": false
}
],
"description": "Base class for HVAC systems following a standards template.",
"title": "_TemplateSystem",
"discriminator": {
"propertyName": "type"
}
},
"_OpenAPIGenBaseModel": {
"properties": {
"type": {
"default": "InvalidType",
"description": "A base class to use when there is no baseclass available to fall on.",
"title": "Type",
"type": "string",
"readOnly": true
}
},
"title": "_OpenAPIGenBaseModel",
"type": "object",
"discriminator": {
"propertyName": "type"
}
}
}
}
}