Borehole

class bhr.borehole.Borehole[source]

Bases: object

calc_bh_resist(mass_flow_rate: float, temperature: float) → float[source]

Computes the effective borehole thermal resistance.

Parameters:

  • mass_flow_rate – total borehole mass flow rate, in kg/s

  • temperature – average fluid temperature, in Celsius

Returns:

effective borehole resistance, in K/W-m

calc_fluid_pipe_resist(mass_flow_rate: float, temperature: float) → float[source]

Computes the fluid convection + pipe conduction resistance.

In the case of coaxial boreholes, this returns the convection resistance of the annulus + the conduction resistance of the outer pipe.

Returns:

fluid convection + pipe conduction resistance, K/(W/m)

calc_fluid_resist(mass_flow_rate: float, temperature: float) → float[source]

Computes the fluid convection resistance.

In the case of coaxial boreholes, the function returns the sum of the convection resistances for the inner pipe and annular region.

Returns:

fluid convection, K/(W/m)

calc_pipe_cond_resist() → float[source]

Computes the pipe conduction resistance.

In the case of coaxial boreholes, the function only returns the conduction resistances for the outer pipe.

Returns:

pipe conduction resistance, K/(W/m)

init_coaxial_borehole(borehole_diameter: float, outer_pipe_outer_diameter: float, outer_pipe_dimension_ratio: float, outer_pipe_conductivity: float, inner_pipe_outer_diameter: float, inner_pipe_dimension_ratio: float, inner_pipe_conductivity: float, length: float, grout_conductivity: float, soil_conductivity: float, fluid_type: str, fluid_concentration: float, boundary_condition: str = 'UNIFORM_HEAT_FLUX') → None[source]

Constructs a grouted coaxial borehole.

Parameters:

  • borehole_diameter – borehole diameter, in m.

  • outer_pipe_outer_diameter – outer diameter of outer pipe, in m.

  • outer_pipe_dimension_ratio – non-dimensional ratio of outer pipe diameter to thickness.

  • outer_pipe_conductivity – outer pipe thermal conductivity, in W/m-K.

  • inner_pipe_outer_diameter – inner diameter of outer pipe, in m.

  • inner_pipe_dimension_ratio – non-dimensional ratio of inner pipe diameter to thickness.

  • inner_pipe_conductivity – inner pipe thermal conductivity, in W/m-K.

  • length – length of borehole from top to bottom, in m.

  • grout_conductivity – grout thermal conductivity, in W/m-K.

  • soil_conductivity – pipe thermal conductivity, in W/m-K.

  • fluid_type – fluid type. “ETHYLALCOHOL”, “ETHYLENEGLYCOL”, “METHYLALCOHOL”, “PROPYLENEGLYCOL”, or “WATER”

  • fluid_concentration – fractional concentration of antifreeze mixture, from 0-0.6.

  • boundary_condition – borehole wall boundary condition. “UNIFORM_HEAT_FLUX” or “UNIFORM_BOREHOLE_WALL_TEMP”

init_double_u_borehole(borehole_diameter: float, pipe_outer_diameter: float, pipe_dimension_ratio: float, length: float, shank_space: float, pipe_conductivity: float, pipe_inlet_arrangement: str, grout_conductivity: float, soil_conductivity: float, fluid_type: str, fluid_concentration: float = 0, boundary_condition: str = 'UNIFORM_HEAT_FLUX') → None[source]

Constructs a grouted double u-tube borehole with u-tubes in parallel.

Parameters:

  • borehole_diameter – borehole diameter, in m.

  • pipe_outer_diameter – outer diameter of the pipe, in m.

  • pipe_dimension_ratio – non-dimensional ratio of pipe diameter to pipe thickness.

  • length – length of borehole from top to bottom, in m.

  • shank_space – radial distance from the borehole center to the pipe center, in m.

  • pipe_conductivity – pipe thermal conductivity, in W/m-K.

  • pipe_inlet_arrangement – arrangement of the pipe inlets. “ADJACENT”, or “DIAGONAL”

  • grout_conductivity – grout thermal conductivity, in W/m-K.

  • soil_conductivity – soil thermal conductivity, in W/m-K.

  • fluid_type – fluid type. “ETHYLALCOHOL”, “ETHYLENEGLYCOL”, “METHYLALCOHOL”, “PROPYLENEGLYCOL”, or “WATER”

  • fluid_concentration – fractional concentration of antifreeze mixture, from 0-0.6.

  • boundary_condition – borehole wall boundary condition. “UNIFORM_HEAT_FLUX” or “UNIFORM_BOREHOLE_WALL_TEMP”

init_from_dict(inputs: dict)[source]

Constructs a borehole from a set of dictionary inputs.

Parameters:

inputs – dict of input data.

init_single_u_borehole(borehole_diameter: float, pipe_outer_diameter: float, pipe_dimension_ratio: float, length: float, shank_space: float, pipe_conductivity: float, grout_conductivity: float, soil_conductivity: float, fluid_type: str, fluid_concentration: float = 0, boundary_condition: str = 'UNIFORM_HEAT_FLUX') → None[source]

Constructs a grouted single u-tube borehole.

Parameters:

  • borehole_diameter – borehole diameter, in m.

  • pipe_outer_diameter – outer diameter of the pipe, in m.

  • pipe_dimension_ratio – non-dimensional ratio of pipe diameter to pipe thickness.

  • length – length of borehole from top to bottom, in m.

  • shank_space – radial distance from the borehole center to the pipe center, in m.

  • pipe_conductivity – pipe thermal conductivity, in W/m-K.

  • grout_conductivity – grout thermal conductivity, in W/m-K.

  • soil_conductivity – soil thermal conductivity, in W/m-K.

  • fluid_type – fluid type. “ETHYLALCOHOL”, “ETHYLENEGLYCOL”, “METHYLALCOHOL”, “PROPYLENEGLYCOL”, or “WATER”

  • fluid_concentration – fractional concentration of antifreeze mixture, from 0-0.6.

  • boundary_condition – borehole wall boundary condition. “UNIFORM_HEAT_FLUX” or “UNIFORM_BOREHOLE_WALL_TEMP”