Modules & Functions

Utilities Subpackage

• Utility modules
  • constants
  • exceptions
    • SupplyDataMissingError
  • functions
    • calculate_average_flow_velocity()
    • calculate_flow_velocity()
    • calculate_fluid_density()
    • calculate_fluid_specific_heat()
    • calculate_heat_flow()
    • calculate_heat_flow_loss()
    • calculate_insulation_external_diameter()
    • calculate_insulation_thickness()
    • calculate_output_temperature()
    • calculate_pipe_internal_diameter()
    • calculate_r_conduction()
    • calculate_r_convection()
    • calculate_r_total()
    • select_ambient_temperature()
    • select_heat_transfer_coeff()
  • validation
    • validate_damage()

Main Modules

• branch
  • Branch
    • Branch.initial_values
    • Branch.th_values
    • Branch.damage_mode
    • Branch.damage
    • Branch.calculate_branch_length()
    • Branch.calculate_return()
    • Branch.calculate_supply()
    • Branch.calculate_system_heat_flow()
    • Branch.class_instances_created
    • Branch.get_class_instance_count()
    • Branch.print_input_data()
• config_data
  • AmbientTemp
    • AmbientTemp.t_channel_c
    • AmbientTemp.t_soil_c
    • AmbientTemp.t_surface_c
  • BranchInitialConfig
    • BranchInitialConfig.fluid
    • BranchInitialConfig.p_nominal_pa
    • BranchInitialConfig.t_consumer_release_c
    • BranchInitialConfig.t_in_return_c
    • BranchInitialConfig.t_in_supply_c
    • BranchInitialConfig.th_avg_ins_damage_m
    • BranchInitialConfig.vdot_m3_per_h
• data_input
• data_output
  • PipeRow
    • PipeRow.convert_to_dict_pipe()
    • PipeRow.l_tot
    • PipeRow.lat
    • PipeRow.lon
    • PipeRow.mdot
    • PipeRow.mdot_consumer
    • PipeRow.qdot_consumer_abs
    • PipeRow.qdot_consumer_act
    • PipeRow.qdot_loss
    • PipeRow.qdot_loss_tot
    • PipeRow.qdot_tot
    • PipeRow.qdotnorm_loss
    • PipeRow.t_in
    • PipeRow.v_fluid
  • SystemRow
    • SystemRow.convert_to_dict_system()
    • SystemRow.l_tot
    • SystemRow.lat
    • SystemRow.lon
    • SystemRow.qdot_system
• main
  • main()
  • plot_branch_dir()
  • plot_config()
  • plot_losses()
  • plot_temperature()
• model_param
  • PipeSectionLocation
    • PipeSectionLocation.loc1
    • PipeSectionLocation.loc2
    • PipeSectionLocation.loc3
  • ThermalCoeff
    • ThermalCoeff.h_channel_w_per_m2k
    • ThermalCoeff.h_soil_w_per_m2k
    • ThermalCoeff.h_surface_w_per_m2k
    • ThermalCoeff.h_water_w_per_m2k
    • ThermalCoeff.k_ins_damaged_w_per_mk
    • ThermalCoeff.k_ins_w_per_mk
    • ThermalCoeff.k_pipe_w_per_mk
• plots
  • plot_branch()
  • plot_heat_flow_loss()
  • plot_heat_flow_loss_nodes()
  • plot_insulation()
  • plot_mass_flow()
  • plot_normalised_heat_flow_loss()
  • plot_output_heatmap()
  • plot_temperature()
  • plot_total_heat_flow_loss()