bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam package

Template plugin for bim2sim

Holds a plugin with only base tasks mostly for demonstration.

class bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.PluginOpenFOAM

Bases: Plugin

default_tasks: List[Type[ITask]] = [<class 'bim2sim.tasks.common.load_ifc.LoadIFC'>, <class 'bim2sim.tasks.common.create_elements.CreateElementsOnIfcTypes'>, <class 'bim2sim.tasks.bps.sb_creation.CreateSpaceBoundaries'>, <class 'bim2sim.tasks.bps.sb_2b_generation.AddSpaceBoundaries2B'>, <class 'bim2sim.tasks.bps.sb_correction.CorrectSpaceBoundaries'>, <class 'bim2sim.tasks.common.create_relations.CreateRelations'>, <class 'bim2sim.tasks.bps.disaggr_creation.DisaggregationCreationAndTypeCheck'>, <class 'bim2sim.tasks.bps.enrich_material.EnrichMaterial'>, <class 'bim2sim.tasks.bps.enrich_use_cond.EnrichUseConditions'>, <class 'bim2sim.tasks.common.weather.Weather'>, <class 'bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.task.ep_create_idf.CreateIdf'>, <class 'bim2sim.plugins.PluginComfort.bim2sim_comfort.task.ep_comfort_settings.ComfortSettings'>, <class 'bim2sim.tasks.common.serialize_elements.SerializeElements'>, <class 'bim2sim.plugins.PluginEnergyPlus.bim2sim_energyplus.task.ep_run_simulation.RunEnergyPlusSimulation'>, <class 'bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.task.init_openfoam_setup.InitializeOpenFOAMSetup'>, <class 'bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.task.create_openfoam_geometry.CreateOpenFOAMGeometry'>, <class 'bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.task.add_comfort.AddOpenFOAMComfort'>, <class 'bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.task.create_openfoam_meshing.CreateOpenFOAMMeshing'>, <class 'bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.task.set_boundary_conditions.SetOpenFOAMBoundaryConditions'>, <class 'bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.task.run_meshing.RunOpenFOAMMeshing'>, <class 'bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.task.run_openfoam_simulation.RunOpenFOAMSimulation'>]
name: str = 'openfoam'
sim_settings

alias of OpenFOAMSimSettings

Subpackages

Submodules

bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.sim_settings module

class bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.sim_settings.OpenFOAMSimSettings

Bases: ComfortSimSettings

add_air_volume_evaluation
add_airterminals
add_comfort
add_floorheating
add_furniture
add_heating
add_people
add_solar_radiation
adjust_refinements
cluster_compute_account
cluster_cpu_per_node
cluster_jobname
cluster_max_runtime_meshing
cluster_max_runtime_simulation
furniture_amount
furniture_orientation
furniture_setting
heater_radiation
ignore_heatloss
inlet_type
level_heat_balance
mesh_feature_snapping
mesh_max_global_cells
mesh_size
n_procs
outflow_direction
outlet_type
people_amount
people_setting
radiation_model
radiation_precondition_time
run_cfd_simulation
run_meshing
scale_person_for_eval
select_space_guid
simulation_date
simulation_time
simulation_type
steady_iterations
total_iterations
use_energyplus_people_amount