API Documentation

This section contains the complete API reference of the Carbonfly Python package. It covers geometry handling in Rhino/Grasshopper, OpenFOAM case generation, WSL-based execution, and post-processing utilities.

• carbonfly package
  • Subpackages
    • carbonfly.pythermalcomfort package
      • Subpackages
  • Submodules
    • carbonfly.blockmesh_writer module
      • write_blockmesh_dict()
    • carbonfly.boundary module
      • Boundary
      • FieldAlphatJayatillekeWF
      • FieldCO2FromPatchAverage
      • FieldCalculated
      • FieldDynamicRespiration
      • FieldEpsilonWallFunction
      • FieldExternalWallHeatFluxTemperature
      • FieldFV
      • FieldFixedFluxPressure
      • FieldInletOutlet
      • FieldIntensityKInlet
      • FieldKqRWallFunction
      • FieldMarshakRadiation
      • FieldMixingLengthEpsilonInlet
      • FieldNoSlip
      • FieldNutkWallFunction
      • FieldPressureInletOutletVelocity
      • FieldTotalPressure
      • FieldZG
    • 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
      • Refine
      • 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()