pydhn

• citysim
  • citysim
    • demand_from_citysim_xml()
    • read_citysim_xml()
    • temperature_from_citysim_xml()
    • to_citysim_xml()
  • citysim_ops
    • compute_kv_max_from_power()
    • compute_pump_ideal_speed()
    • compute_pump_ks_from_params()
    • compute_valve_ideal_kv()
• classes
  • abstract_network
    • AbstractNetwork
      • AbstractNetwork.__init__()
      • AbstractNetwork.add_edge()
      • AbstractNetwork.add_node()
      • AbstractNetwork.adjacency_matrix
      • AbstractNetwork.caching
      • AbstractNetwork.copy()
      • AbstractNetwork.cycle_matrix
      • AbstractNetwork.edges()
      • AbstractNetwork.get_edges_attribute_array()
      • AbstractNetwork.get_edges_with_attribute()
      • AbstractNetwork.get_nodes_attribute_array()
      • AbstractNetwork.get_nodes_with_attribute()
      • AbstractNetwork.incidence_matrix
      • AbstractNetwork.load_gml()
      • AbstractNetwork.load_graph()
      • AbstractNetwork.n_edges
      • AbstractNetwork.n_nodes
      • AbstractNetwork.nodes()
      • AbstractNetwork.plot_network()
      • AbstractNetwork.save_gml()
      • AbstractNetwork.save_graph()
      • AbstractNetwork.set_edge_attribute()
      • AbstractNetwork.set_edge_attributes()
      • AbstractNetwork.set_node_attribute()
      • AbstractNetwork.set_node_attributes()
      • AbstractNetwork.to_geodataframe()
      • AbstractNetwork.to_geojson()
      • AbstractNetwork.to_linegraph()
      • AbstractNetwork.to_nx_graph()
  • network
    • Network
      • Network.__init__()
      • Network.add_branch_pump()
      • Network.add_branch_valve()
      • Network.add_bypass_pipe()
      • Network.add_component()
      • Network.add_consumer()
      • Network.add_lagrangian_pipe()
      • Network.add_pipe()
      • Network.add_producer()
      • Network.branch_components_mask
      • Network.branch_components_pointer
      • Network.consumers_cycle_matrix
      • Network.consumers_mask
      • Network.consumers_pointer
      • Network.cycle_matrix
      • Network.ideal_components_mask
      • Network.imposed_mdot_matrix
      • Network.imposed_pumps_mask
      • Network.imposed_valves_mask
      • Network.leaf_components_mask
      • Network.leaf_components_pointer
      • Network.main_edge_mask
      • Network.mask()
      • Network.mass_flow_setpoints_mask
      • Network.mass_flow_setpoints_pointer
      • Network.n_consumers
      • Network.n_pipes
      • Network.n_producers
      • Network.pipes_mask
      • Network.pipes_pointer
      • Network.pressure_setpoints_mask
      • Network.pressure_setpoints_pointer
      • Network.producers_mask
      • Network.producers_pointer
      • Network.pumps_mask
      • Network.real_components_mask
      • Network.return_line_mask
      • Network.return_line_pointer
      • Network.run_sanity_checks()
      • Network.secondary_producers_mask
      • Network.supply_line_mask
      • Network.supply_line_pointer
      • Network.to_citysim_xml()
      • Network.valves_mask
  • results
    • Results
      • Results.__init__()
      • Results.append()
      • Results.from_csv()
      • Results.to_csv()
      • Results.to_dataframes()
      • Results.update()
• components
  • abstract_component
    • Component
      • Component.__init__()
      • Component.set()
  • base_branch_valve
    • BranchValve
      • BranchValve.__init__()
  • base_bypass_pipe
    • BypassPipe
      • BypassPipe.__init__()
  • base_components_hydraulics
    • compute_dp_pipe()
    • compute_dp_pipe_net()
    • compute_dp_valve()
    • compute_dp_valve_net()
    • compute_friction_factor()
  • base_components_thermal
    • compute_cons_temp_net()
    • compute_hx_temp()
    • compute_hx_temp_net()
    • compute_pipe_temp()
    • compute_pipe_temp_net()
    • compute_prod_temp_net()
  • base_consumer
    • Consumer
      • Consumer.__init__()
  • base_pipe
    • Pipe
      • Pipe.__init__()
  • base_producer
    • Producer
      • Producer.__init__()
  • branch_pump
    • BranchPump
      • BranchPump.__init__()
  • citysim_components_hydraulics
    • compute_dp_pump_cs()
    • compute_dp_pump_cs_der()
    • compute_dp_valve_cs()
    • compute_dp_valve_cs_der()
  • lagrangian_pipe
    • LagrangianPipe
      • LagrangianPipe.__init__()
  • vector_functions
• controllers
  • controller
    • Controller
      • Controller.__init__()
      • Controller.compute_der()
      • Controller.compute_residuals()
      • Controller.control_matrix
      • Controller.edge_mask
      • Controller.get_control_matrix()
      • Controller.get_edge()
      • Controller.get_edge_index()
      • Controller.is_initialized()
      • Controller.stage
      • Controller.update()
  • pump_controller
    • PumpController
      • PumpController.__init__()
      • PumpController.compute_der()
      • PumpController.compute_residuals()
      • PumpController.path_masks
      • PumpController.update()
• default_values
  • default_values
    • A0
    • A1
    • A2
    • BYPASS_CASING_THICKNESS
    • BYPASS_INSULATION_THICKNESS
    • CASING_THICKNESS
    • CONTROL_TYPE_CONS
    • CP_FLUID
    • CP_INTERNAL_PIPE
    • CP_WATER
    • DELTA_P
    • DELTA_P_FRICTION
    • DELTA_Z
    • DEPTH
    • DISCRETIZATION
    • DT_DESIGN
    • D_BYPASS
    • D_HX
    • D_PIPES
    • HEAT_DEMAND
    • H_EXT
    • INLET_TEMPERATURE
    • INSULATION_THICKNESS
    • INTERNAL_BYPASS_THICKNESS
    • INTERNAL_PIPE_THICKNESS
    • K2
    • KV
    • KV_MIN
    • K_CASING
    • K_FLUID
    • K_INSULATION
    • K_INTERNAL_PIPE
    • K_SOIL
    • K_WATER
    • L_BYPASS_PIPES
    • L_PIPES
    • MASS_FLOW
    • MASS_FLOW_MIN_CONS
    • MU_FLUID
    • MU_WATER
    • OUTLET_TEMPERATURE
    • POWER_MAX_HX
    • RHO_FLUID
    • RHO_INTERNAL_PIPE
    • RHO_WATER
    • ROUGHNESS
    • RPM
    • RPM_MAX
    • SETPOINT_TYPE_HX
    • SETPOINT_TYPE_HX_CONS
    • SETPOINT_TYPE_HX_CONS_REV
    • SETPOINT_TYPE_HX_PROD
    • SETPOINT_TYPE_HX_PROD_REV
    • SETPOINT_TYPE_HX_REV
    • SETPOINT_TYPE_HYD_CONS
    • SETPOINT_TYPE_HYD_PROD
    • SETPOINT_VALUE_HX
    • SETPOINT_VALUE_HX_CONS
    • SETPOINT_VALUE_HX_CONS_REV
    • SETPOINT_VALUE_HX_PROD
    • SETPOINT_VALUE_HX_PROD_REV
    • SETPOINT_VALUE_HX_REV
    • SETPOINT_VALUE_HYD_CONS
    • SETPOINT_VALUE_HYD_PROD
    • STATIC_PRESSURE
    • STEPSIZE
    • TEMPERATURE
    • T_OUT_MIN
    • T_SECONDARY
    • T_SOIL
• fluids
  • dimensionless_numbers
    • compute_nusselt()
    • compute_prandtl()
    • compute_reynolds()
    • gnielinski_nusselt()
    • laminar_nusselt()
    • transition_nusselt()
  • fluids
    • ConstantWater
      • ConstantWater.__init__()
    • Fluid
      • Fluid.__init__()
      • Fluid.get_cp()
      • Fluid.get_k()
      • Fluid.get_mu()
      • Fluid.get_rho()
    • Water
      • Water.__init__()
      • Water.get_cp()
      • Water.get_k()
      • Water.get_mu()
      • Water.get_rho()
• networks
  • load_networks
    • star_network()
• plotting
  • interactive
    • plot_network_interactive()
  • plotting
    • plot_network()
• soils
  • soils
    • KusudaSoil
      • KusudaSoil.__init__()
      • KusudaSoil.get_temp()
    • Soil
      • Soil.__init__()
      • Soil.get_k()
      • Soil.get_temp()
• solving
  • climate
    • compute_soil_temperature()
  • common
    • compute_hx_ideal_mdot()
    • compute_pipe_section_area()
  • hydraulic_simulation
    • solve_hydraulics()
  • loops
    • AbstractLoop
      • AbstractLoop.__init__()
      • AbstractLoop.current_phase
      • AbstractLoop.execute()
    • Scheduler
      • Scheduler.__init__()
    • SimpleStep
      • SimpleStep.__init__()
  • pressure
    • compute_dp()
  • temperature
    • compute_edge_temperatures()
  • thermal_simulation
    • solve_thermal()
• utilities
  • caching
    • np_cache()
  • conversion
    • celsius_to_kelvin()
    • kelvin_to_celsius()
    • mass_flow_rate_to_velocity()
    • mass_to_volumetric_flow_rate()
    • velocity_to_mass_flow_rate()
    • velocity_to_volumetric_flow_rate()
    • volumetric_flow_rate_to_velocity()
    • volumetric_to_mass_flow_rate()
  • geospatial
    • Encoder
      • Encoder.default()
    • edges_to_geojson()
    • graph_to_geodataframe()
    • graph_to_geojson()
    • nodes_to_geojson()
  • graph_utilities
    • add_time_to_pipes()
    • assign_line()
    • compute_linegraph()
    • compute_linegraph_net()
    • connect_pairs()
    • find_path_with_edge()
    • get_edges_attribute_array()
    • get_furthest_consumers()
    • get_longest_paths()
    • get_nodes_attribute_array()
    • get_pipes_to_consumers_dict()
    • get_supply_time()
    • run_sanity_checks()
  • loading
    • add_catalogue_from_dataframe()
    • add_catalogue_from_postgres()
    • add_edges_from_dataframe()
    • add_nodes_from_dataframe()
    • add_nodes_from_postgres()
  • matrices
    • compute_adjacency_matrix()
    • compute_consumers_cycle_matrix()
    • compute_cycle_matrix()
    • compute_imposed_mdot_matrix()
    • compute_incidence_matrix()
    • compute_network_cycle_matrix()
  • utilities
    • affine_by_parts()
    • compute_relative_error()
    • docstring_parameters()
    • isiter()
    • safe_divide()
    • safe_slice()