(simulation_setting)= # Simulation settings ## What are simulation settings? `bim2sim` uses prescribed settings which define how a specific simulation should be handled. For basic setup we have a [BaseSimSettings](BaseSimSettings), which is extended for the different simulation types (e.g. [BuildingSimSettings](BuildingSimSettings)) and this domain simulation type specific settings can also be further specified for each [Plugin](Plugin) (e.g. [TEASERSimSettings](TEASERSimSettings) or [EnergyPlusSimSettings](EnergyPlusSimSettings)) via class inheritance. Each [Plugin](Plugin) has a set of predefined settings. But the different settings can easily be changed (see below) ## How do settings work? (sim_settings_concept)= Each instance of a simulation settings owns a [SettingsManager](SettingsManager) to manage all simulation specific [Settings](Setting). A setting can be used to concretize the way how [tasks](task) are executed. E.g. the level of detail ([LOD](LOD)) of the setting `layers_and_materials` with which the layers of building elements and their materials should be inspected can be defined either set LOD.low or LOD.full. Currently, each [Setting](Setting) has a specified number of choices from which one or multiple can be chosen. Additionally, to the settings itself, a simulation setting instance holds the `relevant_elements`. These define, which of the existing `bim2sim` [elements](elements) will be taken into account for the simulation model creation. ## How to set simulation settings? There are two different ways to set a workflow setting: * Define the settings inside the `config.toml` file that is part of every [FolderStructure](FolderStructure) of every [Project](project.md). * Define the settings after the project creation by overwriting the existing ones ```python project = Project.create(project_path, ifc_path, 'teaser', open_conf=True) project.sim_settings.layers_and_materials = LOD.low ``` If you want to overwrite the specified `relevant_elements` you can do this in the same way ```python project.sim_settings.relevant_elements = {} ``` The first way is useful if you want to work in an interactive way, the second is more fitting for automated tasks. ## Want to set up your own workflow? The pre-implemented workflows hold the needed settings for the simulation with the pre-implemented Plugins. For further customization you can add your own Workflow (from scratch or by inheriting from the existing ones) and add your own settings that you might miss from the existing ones. ## List of current simulation settings: The following tables provide an overview of simulation settings for the different simulation types. ### BaseSimSettings | Setting Name | Type | Default | Description | Choices | |:----------------------------|:---------|:--------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | dymola_simulation | Boolean | False | Run a Simulation with Dymola after model export? | | | create_external_elements | Boolean | False | Create external elements? | | | max_wall_thickness | Number | 0.3 | Choose maximum wall thickness as a tolerance for mapping
opening boundaries to their base surface (Wall). Choose 0.3m
as a default value. | | | group_unidentified | Choice | 'fuzzy' | To reduce the number of decisions by user to identify
elements which can not be identified automatically by the
system, you can either use simple grouping by same name of
IFC element or fuzzy search to group based on similarities
in name. | 'fuzzy': Use fuzzy search to find ifc name similarities
'name': Only group elements with exact same ifc name
'name_and_description': Only group elements with the same ifc name and ifc description | | fuzzy_threshold | Number | 0.7 | If you want to use fuzzy search in the group_unidentified
setting, you can set the threshold here. A low threshold
means a small similarity is required for grouping. A too low
value might result in grouping elements which do not
represent the same IFC type. | | | reset_guids | Boolean | False | Reset GlobalIDs from imported IFC if duplicate GlobalIDs
occur in the IFC. As EnergyPlus evaluates allGlobalIDs upper
case only, this might also be applicable if duplicate non-
case-sensitive GlobalIDs occur. | | | weather_file_path | Path | | Path to the weather file that should be used for the
simulation. If no path is provided, we will try to get
the location from the IFC and download a fitting weather
file. For Modelica provide .mos files, for EnergyPlus .epw
files. If the format does not fit, we will try to convert. | | | building_rotation_overwrite | Number | 0 | Overwrite the (clockwise) building rotation angle in
degrees. | | | add_space_boundaries | Boolean | False | Add space boundaries. Only required for building performance
simulation and co-simulations. | | | correct_space_boundaries | Boolean | False | Apply geometric correction to space boundaries. | | | close_space_boundary_gaps | Boolean | False | Close gaps in the set of space boundaries by adding
additional 2b space boundaries. | | | stories_to_load_guids | GuidList | [] | List of IFC GUIDs for the specific stories that should be
loaded. If empty, all stories will be considered for
loading. This setting is useful for large buildings to
reduce computational time. Note that loading single storeys
may lead to missing ceilings if the related slab is assigned
to the storey above, which may require corrections to
boundary conditions. It is recommended to include GUIDs of
neighboring storeys to reduce boundary condition errors. | | ### PlantSimSettings | Setting Name | Type | Default | Description | |--------------|-------------------------|---------|-----------------------------------------------------------------------| | aggregations | Choice (MultipleChoice) | [list] | Choose which aggregations should be applied on the hydraulic network. | ### BuildingSimSettings | Setting Name | Type | Default | Description | Choices | |:---------------------------------------|:--------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | layers_and_materials | Choice | LOD.low | Select how existing Material information in IFC should be
treated. | 'LOD.low': Override materials with predefined setups | | year_of_construction_overwrite | Number | | Force an overwrite of the year of construction as a base for
the selected construction set. | | | construction_class_walls | Choice | 'iwu_heavy' | Select the most fitting construction class type forthe walls
of the selected building. For all settings but kfw_* the
year of construction is required. | 'iwu_heavy', 'iwu_light', 'kfw_40', 'kfw_55', 'kfw_70',
'kfw_85', 'kfw_100', 'tabula_de_standard_1_SFH',
'tabula_de_standard_2_SFH', 'tabula_de_retrofit_1_SFH',
'tabula_de_retrofit_2_SFH', 'tabula_de_adv_retrofit_1_SFH',
'tabula_de_adv_retrofit_2_SFH', 'tabula_de_standard_1_TH',
'tabula_de_standard_2_TH', 'tabula_de_retrofit_1_TH',
'tabula_de_retrofit_2_TH', 'tabula_de_standard_1_MFH',
'tabula_de_retrofit_1_MFH', 'tabula_de_adv_retrofit_1_MFH',
'tabula_de_standard_1_AB', 'tabula_de_adv_retrofit_1_AB',
'tabula_de_standard', 'tabula_dk_standard_1_SFH',
'tabula_dk_standard_2_SFH', 'tabula_dk_retrofit_1_SFH',
'tabula_dk_retrofit_2_SFH', 'tabula_dk_adv_retrofit_1_SFH',
'tabula_dk_adv_retrofit_2_SFH', 'tabula_dk_standard_1_TH',
'tabula_dk_standard_2_TH', 'tabula_dk_retrofit_1_TH',
'tabula_dk_retrofit_2_TH', 'tabula_dk_adv_retrofit_1_TH',
'tabula_dk_adv_retrofit_2_TH', 'tabula_dk_standard_1_AB',
'tabula_dk_standard_2_AB', 'tabula_dk_retrofit_1_AB',
'tabula_dk_retrofit_2_AB', 'tabula_dk_adv_retrofit_1_AB',
'tabula_dk_adv_retrofit_2_AB', 'tabula_dk_standard' | | construction_class_windows | Choice | 'Alu- oder Stahlfenster, Waermeschutzverglasung, zweifach' | Select the most fitting construction class type for the
windows of the selected building. | 'Holzfenster, zweifach', 'Kunststofffenster,
Isolierverglasung', 'Alu- oder Stahlfenster,
Isolierverglasung', 'Alu- oder Stahlfenster,
Waermeschutzverglasung, zweifach', 'Waermeschutzverglasung,
dreifach', 'tabula_de_standard_1_SFH',
'tabula_de_standard_2_SFH', 'tabula_de_retrofit_1_SFH',
'tabula_de_retrofit_2_SFH', 'tabula_de_adv_retrofit_1_SFH',
'tabula_de_adv_retrofit_2_SFH', 'tabula_de_standard_1_TH',
'tabula_de_standard_2_TH', 'tabula_de_retrofit_1_TH',
'tabula_de_retrofit_2_TH', 'tabula_de_standard_1_MFH',
'tabula_de_retrofit_1_MFH', 'tabula_de_adv_retrofit_1_MFH',
'tabula_de_standard_1_AB', 'tabula_de_adv_retrofit_1_AB',
'tabula_de_standard', 'tabula_dk_standard_1_SFH',
'tabula_dk_standard_2_SFH', 'tabula_dk_retrofit_1_SFH',
'tabula_dk_retrofit_2_SFH', 'tabula_dk_adv_retrofit_1_SFH',
'tabula_dk_adv_retrofit_2_SFH', 'tabula_dk_standard_1_TH',
'tabula_dk_standard_2_TH', 'tabula_dk_retrofit_1_TH',
'tabula_dk_retrofit_2_TH', 'tabula_dk_adv_retrofit_1_TH',
'tabula_dk_adv_retrofit_2_TH', 'tabula_dk_standard_1_AB',
'tabula_dk_standard_2_AB', 'tabula_dk_retrofit_1_AB',
'tabula_dk_retrofit_2_AB', 'tabula_dk_adv_retrofit_1_AB',
'tabula_dk_adv_retrofit_2_AB', 'tabula_dk_standard' | | construction_class_doors | Choice | 'iwu_typical' | Select the most fitting construction class type for the
windows of the selected building. | 'iwu_typical', 'kfw_40', 'kfw_55', 'kfw_70', 'kfw_85',
'kfw_100', 'tabula_de_standard_1_SFH',
'tabula_de_retrofit_1_SFH', 'tabula_de_adv_retrofit_1_SFH',
'tabula_de_standard_1_TH', 'tabula_de_retrofit_1_TH',
'tabula_de_adv_retrofit_1_TH', 'tabula_de_standard_1_MFH',
'tabula_de_retrofit_1_MFH', 'tabula_de_adv_retrofit_1_MFH',
'tabula_de_standard_1_AB', 'tabula_de_retrofit_1_AB',
'tabula_de_adv_retrofit_1_AB', 'tabula_dk_standard_1_SFH' | | heating_tz_overwrite | Boolean | | If True, all thermal zones will be provided with heating,if
False no heating for thermal zones is provided, regardless
of information in the IFC or in the use condition file. | | | cooling_tz_overwrite | Boolean | | If True, all thermal zones will be provided with cooling,if
False no cooling for thermal zones is provided, regardless
of information in the IFC or in the use condition file. | | | ahu_tz_overwrite | Boolean | | If True, all thermal zones will be provided with AHU,if
False no AHU for thermal zones is provided, regardless of
information in the IFC or in the use condition file. | | | prj_use_conditions | Path | | Path to a custom UseConditions.json for the specific
project, that holds custom usage conditions for this
project. If this is used, this use_conditions file have to
hold all information. The basic UseConditions.json file is
ignored in this case. | | | prj_custom_usages | Path | | Path to a custom customUsages.json for the specific project,
that holds mappings between space names from IFC and usage
conditions from UseConditions.json. | | | setpoints_from_template | Boolean | False | Use template heating and cooling profiles instead of
setpoints from IFC. Defaults to False, i.e., use original
data source. Set to True, if template-based values should be
used instead. | | | use_maintained_illuminance | Boolean | True | Use maintained illuminance required per zone based on DIN V
EN 18599 information to calculate internal loadsthrough
lighting. | | | sim_results | Choice | ['heat_demand_total', 'cool_demand_total',
'heat_demand_rooms', 'cool_demand_rooms',
'heat_energy_total', 'cool_energy_total',
'heat_energy_rooms', 'cool_energy_rooms',
'air_temp_out', 'operative_temp_rooms',
'air_temp_rooms', 'internal_gains_machines_rooms',
'internal_gains_persons_rooms', 'internal_gains_lights_rooms',
'n_persons_rooms', 'infiltration_rooms',
'mech_ventilation_rooms', 'heat_set_rooms',
'cool_set_rooms'] | | 'heat_demand_total', 'cool_demand_total',
'heat_demand_rooms', 'cool_demand_rooms',
'heat_energy_total', 'cool_energy_total',
'heat_energy_rooms', 'cool_energy_rooms', 'air_temp_out',
'operative_temp_rooms', 'air_temp_rooms',
'internal_gains_machines_rooms',
'internal_gains_persons_rooms',
'internal_gains_lights_rooms', 'n_persons_rooms',
'infiltration_rooms', 'mech_ventilation_rooms',
'heat_set_rooms', 'cool_set_rooms' | | add_space_boundaries | Boolean | True | Add space boundaries. Only required for building performance
simulation and co-simulations. | | | correct_space_boundaries | Boolean | False | Apply geometric correction to space boundaries. | | | split_bounds | Boolean | False | Whether to convert up non-convex space boundaries or not. | | | add_shadings | Boolean | False | Whether to add shading surfaces if available or not. | | | split_shadings | Boolean | False | Whether to convert up non-convex shading boundaries or not. | | | close_space_boundary_gaps | Boolean | False | Close gaps in the set of space boundaries by adding
additional 2b space boundaries. | | | create_plots | Boolean | False | Create plots for simulation results after the simulation
finished. | | | set_run_period | Boolean | False | Choose whether run period for simulation execution should be
set manually instead of running annual simulation. | | | run_period_start_month | Number | 1 | Choose start month of run period. Requires
set_run_period==True for activation. | | | run_period_start_day | Number | 1 | Choose start day of run period. Requires
set_run_period==True for activation. | | | run_period_end_month | Number | 12 | Choose end month of run period. Requires
set_run_period==True for activation. | | | run_period_end_day | Number | 31 | Choose end day of run period. Requires set_run_period==True
for activation. | | | plot_singe_zone_guid | Choice | '' | Choose the GlobalId of the IfcSpace for which results should
be plotted. | '': Skip | | ahu_heating_overwrite | Boolean | | Choose if the central AHU should provide heating. | | | ahu_cooling_overwrite | Boolean | | Choose if the central AHU should provide cooling. | | | ahu_dehumidification_overwrite | Boolean | | Choose if the central AHU should provide dehumidification. | | | ahu_humidification_overwrite | Boolean | | Choose if the central AHU should provide
humidification.otherwise this has no effect. | | | ahu_heat_recovery_overwrite | Boolean | | Choose if the central AHU should zuse heat recovery. | | | ahu_heat_recovery_efficiency_overwrite | Number | | Choose the heat recovery efficiency of the central AHU. | | | use_constant_infiltration_overwrite | Boolean | | If only constant base infiltration should be used and no
dynamic ventilation through e.g. windows. | | | base_infiltration_rate_overwrite | Number | | Overwrite base value for the natural infiltration in 1/h
without window openings | | ### TEASERSimSettings | Setting Name | Type | Default | Description | |-----------------|--------|----------------------|----------------------------------------------------------------------| | zoning_setup | Choice | LOD.low | Select the criteria based on which thermal zones will be aggregated. | | zoning_criteria | Choice | ZoningCriteria.usage | Choose the zoning criteria for thermal zone aggregation. | ### EnergyPlusSimSettings (EnergyPlus_sim_settings)= | Setting Name | Type | Default | Description | Choices | |:------------------------------|:--------|:----------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | cfd_export | Boolean | False | Whether to use CFD export for this simulation or not. | | | split_bounds | Boolean | False | Whether to convert up non-convex space boundaries or not. | | | add_shadings | Boolean | True | Whether to add shading surfaces if available or not. | | | split_shadings | Boolean | False | Whether to convert up non-convex shading boundaries or not. | | | run_full_simulation | Boolean | False | Choose simulation period. | | | ep_version | Choice | '9-4-0' | Choose EnergyPlus Version | '9-2-0': EnergyPlus Version 9-2-0
'9-4-0': EnergyPlus Version 9-4-0
'22-2-0': EnergyPlus Version 22-2-0 | | ep_install_path | Path | \usr\local\EnergyPlus-9-4-0 | Choose EnergyPlus Installation Path | | | system_sizing | Boolean | True | Whether to do system sizing calculations in EnergyPlus or
not. | | | run_for_sizing_periods | Boolean | False | Whether to run the EnergyPlus simulation for sizing periods
or not. | | | run_for_weather_period | Boolean | True | Whether to run the EnergyPlus simulation for weather file
period or not. | | | system_weather_sizing | Choice | 'Typical' | Choose whether to perform the system sizing for DesignDays,
extreme weather periods, typical weather periods.
Default=Typical (i.e., apply system sizing for typical
summer/winter days). | 'Typical': SummerTypical and WinterTypical for system sizing.
'Extreme': SummerExtreme and WinterExtreme for system sizing.
'DesignDay': DesignDay for system sizing. Choose this option if neither SummerExtreme nor SummerTypical days are available in weather file. | | weather_file_for_sizing | Path | | Path to the weather file that should be used for system
sizing in EnergyPlus | | | enforce_system_sizing | Boolean | False | Choose True if you want to enforce HVAC Sizing to sizing
period settings (limit heating and cooling capacity) instead
of autosizing. | | | solar_distribution | Choice | 'FullExterior' | Choose solar distribution. | 'FullExterior': Full exterior solar distribution
'FullInteriorAndExterior': Full interior and exterior solar distribution | | add_window_shading | Choice | | Choose window shading. | 'None': Do not add window shading
'Interior': Add an interior shade in EnergyPlus
'Exterior': Add an exterior shade in EnergyPlus | | output_format | Choice | 'CommaAndHTML' | Choose output format for result files. | 'Comma': Output format Comma (.csv)
'Tab': Output format Tab (.tab)
'Fixed': Output format Fixed (.txt)
'HTML': Output format HTML (.htm)
'XML': Output format XML (.xml)
'CommaAndHTML': Output format CommaAndHTML
'TabAndHTML': Output format TabAndHTML
'XMLAndHTML': Output format TabAndHTML
'All': All output formats. | | unit_conversion | Choice | 'JtoKWH' | Choose unit conversion for result files. | 'None': No unit conversions
'JtoKWH': Convert Joule into kWh (1/3600000)
'JtoMJ': Joule converted into Megajoule (1/1000000)
'JtoGJ': Joule converted into Gigajoule
'InchPound': Convert all tabular values to common Inch-Pound equivalent. | | output_keys | Choice | ['output_outdoor_conditions', 'output_zone_temperature',
'output_zone', 'output_infiltration', 'output_meters'] | Choose groups of output variables (multiple choice). | 'output_outdoor_conditions': Add outputs for outdoor conditions.
'output_internal_gains': Add output for internal gains.
'output_zone_temperature': Add output for zone mean and operative temperature.
'output_zone': Add heating and cooling rates and energy on zone level.
'output_infiltration': Add output for zone infiltration.
'output_meters': Add heating and cooling meters.
'output_dxf': Output a dxf of the building geometry. | | correct_space_boundaries | Boolean | True | Apply geometric correction to space boundaries. | | | close_space_boundary_gaps | Boolean | True | Close gaps in the set of space boundaries by adding
additional 2b space boundaries. | | | add_natural_ventilation | Boolean | True | Add natural ventilation to the building. Natural ventilation
is not available when cooling is activated. | | | hvac_off_at_night | Boolean | False | Disable all HVAC systems at night from 10pm to 6am. | | | control_operative_temperature | Boolean | False | Use operative temperature instead of air temperature for
zonal temperature control. | | | ventilation_demand_control | Choice | | Choose if mechanical ventilation should be demand
controlled. Default is None. | 'None': No demand control for mechanical ventilation.
'OccupancySchedule': Demand control based on occupancy schedule. | | outdoor_air_economizer | Choice | 'NoEconomizer' | Choose which type of outdoor air economizer should be
applied to reduce cooling loads by an increased outdoor air
flow if cooling loads can be reduced. Default is
"NoEconomizer". | 'NoEconomizer': No outdoor air economizer is applied.
'DifferentialDryBulb': The outdoor air economizer is applied based on the differential dry bulb temperature.
'DifferentialEnthalpy': The outdoor air economizer is applied based on the differential enthalpy. | | heat_recovery_type | Choice | 'Enthalpy' | Choose which type of heat recovery should be applied for
mechanical ventilation. | 'Enthalpy': Use Enthalpy Heat Recovery.
'Sensible': Use Sensible Heat Recovery.
'None': No Heat Recovery | | heat_recovery_sensible | Number | 0.8 | Choose the sensible heat recovery effectiveness. Default:
0.8. | | | heat_recovery_latent | Number | 0.7 | Choose the latent heat recovery effectiveness. Only
applicable if heat_recovery_type="Enthalpy". Default: 0.7. | | | outdoor_air_per_person | Number | 7 | Outdoor air per person in l/s. Defaults to 7 l/s according
to DIN EN 16798-1, Category II. | | | outdoor_air_per_area | Number | 0.7 | Outdoor air per floor area in l/s. Defaults to 0.7 l/(s m2)
according to DIN EN 16798-1, Category II for low emission
buildings. | | | residential | Boolean | False | Choose True to use residential settings for natural
ventilation (DIN4108-2), False for non-residential houses. | | | natural_ventilation_approach | Choice | 'Simple' | Choose calculation approach for natural ventilation. | 'Simple': use simplified ventilation based on TEASER templates.
'DIN4108': use DIN4108-2 for natural ventilation. | ### OpenFOAMSimSettings (OpenFOAM_sim_settings)= | Setting Name | Type | Default | Description | Choices | |:-------------------------------|:--------|:-------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | add_heating | Boolean | True | Whether to add heating devices or not. | | | add_floorheating | Boolean | False | Whether to add floorheating instead of usual radiators. | | | add_airterminals | Boolean | True | Whether to add air terminals or not. | | | ignore_heatloss | Boolean | False | Ignores heat loss through walls if set to True. | | | inlet_type | Choice | 'Plate' | Choose air terminal inlet type. | 'Original': Simplified IFC shape for inlet
'Plate': Simplified plate for inlet
'StlDiffusor': Inlet diffusor from stl file
'SimpleStlDiffusor': Simplified inlet diffusor from stl file
'IfcDiffusor': Inlet diffusor modified from ifc file (if available), otherwise stl diffusor from file.
'None': No inlet plate, only gap in ceiling. | | outlet_type | Choice | 'Plate' | Choose air terminal outlet type. | 'Original': Simplified IFC shape for outlet
'Plate': Simplified plate for outlet
'StlDiffusor': Outlet diffusor from stl file
'SimpleStlDiffusor': Simplified outlet diffusor from stl file
'IfcDiffusor': Outlet diffusor modified from ifc file (if available), otherwise stl diffusor from file.
'None': No outlet plate, only gap in ceiling. | | outflow_direction | Choice | 'down' | Choose the outflow direction for original shapes from IFC
that should be automatically processed. Defaults to downward
facing flows. | 'down': Outflow facing downward. Only applicable for original shapes.
'side': Outflow facing sideways. Only applicable for original shapes.
'angle45down': Outflow facing downward with a 45 degrees angle. Only applicable for original shapes. | | select_space_guid | Choice | '' | Select space for OpenFOAM simulation by setting the space
guid. | '': No guid selected, first space will be selected. | | simulation_date | Choice | '12/21' | Select date of simulation according to simulated timeframe
in the PluginEnergyPlus. Insert as string in format MM/DD. | '12/21': Winter design day
'07/21': Summer design day | | simulation_time | Number | 11 | Select time of simulation according to simulated timeframe
in the PluginEnergyPlus. Insert as number (time) for the
full hour ranging 1 to 24. | | | simulation_type | Choice | 'steady' | Select simulation type (steady-state, combined or
transient). | 'steady': steady-state simulation
'combined': preconditioned transient simulation
'transient': transient simulation | | mesh_size | Number | 0.1 | Set the mesh size of the blockMesh in [m]. Insert a number
between 0.001 and 0.2. | | | mesh_max_global_cells | Number | 3000000 | Set the maximum number of global cells for meshing in
snappyHexMesh. | | | adjust_refinements | Boolean | False | Whether surface and region refinements of airterminals and
interior elements should be automatically recomputed or not. | | | total_iterations | Number | 20000 | Total number of iterations for the simulation. | | | steady_iterations | Number | 2500 | Select number of steady iterations for preconditioning a
transient simulation. | | | n_procs | Number | 12 | Set the number of processors for decomposition and
simulation. | | | run_meshing | Boolean | False | Whether to run OpenFOAM meshing or not. Only available for
linux systems. | | | run_cfd_simulation | Boolean | False | Whether to run the OpenFOAM CFD simulation or not. Only
available for linux systems. | | | heater_radiation | Number | 0.3 | Select the radiative portion of the heating heat transfer.
Choose between 0 and 1. | | | add_comfort | Boolean | True | Whether to add thermal comfort settings to OpenFOAM | | | add_furniture | Boolean | False | Whether to add furniture to OpenFOAM | | | level_heat_balance | Boolean | True | Whether to level heat balance: reduce heating towards
leveled heat balance considering internal gains. | | | furniture_setting | Choice | 'Office' | Select the type of furniture to add. | 'Office': Office setup, chair and desk
'Concert': Concert setup, chairs in rows
'Meeting': Meeting setup, large table with chairs
'TwoSideTable': Table with chairs on long side
'GroupTable': Group table with chairs
'Classroom': Classroom setup, individual tables with chairs | | furniture_amount | Number | 1 | | | | furniture_orientation | Choice | 'short_side' | | 'long_side': Long side of a rectangular space
'short_side': short side of a rectangular space
'window': window side of a rectangular space
'door': door side of a rectangular space
'north': North side
'east': East side
'south': South side
'west': West side | | add_people | Boolean | False | Choose if people should be added. | | | use_energyplus_people_amount | Boolean | False | Choose if number of people should be assigned as defined in
the EnergyPlus simulation. If true, people_amount is not
considered but overwritten with the rounded up number of
people from the EnergyPlus simulation. | | | people_setting | Choice | 'Seated' | Select type of people positioning to add. | 'Seated': Seated, furniture needs to be provided in sufficient amount.
'Standing': Standing, no furniture required. | | people_amount | Number | 1 | | | | radiation_model | Choice | 'P1' | Choose the radiation model | 'none': No radiation
'P1': Use P1 Radiation Model
'fvDOM': Use fvDOM Radiation Model
'preconditioned_fvDOM': Use P1 to precondition fvDOM Radiation | | radiation_precondition_time | Number | 1000 | Choose number of preconditioning iterations using P1
radiation for fvDOM radiation | | | add_solar_radiation | Boolean | True | Add solar radiation. Requires fvDOM as radiation model. | | | add_air_volume_evaluation | Boolean | False | Add an air volume evaluation. Removes voids of all people,
furniture elements, and heaters, to enhance the evaluation
of the air volume itself. This is computationally expensive. | | | scale_person_for_eval | Number | 0.05 | Scale shape of person for evaluation in paraview. | | | mesh_feature_snapping | Boolean | False | Choose if explicit surface feature snapping should be
applied in snappyHexMesh. | | | cluster_jobname | Choice | 'newJob' | Jobname that is used when running the simulation via a batch
script on the RWTH Compute Cluster. | 'fullRun': Specify content
'Job1234': Enumerate | | cluster_compute_account | Choice | '' | Specify the compute account that is used for running the
simulation on the RWTH Compute Cluster. Specify as
"thes1234". | '': Skip defining compute cluster account.
'thes1234': Define thesis account
'rwth5678': Define user account | | cluster_max_runtime_simulation | Choice | '23:59:00' | Max runtime for a full simulation in the format of
"D:HH:MM:SS". | '11:59:00': 12 hours
'06:00:00': 6 hours | | cluster_max_runtime_meshing | Choice | '00:59:00' | Max runtime for meshing in the format of D:HH:MM:SS . | '00:30:00': 30 minutes
'00:15:00': 15 minutes | | cluster_cpu_per_node | Number | 96 | Number of physical cores per node. | | ### CFDSimSettings No specific settings provided. ### LCAExportSettings No specific settings provided. ### ComfortSimSettings (ComfortSimSettings)= | Setting Name | Type | Default | Description | Choices | |:----------------------------|:--------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------| | prj_use_conditions | Path | [Path] | Path to a custom UseConditions.json for the specific comfort
application. These use conditions have comfort-based use
conditions as a default. | | | use_dynamic_clothing | Boolean | False | Use dynamic clothing according to ASHRAE 55 standard. | | | rename_plot_keys | Boolean | False | Rename room names for plot results | | | rename_plot_keys_path | Path | [Path] | Path for renaming the zone keys for plot results. Path to a
json file with pairs of current keys and new keys. | | | comfort_occupancy_weighting | Boolean | False | Weight the comfort rating by occupancy schedules. | | | plot_zone_usages | Choice | [] | Choose string patterns of zone usages for evaluation of
comfort results (multiple choice). Use empty list to disable
choice and plot all usages. | '': Choose empty string to plot all zones. |