PYG_ana API Reference

geoloop.geoloopcore.pyg_ana.PYG_ana

Class to simulate a borehole heat exchanger using pygfunction for the determination of the thermal resistivity network of the borehole and analytical g-function.

Attributes:

Name	Type	Description
`custom_pipe`	`CustomPipe`	Depth-dependent borehole configuration and pipe properties.
`soil_props`	`SoilProperties`	Depth-dependent soil properties (thermal conductivity, temperature profile).
`sim_params`	`SimulationParameters`	Simulation parameters including time, flow, and input power or temperature.

Notes

The simulation can be run for power and calls the appropriate function. runsimulation_power is called for power simulations.

References

.. [#Cimmino2022] Cimmino, M., & Cook, J.C. (2022). pygfunction 2.2: New features and improvements in accuracy and computational efficiency. In Research Conference Proceedings, IGSHPA Annual Conference 2022 (pp. 45-52). International Ground Source Heat Pump Association. DOI: https://doi.org/10.22488/okstate.22.00001

init

__init__(
    custom_pipe: CustomPipe,
    soil_props: SoilProperties,
    sim_params: SimulationParameters,
)

Constructor for the PYG_ana class.

Parameters:

Name	Type	Description	Default
`custom_pipe`	`CustomPipe`	CustomPipe object defining borehole and pipe properties.	required
`soil_props`	`SoilProperties`	SoilProperties object defining soil thermal properties.	required
`sim_params`	`SimulationParameters`	SimulationParameters object defining time step, flow rate, and load.	required

runsimulation

runsimulation()

Main entry point to run the simulation.

runsimulation_power

runsimulation_power()

Run the simulation of the borehole to ground heat exchanger for an input heat demand.

Returns:

Type	Description
`tuple`	hours, Q_b, flowrate, qsign, T_fi, T_fo, T_bave, z, zseg, T_b, T_ftimes, -qbzseg, h_fpipes