SimulationParameters API Reference

geoloop.geoloopcore.simulationparameters.SimulationParameters

Class for simulation settings, time discretization, load data, and model selection for BHE simulations.

isample property writable

isample

Index of the current simulation timestep.

__init__

__init__(
    nyear: int,
    nled: int,
    model_type: str,
    run_type: str,
    nsegments: int,
    nr: int = None,
    rmax: float = None,
    loaddata: GetLoadData = None,
) -> None

Constructor for the SimulationParameters class.

Parameters:

Name	Type	Description	Default
nyear	int	Number of simulation years.	required
nled	int	Time resolution factor (dt = 3600 * nled).	required
model_type	str	One of {FINVOL, ANALYTICAL, PYG, PYGFIELD}.	required
run_type	str	Either TIN or POWER.	required
nsegments	int	Number of depth segments used in the borehole solver.	required
nr	int	Number of radial nodes (FINVOL only).	None
rmax	float	Outer radius for radial simulation domain (FINVOL only).	None
loaddata	GetLoadData	Load data object providing Tin, Q, m_flow, and time arrays.	None

modelsupported

modelsupported() -> None

Prints a warning for unsupported model/run combinations.

from_config classmethod

from_config(
    config: SingleRunConfig,
) -> SimulationParameters

Construct a SimulationParameters object from a configuration object.

Parameters:

Name	Type	Description	Default
config	SingleRunConfig	Configuration object.	required

Returns:

Type	Description
SimulationParameters	Fully initialized simulation parameter object.