carbonfly package

carbonfly

a lightweight, easy-to-use Python API and toolbox for indoor CO2 CFD simulations in Grasshopper based on OpenFOAM and WSL

• Author: Qirui Huang

• License: LGPL-3.0

• Website: https://github.com/RWTH-E3D/carbonfly

Subpackages

• carbonfly.pythermalcomfort package
  • Subpackages
    • carbonfly.pythermalcomfort.models package
      • two_nodes_gagge()
      • two_nodes_gagge_sleep()
      • Submodules

Submodules

• carbonfly.blockmesh_writer module
  • write_blockmesh_dict()
• carbonfly.boundary module
  • Boundary
    • Boundary.boundary_field_block()
    • Boundary.btype
    • Boundary.fields
    • Boundary.patch_name
    • Boundary.region_name
    • Boundary.resolved_patch()
  • FieldAlphatJayatillekeWF
    • FieldAlphatJayatillekeWF.Prt
    • FieldAlphatJayatillekeWF.to_dict()
    • FieldAlphatJayatillekeWF.value
  • FieldCO2FromPatchAverage
    • FieldCO2FromPatchAverage.name
    • FieldCO2FromPatchAverage.source_patch
    • FieldCO2FromPatchAverage.to_dict()
  • FieldCalculated
    • FieldCalculated.to_dict()
    • FieldCalculated.value
  • FieldDynamicRespiration
    • FieldDynamicRespiration.freq
    • FieldDynamicRespiration.minute_vent_L_min
    • FieldDynamicRespiration.name
    • FieldDynamicRespiration.to_dict()
  • FieldEpsilonWallFunction
    • FieldEpsilonWallFunction.to_dict()
    • FieldEpsilonWallFunction.value
  • FieldExternalWallHeatFluxTemperature
    • FieldExternalWallHeatFluxTemperature.Ta
    • FieldExternalWallHeatFluxTemperature.h
    • FieldExternalWallHeatFluxTemperature.mode
    • FieldExternalWallHeatFluxTemperature.to_dict()
    • FieldExternalWallHeatFluxTemperature.value
  • FieldFV
    • FieldFV.to_dict()
    • FieldFV.value
  • FieldFixedFluxPressure
    • FieldFixedFluxPressure.to_dict()
    • FieldFixedFluxPressure.value
  • FieldInletOutlet
    • FieldInletOutlet.inletValue
    • FieldInletOutlet.to_dict()
    • FieldInletOutlet.value
  • FieldIntensityKInlet
    • FieldIntensityKInlet.intensity
    • FieldIntensityKInlet.to_dict()
    • FieldIntensityKInlet.value
  • FieldKqRWallFunction
    • FieldKqRWallFunction.to_dict()
    • FieldKqRWallFunction.value
  • FieldMarshakRadiation
    • FieldMarshakRadiation.emissivity
    • FieldMarshakRadiation.emissivityMode
    • FieldMarshakRadiation.to_dict()
    • FieldMarshakRadiation.value
  • FieldMixingLengthEpsilonInlet
    • FieldMixingLengthEpsilonInlet.mixingLength
    • FieldMixingLengthEpsilonInlet.to_dict()
    • FieldMixingLengthEpsilonInlet.value
  • FieldNoSlip
    • FieldNoSlip.to_dict()
  • FieldNutkWallFunction
    • FieldNutkWallFunction.to_dict()
    • FieldNutkWallFunction.value
  • FieldPressureInletOutletVelocity
    • FieldPressureInletOutletVelocity.inletValue
    • FieldPressureInletOutletVelocity.to_dict()
    • FieldPressureInletOutletVelocity.value
  • FieldTotalPressure
    • FieldTotalPressure.p0
    • FieldTotalPressure.to_dict()
    • FieldTotalPressure.value
  • FieldZG
    • FieldZG.to_dict()
• carbonfly.case module
  • build_case()
  • ensure_case_dirs()
• carbonfly.constant_writer module
  • write_constant_files()
  • write_residuals_file()
• carbonfly.control_dict module
  • make_default()
  • write_control_dict()
  • write_control_dict_from_json()
• carbonfly.field_writer module
  • write_0_field()
  • write_fields_batch()
• carbonfly.fv_writer module
  • copy_fv_templates_to_case()
  • get_template_path()
  • patch_fvSolution_pimple()
• carbonfly.geo module
  • CFGeo
    • CFGeo.name
    • CFGeo.brep
    • CFGeo.boundary
    • CFGeo.refine
    • CFGeo.boundary
    • CFGeo.brep
    • CFGeo.name
    • CFGeo.refine
  • Refine
    • Refine.max_level
    • Refine.min_level
  • make_cfgeo()
• carbonfly.iaq module
  • iaq_co2()
• carbonfly.mesh module
  • brep_to_mesh()
  • mesh_triangles()
  • write_multi_solid_ascii_stl()
• carbonfly.postproc module
  • collect_internal_probes_results()
  • run_internal_probes_postprocess()
  • write_internal_probes_dict()
• carbonfly.snappy_writer module
  • write_snappy_geometry()
  • write_surface_features_dict()
• carbonfly.utils module
  • air_exchange_rate_maas1995()
  • co2_generation_rate()
  • foam_header()
  • unit_scale_to_m()
  • wind_pressure_en1991()
• carbonfly.wsl module
  • run_blockmesh_console()
  • run_check_mesh_console()
  • run_foam_console()
  • run_foam_monitor_console()
  • run_snappy_console()
  • run_surface_features_console()
  • run_wsl_console()
  • win_to_wsl_path()
  • wsl_to_win_path()