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
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.examples package
- Submodules
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.examples.e10_openfoam_furniture module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.examples.e10_openfoam_furniture_DH module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.examples.e10_openfoam_no_heating module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.examples.e11_openfoam_furniture_space_heater module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.examples.e11_openfoam_run_full_sim_linux module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.examples.e12_openfoam_auto_refinement module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.examples.e12_run_openfoam_preconditioned_transient module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.examples.e13_run_openfoam_fvDOM module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.examples.e16_openfoam_import_IFC-HVAC module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.examples.e17_openfoam_import_IFC-HVAC_multi_files module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.examples.e18_openfoam_import_IFC-HVAC_multi_overflow module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.examples.e1_simple_project_cfd_openfoam module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.examples.e2_complex_project_bps_comfort_journal module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.examples.e2_openfoam_floorheating_steady module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.examples.e3_openfoam_radiator_steady module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.examples.e4_openfoam_radiator_steady_r0 module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.examples.e5_openfoam_radiator_steady_r1 module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.examples.e6_openfoam_radiator_steady_simple_air module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.examples.e7_openfoam_radiator_steady_diffusor module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.examples.e8_openfoam_radiator_steady_simple_air_none module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.examples.e9_openfoam_radiator_steady_simple_stldiffusor module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.openfoam_elements package
- Submodules
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.openfoam_elements.airterminal module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.openfoam_elements.furniture module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.openfoam_elements.heater module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.openfoam_elements.openfoam_base_boundary_conditions module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.openfoam_elements.openfoam_base_element module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.openfoam_elements.openfoam_case module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.openfoam_elements.people module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.openfoam_elements.stlbound module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.task package
- Submodules
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.task.add_comfort module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.task.create_openfoam_geometry module
CreateOpenFOAMGeometry
CreateOpenFOAMGeometry.adjust_refinements()
CreateOpenFOAMGeometry.create_airterminal_shapes()
CreateOpenFOAMGeometry.create_furniture_shapes()
CreateOpenFOAMGeometry.create_people_shapes()
CreateOpenFOAMGeometry.export_airterminal_triSurface()
CreateOpenFOAMGeometry.export_furniture_triSurface()
CreateOpenFOAMGeometry.export_heater_triSurface()
CreateOpenFOAMGeometry.export_people_triSurface()
CreateOpenFOAMGeometry.export_stlbound_triSurface()
CreateOpenFOAMGeometry.generate_grid_positions()
CreateOpenFOAMGeometry.generate_grid_positions_w_constraints()
CreateOpenFOAMGeometry.get_base_surface()
CreateOpenFOAMGeometry.get_boundaries_of_heater()
CreateOpenFOAMGeometry.init_airterminals()
CreateOpenFOAMGeometry.init_furniture()
CreateOpenFOAMGeometry.init_heater()
CreateOpenFOAMGeometry.init_people()
CreateOpenFOAMGeometry.init_zone()
CreateOpenFOAMGeometry.reads
CreateOpenFOAMGeometry.run()
CreateOpenFOAMGeometry.single_use
CreateOpenFOAMGeometry.touches
create_stl_from_shape_single_solid_name()
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.task.create_openfoam_meshing module
CreateOpenFOAMMeshing
CreateOpenFOAMMeshing.add_topoSetDict_for_heating()
CreateOpenFOAMMeshing.create_blockMesh()
CreateOpenFOAMMeshing.create_snappyHexMesh()
CreateOpenFOAMMeshing.create_surfaceFeatureExtract()
CreateOpenFOAMMeshing.modify_topoSet_for_evaluation()
CreateOpenFOAMMeshing.reads
CreateOpenFOAMMeshing.run()
CreateOpenFOAMMeshing.set_refinementSurfaces()
CreateOpenFOAMMeshing.touches
CreateOpenFOAMMeshing.update_blockMeshDict_air()
CreateOpenFOAMMeshing.update_snappyHexMesh_air()
CreateOpenFOAMMeshing.update_snappyHexMesh_furniture()
CreateOpenFOAMMeshing.update_snappyHexMesh_heating()
CreateOpenFOAMMeshing.update_snappyHexMesh_mesh_controls()
CreateOpenFOAMMeshing.update_snappyHexMesh_people()
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.task.init_openfoam_setup module
InitializeOpenFOAMSetup
InitializeOpenFOAMSetup.create_controlDict()
InitializeOpenFOAMSetup.create_decomposeParDict()
InitializeOpenFOAMSetup.create_directory()
InitializeOpenFOAMSetup.create_fvSchemes()
InitializeOpenFOAMSetup.create_fvSolution()
InitializeOpenFOAMSetup.create_g()
InitializeOpenFOAMSetup.create_jobscripts()
InitializeOpenFOAMSetup.create_radiationProperties()
InitializeOpenFOAMSetup.create_thermophysicalProperties()
InitializeOpenFOAMSetup.create_turbulenceProperties()
InitializeOpenFOAMSetup.read_ep_results()
InitializeOpenFOAMSetup.reads
InitializeOpenFOAMSetup.run()
InitializeOpenFOAMSetup.single_use
InitializeOpenFOAMSetup.touches
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.task.run_meshing module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.task.run_openfoam_simulation module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.task.set_boundary_conditions module
SetOpenFOAMBoundaryConditions
SetOpenFOAMBoundaryConditions.add_fvOptions_for_heating()
SetOpenFOAMBoundaryConditions.assign_ep_results()
SetOpenFOAMBoundaryConditions.create_AoA()
SetOpenFOAMBoundaryConditions.create_G()
SetOpenFOAMBoundaryConditions.create_IDefault()
SetOpenFOAMBoundaryConditions.create_T()
SetOpenFOAMBoundaryConditions.create_U()
SetOpenFOAMBoundaryConditions.create_alphat()
SetOpenFOAMBoundaryConditions.create_boundaryRadiationProperties()
SetOpenFOAMBoundaryConditions.create_k()
SetOpenFOAMBoundaryConditions.create_nut()
SetOpenFOAMBoundaryConditions.create_omega()
SetOpenFOAMBoundaryConditions.create_p()
SetOpenFOAMBoundaryConditions.create_p_rgh()
SetOpenFOAMBoundaryConditions.create_qr()
SetOpenFOAMBoundaryConditions.init_boundary_conditions()
SetOpenFOAMBoundaryConditions.reads
SetOpenFOAMBoundaryConditions.run()
SetOpenFOAMBoundaryConditions.touches
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.utils package
- Submodules
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.utils.evaluateCheckMesh module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.utils.openfoam_utils module
OpenFOAMUtils
OpenFOAMUtils.detriangulize()
OpenFOAMUtils.dict_to_string()
OpenFOAMUtils.duplicate_table_for_restart()
OpenFOAMUtils.get_edge_lengths()
OpenFOAMUtils.get_min_internal_dist()
OpenFOAMUtils.get_min_refdist_between_shapes()
OpenFOAMUtils.get_refinement_level()
OpenFOAMUtils.get_vol_from_cells()
OpenFOAMUtils.get_vol_from_geometry()
OpenFOAMUtils.prime_factors()
OpenFOAMUtils.remove_coincident_vertices()
OpenFOAMUtils.split_into_three_factors()
OpenFOAMUtils.split_openfoam_elements()
OpenFOAMUtils.string_to_dict()
OpenFOAMUtils.validate_volumes_cells()
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.utils.paraViewScripts module
- bim2sim.plugins.PluginOpenFOAM.bim2sim_openfoam.utils.postProcessingPlots module
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