GetLoadData API Reference

geoloop.geoloopcore.getloaddata.GetLoadData

Class to generate time series of flow rates, inlet temperatures, and heat/power loads for simulations.

It can use constant input values or optional time-dependent variations from either a FlowData object (variable flow rates) or a LoadProfile object (variable heat load).

Attributes:

Name	Type	Description
Tin	ndarray	Inlet temperature array (°C) over the simulation time (constant through time).
m_flow	ndarray	Mass flow rate array (kg/s) over the simulation time.
Q	ndarray	Heat load array (W) over the simulation time.
time	ndarray	Time array in seconds.
data	(FlowData or LoadProfile, optional)	Optional object providing time-dependent flow or load.

__init__

__init__(
    Tin: float,
    m_flow: float,
    Q: float,
    time: ndarray,
    loaddata: LoadProfile | FlowData = None,
)

Initialize the GetLoadData object.

Parameters:

Name	Type	Description	Default
Tin	float	Constant inlet temperature (°C) if no LoadData is provided.	required
m_flow	float	Constant mass flow rate (kg/s) if no LoadData is provided.	required
Q	float	Constant heat load (W) if no LoadData is provided.	required
time	ndarray	Array of time points (seconds) for the simulation.	required
loaddata	FlowData or LoadProfile	Optional object providing variable flow or load data.	None

from_config classmethod

from_config(config: SingleRunConfig) -> GetLoadData

Factory method to create a GetLoadData object from a configuration dictionary.

This method constructs the time array and optionally initializes either a FlowData or LoadProfile object depending on the run type.

Parameters:

Name	Type	Description	Default
config	SingleRunConfig	Configuration object of main simulation module	required

Returns:

Type	Description
GetLoadData	Initialized object with time series for flow, temperature, and heat load.