#include <global.h>

Static Public Member Functions
static void	InitializeStaticVariables ()

static void	DeleteStaticVariables ()

static bool	AllVariablesInitialized ()

static void	PrintUninitializedVariables ()
	Prints all variable names to stdout, that are not initialized.

static bool	CheckTimeRelatedVariablesInitState ()
	Returns true if all time-related variables have been initialized. If not, it will return false and prints out all missing variables. It does not include Global::first_timestep and Global::last_timestep (as this checking function is considered to be executed before the calculation of both values). Moreover, it will print out warnings for impossible combinations.

static void	LockAllVariables ()
	No (set) variable can be overwritten after this call, unset variables can still be set / overwritten once.

static void	UnlockAllVariables ()
	All variables can now be overwritten.

static unsigned long	get_n_timesteps ()

static unsigned long	get_first_timestep ()
	Returns the first timestep (starting at 1) in the simulation range.

static unsigned long	get_last_timestep ()
	Returns the last (inclusive) timestep (starting at 1) in the simulation range.

static unsigned long	get_n_substations ()

static unsigned long	get_n_CUs ()

static unsigned long	get_n_MUs ()

static unsigned long	get_n_pv_profiles ()

static unsigned long	get_n_heatpump_profiles ()

static unsigned int	get_seed ()

static bool	is_seed_set ()

static bool	get_compute_weekly_metrics ()

static bool	is_parameter_variation ()

static int	get_parameter_varID ()

static bool	get_repetitions_selected ()

static uint	get_n_repetitions ()

static uint	get_n_threads ()

static bool	get_work_stealing ()
	True, if work stealing is selected between the running worker threads.

static bool	get_stop_on_cc_err ()
	Stores the value of command line option 'stop_on_cc_err'. True, if the simulation execution should be stopped on if an computation error occurs inside an optimization-based controller in any control unit.

static struct tm *	get_ts_start_tm ()

static struct tm *	get_ts_end_tm ()

static unsigned int	get_tsteps_per_hour ()

static float	get_time_step_size_in_h ()

static unsigned long	get_expansion_scenario_id ()

static bool	get_break_sac_loop_if_limit_reached ()
	Returns true if the SAC loop should be stopped for an individual combination (like PV + HP) if one of the limits is reached (either PV or HP) (even though HP components should still be added)

static float	get_exp_pv_kWp_static ()

static float	get_exp_pv_kWp_per_m2 ()

static float	get_exp_pv_min_kWp_roof_sec ()
	Returns the min. kWp per roof section - smaller sections will be ignored, defaults to 0.0.

static float	get_exp_pv_max_kWp_roof_sec ()
	Returns the max. kWp per roof section, or -1.0 if it is not set.

static float	get_exp_pv_max_kWp_per_unit ()
	Returns the max. kWp per unit, or -1.0 if it is not set.

static float	get_exp_pv_max_kWp_total ()
	Returns the max. kWp for all expanded units, or -1.0 if it is not set.

static float	get_exp_bess_kW ()

static float	get_exp_bess_kWh ()

static float	get_exp_bess_E_P_ratio ()

static float	get_exp_bess_max_capacity ()
	Returns the maxium capacity of a battery storage (important for sizing with other modes than constant). Returns -1 if it is not set.

static float	get_exp_bess_sizingE_boPV ()

static float	get_exp_bess_start_soc ()
	!< Returns the factor multiplied with PV nominal power if the battery sizing mode is set to use the PV capacity

static float	get_exp_bess_effi_in ()

static float	get_exp_bess_effi_out ()

static float	get_exp_bess_self_ds_ts ()

static float	get_exp_bess_P_for_SOC_0 ()

static float	get_exp_bess_P_for_SOC_1 ()

static float	get_exp_bess_max_E_total ()
	Returns the upper limit of (resid.) battery capacity for installation, or -1.0 if it is not set.

static float	get_exp_bess_max_P_total ()
	Returns the upper limit of (resid.) battery power for installation, or -1.0 if it is not set.

static bool	is_exp_hp_max_n_addition_set ()
	Returns true iif a upper limit for the number of added heat pumps is set. The concrete value would be given by Global::get_exp_hp_max_n_addition().

static unsigned long	get_exp_hp_max_n_addition ()
	Upper limit for the number of added simulated heat pumps.

static bool	is_exp_ev_max_n_addition_set ()
	Returns true iif a upper limit for the number of added EVs is set. The concrete value would be given by Global::get_exp_ev_max_n_addition().

static unsigned long	get_exp_ev_max_n_addition ()
	Upper limit for the (total) number of added EVs (summed over all control units)

static unsigned long	get_exp_cs_max_ev_per_cs ()
	0 if not selected. Returns the upper limit for the number of added EVs per control unit / EV charging station. Units with more EVs are not selected.

static float	get_open_space_pv_kWp ()

static float	get_wind_kWp ()

static float	get_feed_in_tariff ()

static float	get_demand_tariff ()

static float	get_emissions_g_CO2eq_per_kWh ()

static float	get_inst_cost_PV_per_kWp ()
	!< Returns the mean emissions in g CO2eq for one kWh of grid demanded energy. If a time series is available, use the latter one!

static float	get_inst_cost_BS_per_kWh ()

static float	get_inst_cost_HP_per_kW ()

static float	get_inst_cost_CS_per_unit ()

static float	get_npv_discount_rate ()

static unsigned int	get_npv_time_horizon ()

static double	get_npv_factor_if_const ()
	Returns the factor for multiplication in the NPV formula for the discounted revenues if the cashflow is constant.

static double	get_annuity_factor ()
	Returns the annuity factor for economic assesment.

static unsigned int	get_hp_flexibility_in_ts ()
	Returns the flexibility of the heat pump profiles in time steps.

static float	get_heat_demand_thermalE_to_hpE_conv_f ()

static float	get_heat_cons_bobv_slope ()
	Parameter of linear regression (slope) for estimating annual heat consumption based on the building volume (bobv)

static float	get_heat_cons_bobv_intercept ()
	Parameter of linear regression (intercept) for estimating annual heat consumption based on the building volume (bobv)

static float	get_ev_plugin_probability ()

static float	get_ev_battery_size_kWh ()
	The battery capacity in kWh for simulated EVs.

static float	get_ev_consumption_kWh_km ()
	The electricity consumption of an EV for driving 1 km.

static float	get_ev_max_charging_power_kW ()
	The maximum charging power of a simulated EV.

static float	get_cs_max_charging_power_kW ()
	Returns the maximum charging power per simulated ComponentCS or -1, if not set.

static bool	get_use_emission_time_series_ia ()
	Return weather the emission time series (if it is available in the data) should be used or not.

static bool	get_use_prices_time_series_ia ()
	Return weather the electricity prices time series (if it is available in the data) should be used or not.

static bool	get_select_only_residential_buildings ()
	Should only be residential buildings be considered for simulated component addition (SAC planning)?

static uint	get_control_horizon_in_ts ()
	The control horizon in time steps (only if controller_mode is set to a value including optimization)

static uint	get_control_update_freq_in_ts ()
	The update frequency of the optimization inside the control units (only if controller_mode is set to a value including optimization)

static unsigned long	get_max_parallel_opti_vars ()
	Returns the number of maximum parallel optimization variables, or 0, if not set.

static const std::string &	get_input_path ()

static const std::string &	get_output_path ()

static const std::string &	get_structure_database_name ()

static const std::string &	get_ev_data_path ()

static const std::string &	get_cache_dir_path ()
	Returns the path for the cache directory - it this was NOT set, it will return the default value which is the input path.

static global::OutputModePerCU	get_output_mode_per_cu ()

static global::ExpansionProfileAllocationMode	get_exp_profile_mode ()

static global::CUSModeFCA	get_cu_selection_mode_fca ()

static global::BatteryPowerComputationMode	get_battery_power_computation_mode ()

static global::BatteryCapacityComputationMode	get_battery_capacity_computation_mode ()

static global::PVSizingMode	get_exp_pv_sizing_mode ()

static global::ControllerMode	get_controller_mode ()

static global::ControllerBSGridChargingMode	get_controller_bs_grid_charging_mode ()
	Return whether the battery can be charged from the grid / discharged into the grid - only effective if an optimized charging strategy is selected.

static global::ControllerOptimizationTarget	get_controller_optimization_target ()
	Returns the selected optimization target (only valid if a controller mode with optimization is selected)

static const std::set< unsigned long > *	get_cu_list_for_sac_planning ()
	Returns the std::set of control unit IDs (if existing, otherwise NULL) that contains the IDs of the units that should be selected for SAC addition.

static float	get_annual_heat_demand_limit_fsac ()
	Returns the upper limit for selection of a control unit for simulative addition based on the annual heat demand in kWh; -1 if this value is not set (thus no limit is given; default)

static bool	get_select_buildings_wg_heatd_only ()
	True, if only buildings are to be selected for the simulated addition for which an exact specified heat demand is given in the input data - Defaults to false.

static bool	get_create_substation_output ()
	Returns whether a output for the substation time series should be created or not.

static bool	get_create_control_cmd_output ()
	Returns wheather a output for detailed control commands per time step and CU should be created.

static bool	get_create_ev_detailed_output ()
	Returns wheather a output for detailed EV states per time step and EV should be created.

static const std::string &	get_exp_pv_static_profile_orientation ()

static int	get_exp_pv_static_profile_idx ()

static void	increment_seed ()
	Thus class method increments the current seed at anytime during the simulation, no lock is applied to this function.

static void	set_n_timesteps (unsigned long n_timesteps)

static void	set_first_timestep (unsigned long ts)

static void	set_last_timestep (unsigned long ts)

static void	set_n_substations (unsigned long n_substations)

static void	set_n_CUs (unsigned long n_CUs)

static void	set_n_MUs (unsigned long n_MUs)

static void	set_n_pv_profiles (unsigned long n_pv_ts)

static void	set_n_heatpump_profiles (unsigned long n_hp_ts)

static void	set_seed (unsigned int value)

static void	set_compute_weekly_metrics (bool mode)

static void	set_pvar_vals (bool pvar_set, int pvarID)

static void	set_repetitions_selected (bool value)

static void	set_n_repetitions (unsigned int value)

static void	set_n_threads (unsigned int value)

static void	set_work_stealing (bool value)

static void	set_stop_on_cc_err (bool value)

static void	set_ts_start_tm (struct tm *ts_start_tm)

static void	set_ts_end_tm (struct tm *ts_end_tm)

static void	set_tsteps_per_hour (int tsteps_per_hour)

static void	set_expansion_scenario_id (unsigned long expansion_scenario_id)

static void	set_break_sac_loop_if_limit_reached (bool value)

static void	set_exp_pv_sizing_mode (global::PVSizingMode mode)

static void	set_exp_pv_kWp_static (float value)

static void	set_exp_pv_kWp_per_m2 (float value)

static void	set_exp_pv_min_kWp_roof_sec (float value)

static void	set_exp_pv_max_kWp_roof_sec (float value)

static void	set_exp_pv_max_kWp_per_unit (float value)

static void	set_exp_pv_max_kWp_total (float value)

static void	set_exp_bess_kW (float exp_bess_kW)

static void	set_exp_bess_kWh (float exp_bess_kWh)

static void	set_exp_bess_E_P_ratio (float value)

static void	set_exp_bess_max_capacity (float value)

static void	set_exp_bess_sizingE_boPV (float value)

static void	set_exp_bess_start_soc (float exp_bess_start_soc)

static void	set_exp_bess_effi_in (float value)

static void	set_exp_bess_effi_out (float value)

static void	set_exp_bess_self_ds_ts (float value)

static void	set_exp_bess_P_for_SOC_0 (float value)

static void	set_exp_bess_P_for_SOC_1 (float value)

static void	set_exp_bess_max_E_total (float value)

static void	set_exp_bess_max_P_total (float value)

static void	set_exp_hp_max_n_addition (unsigned long value)

static void	set_exp_ev_max_n_addition (unsigned long value)

static void	set_exp_cs_max_ev_per_cs (unsigned long value)

static void	set_open_space_pv_kWp (float open_space_kWp)

static void	set_wind_kWp (float wind_kWp)

static void	set_feed_in_tariff (float value)

static void	set_demand_tariff (float value)

static void	set_emissions_g_CO2eq_per_kWh (float value)

static void	set_inst_cost_PV_per_kWp (float value)

static void	set_inst_cost_BS_per_kWh (float value)

static void	set_inst_cost_HP_per_kW (float value)

static void	set_inst_cost_CS_per_unit (float value)

static void	set_npv_discount_rate (float value)

static void	set_npv_time_horizon (unsigned int value)

static void	set_hp_flexibility_in_ts (unsigned int value)

static void	set_heat_demand_thermalE_to_hpE_conv_f (float value)

static void	set_heat_cons_bobv_slope (float value)

static void	set_heat_cons_bobv_intercept (float value)

static void	set_ev_plugin_probability (float value)

static void	set_ev_battery_size_kWh (float value)

static void	set_ev_consumption_kWh_km (float value)

static void	set_ev_max_charging_power_kW (float value)

static void	set_cs_max_charging_power_kW (float value)

static void	set_use_emission_time_series_ia (bool use)

static void	set_use_prices_time_series_ia (bool use)

static void	set_select_only_residential_buildings (bool value)

static void	set_control_horizon_in_ts (unsigned int value)

static void	set_control_update_freq_in_ts (unsigned int value)

static void	set_max_parallel_opti_vars (unsigned long value)

static void	set_input_path (std::string *path)

static void	set_output_path (std::string *path)

static void	set_structure_database_name (std::string *fname)

static void	set_ev_data_path (std::string *path)

static void	set_cache_dir_path (const std::string *path)

static void	set_output_mode_per_cu (global::OutputModePerCU mode)

static void	set_exp_profile_mode (global::ExpansionProfileAllocationMode mode)

static void	set_cu_selection_mode_fca (global::CUSModeFCA mode)

static void	set_battery_power_computation_mode (global::BatteryPowerComputationMode mode)

static void	set_battery_capacity_computation_mode (global::BatteryCapacityComputationMode mode)

static void	set_controller_mode (global::ControllerMode mode)

static void	set_controller_bs_grid_charging_mode (global::ControllerBSGridChargingMode mode)

static void	set_controller_optimization_target (global::ControllerOptimizationTarget mode)

static void	set_cu_list_for_sac_planning (const std::set< unsigned long > *selected_cuIDs)

static void	set_annual_heat_demand_limit_fsac (float value)

static void	set_select_buildings_wg_heatd_only (bool value)

static void	set_create_substation_output (bool value)

static void	set_create_control_cmd_output (bool value)

static void	set_create_ev_detailed_output (bool value)

static void	set_exp_pv_static_profile_orientation (std::string *value)

static void	set_exp_pv_static_profile_idx (int value)

Member Function Documentation

◆ AllVariablesInitialized()

bool Global::AllVariablesInitialized ( )

static

◆ CheckTimeRelatedVariablesInitState()

bool Global::CheckTimeRelatedVariablesInitState ( )

static

Returns true if all time-related variables have been initialized. If not, it will return false and prints out all missing variables. It does not include Global::first_timestep and Global::last_timestep (as this checking function is considered to be executed before the calculation of both values). Moreover, it will print out warnings for impossible combinations.

◆ DeleteStaticVariables()

void Global::DeleteStaticVariables ( )

static

◆ get_annual_heat_demand_limit_fsac()

static float Global::get_annual_heat_demand_limit_fsac ( )

inlinestatic

Returns the upper limit for selection of a control unit for simulative addition based on the annual heat demand in kWh; -1 if this value is not set (thus no limit is given; default)

◆ get_annuity_factor()

static double Global::get_annuity_factor ( )

inlinestatic

Returns the annuity factor for economic assesment.

◆ get_battery_capacity_computation_mode()

static global::BatteryCapacityComputationMode Global::get_battery_capacity_computation_mode ( )

inlinestatic

◆ get_battery_power_computation_mode()

static global::BatteryPowerComputationMode Global::get_battery_power_computation_mode ( )

inlinestatic

◆ get_break_sac_loop_if_limit_reached()

static bool Global::get_break_sac_loop_if_limit_reached ( )

inlinestatic

Returns true if the SAC loop should be stopped for an individual combination (like PV + HP) if one of the limits is reached (either PV or HP) (even though HP components should still be added)

◆ get_cache_dir_path()

static const std::string & Global::get_cache_dir_path ( )

inlinestatic

Returns the path for the cache directory - it this was NOT set, it will return the default value which is the input path.

◆ get_compute_weekly_metrics()

static bool Global::get_compute_weekly_metrics ( )

inlinestatic

◆ get_control_horizon_in_ts()

static uint Global::get_control_horizon_in_ts ( )

inlinestatic

The control horizon in time steps (only if controller_mode is set to a value including optimization)

◆ get_control_update_freq_in_ts()

static uint Global::get_control_update_freq_in_ts ( )

inlinestatic

The update frequency of the optimization inside the control units (only if controller_mode is set to a value including optimization)

◆ get_controller_bs_grid_charging_mode()

static global::ControllerBSGridChargingMode Global::get_controller_bs_grid_charging_mode ( )

inlinestatic

Return whether the battery can be charged from the grid / discharged into the grid - only effective if an optimized charging strategy is selected.

◆ get_controller_mode()

static global::ControllerMode Global::get_controller_mode ( )

inlinestatic

◆ get_controller_optimization_target()

static global::ControllerOptimizationTarget Global::get_controller_optimization_target ( )

inlinestatic

Returns the selected optimization target (only valid if a controller mode with optimization is selected)

◆ get_create_control_cmd_output()

static bool Global::get_create_control_cmd_output ( )

inlinestatic

Returns wheather a output for detailed control commands per time step and CU should be created.

◆ get_create_ev_detailed_output()

static bool Global::get_create_ev_detailed_output ( )

inlinestatic

Returns wheather a output for detailed EV states per time step and EV should be created.

◆ get_create_substation_output()

static bool Global::get_create_substation_output ( )

inlinestatic

Returns whether a output for the substation time series should be created or not.

◆ get_cs_max_charging_power_kW()

static float Global::get_cs_max_charging_power_kW ( )

inlinestatic

Returns the maximum charging power per simulated ComponentCS or -1, if not set.

◆ get_cu_list_for_sac_planning()

static const std::set< unsigned long > * Global::get_cu_list_for_sac_planning ( )

inlinestatic

Returns the std::set of control unit IDs (if existing, otherwise NULL) that contains the IDs of the units that should be selected for SAC addition.

◆ get_cu_selection_mode_fca()

static global::CUSModeFCA Global::get_cu_selection_mode_fca ( )

inlinestatic

◆ get_demand_tariff()

static float Global::get_demand_tariff ( )

inlinestatic

◆ get_emissions_g_CO2eq_per_kWh()

static float Global::get_emissions_g_CO2eq_per_kWh ( )

inlinestatic

◆ get_ev_battery_size_kWh()

static float Global::get_ev_battery_size_kWh ( )

inlinestatic

The battery capacity in kWh for simulated EVs.

◆ get_ev_consumption_kWh_km()

static float Global::get_ev_consumption_kWh_km ( )

inlinestatic

The electricity consumption of an EV for driving 1 km.

◆ get_ev_data_path()

static const std::string & Global::get_ev_data_path ( )

inlinestatic

◆ get_ev_max_charging_power_kW()

static float Global::get_ev_max_charging_power_kW ( )

inlinestatic

The maximum charging power of a simulated EV.

◆ get_ev_plugin_probability()

static float Global::get_ev_plugin_probability ( )

inlinestatic

◆ get_exp_bess_E_P_ratio()

static float Global::get_exp_bess_E_P_ratio ( )

inlinestatic

◆ get_exp_bess_effi_in()

static float Global::get_exp_bess_effi_in ( )

inlinestatic

◆ get_exp_bess_effi_out()

static float Global::get_exp_bess_effi_out ( )

inlinestatic

◆ get_exp_bess_kW()

static float Global::get_exp_bess_kW ( )

inlinestatic

◆ get_exp_bess_kWh()

static float Global::get_exp_bess_kWh ( )

inlinestatic

◆ get_exp_bess_max_capacity()

static float Global::get_exp_bess_max_capacity ( )

inlinestatic

Returns the maxium capacity of a battery storage (important for sizing with other modes than constant). Returns -1 if it is not set.

◆ get_exp_bess_max_E_total()

static float Global::get_exp_bess_max_E_total ( )

inlinestatic

Returns the upper limit of (resid.) battery capacity for installation, or -1.0 if it is not set.

◆ get_exp_bess_max_P_total()

static float Global::get_exp_bess_max_P_total ( )

inlinestatic

Returns the upper limit of (resid.) battery power for installation, or -1.0 if it is not set.

◆ get_exp_bess_P_for_SOC_0()

static float Global::get_exp_bess_P_for_SOC_0 ( )

inlinestatic

◆ get_exp_bess_P_for_SOC_1()

static float Global::get_exp_bess_P_for_SOC_1 ( )

inlinestatic

◆ get_exp_bess_self_ds_ts()

static float Global::get_exp_bess_self_ds_ts ( )

inlinestatic

◆ get_exp_bess_sizingE_boPV()

static float Global::get_exp_bess_sizingE_boPV ( )

inlinestatic

◆ get_exp_bess_start_soc()

static float Global::get_exp_bess_start_soc ( )

inlinestatic

!< Returns the factor multiplied with PV nominal power if the battery sizing mode is set to use the PV capacity

◆ get_exp_cs_max_ev_per_cs()

static unsigned long Global::get_exp_cs_max_ev_per_cs ( )

inlinestatic

0 if not selected. Returns the upper limit for the number of added EVs per control unit / EV charging station. Units with more EVs are not selected.

◆ get_exp_ev_max_n_addition()

static unsigned long Global::get_exp_ev_max_n_addition ( )

inlinestatic

Upper limit for the (total) number of added EVs (summed over all control units)

◆ get_exp_hp_max_n_addition()

static unsigned long Global::get_exp_hp_max_n_addition ( )

inlinestatic

Upper limit for the number of added simulated heat pumps.

◆ get_exp_profile_mode()

static global::ExpansionProfileAllocationMode Global::get_exp_profile_mode ( )

inlinestatic

◆ get_exp_pv_kWp_per_m2()

static float Global::get_exp_pv_kWp_per_m2 ( )

inlinestatic

◆ get_exp_pv_kWp_static()

static float Global::get_exp_pv_kWp_static ( )

inlinestatic

◆ get_exp_pv_max_kWp_per_unit()

static float Global::get_exp_pv_max_kWp_per_unit ( )

inlinestatic

Returns the max. kWp per unit, or -1.0 if it is not set.

◆ get_exp_pv_max_kWp_roof_sec()

static float Global::get_exp_pv_max_kWp_roof_sec ( )

inlinestatic

Returns the max. kWp per roof section, or -1.0 if it is not set.

◆ get_exp_pv_max_kWp_total()

static float Global::get_exp_pv_max_kWp_total ( )

inlinestatic

Returns the max. kWp for all expanded units, or -1.0 if it is not set.

◆ get_exp_pv_min_kWp_roof_sec()

static float Global::get_exp_pv_min_kWp_roof_sec ( )

inlinestatic

Returns the min. kWp per roof section - smaller sections will be ignored, defaults to 0.0.

◆ get_exp_pv_sizing_mode()

static global::PVSizingMode Global::get_exp_pv_sizing_mode ( )

inlinestatic

◆ get_exp_pv_static_profile_idx()

static int Global::get_exp_pv_static_profile_idx ( )

inlinestatic

◆ get_exp_pv_static_profile_orientation()

static const std::string & Global::get_exp_pv_static_profile_orientation ( )

inlinestatic

◆ get_expansion_scenario_id()

static unsigned long Global::get_expansion_scenario_id ( )

inlinestatic

◆ get_feed_in_tariff()

static float Global::get_feed_in_tariff ( )

inlinestatic

◆ get_first_timestep()

static unsigned long Global::get_first_timestep ( )

inlinestatic

Returns the first timestep (starting at 1) in the simulation range.

◆ get_heat_cons_bobv_intercept()

static float Global::get_heat_cons_bobv_intercept ( )

inlinestatic

Parameter of linear regression (intercept) for estimating annual heat consumption based on the building volume (bobv)

◆ get_heat_cons_bobv_slope()

static float Global::get_heat_cons_bobv_slope ( )

inlinestatic

Parameter of linear regression (slope) for estimating annual heat consumption based on the building volume (bobv)

◆ get_heat_demand_thermalE_to_hpE_conv_f()

static float Global::get_heat_demand_thermalE_to_hpE_conv_f ( )

inlinestatic

◆ get_hp_flexibility_in_ts()

static unsigned int Global::get_hp_flexibility_in_ts ( )

inlinestatic

Returns the flexibility of the heat pump profiles in time steps.

◆ get_input_path()

static const std::string & Global::get_input_path ( )

inlinestatic

◆ get_inst_cost_BS_per_kWh()

static float Global::get_inst_cost_BS_per_kWh ( )

inlinestatic

◆ get_inst_cost_CS_per_unit()

static float Global::get_inst_cost_CS_per_unit ( )

inlinestatic

◆ get_inst_cost_HP_per_kW()

static float Global::get_inst_cost_HP_per_kW ( )

inlinestatic

◆ get_inst_cost_PV_per_kWp()

static float Global::get_inst_cost_PV_per_kWp ( )

inlinestatic

!< Returns the mean emissions in g CO2eq for one kWh of grid demanded energy. If a time series is available, use the latter one!

◆ get_last_timestep()

static unsigned long Global::get_last_timestep ( )

inlinestatic

Returns the last (inclusive) timestep (starting at 1) in the simulation range.

◆ get_max_parallel_opti_vars()

static unsigned long Global::get_max_parallel_opti_vars ( )

inlinestatic

Returns the number of maximum parallel optimization variables, or 0, if not set.

◆ get_n_CUs()

static unsigned long Global::get_n_CUs ( )

inlinestatic

◆ get_n_heatpump_profiles()

static unsigned long Global::get_n_heatpump_profiles ( )

inlinestatic

◆ get_n_MUs()

static unsigned long Global::get_n_MUs ( )

inlinestatic

◆ get_n_pv_profiles()

static unsigned long Global::get_n_pv_profiles ( )

inlinestatic

◆ get_n_repetitions()

static uint Global::get_n_repetitions ( )

inlinestatic

◆ get_n_substations()

static unsigned long Global::get_n_substations ( )

inlinestatic

◆ get_n_threads()

static uint Global::get_n_threads ( )

inlinestatic

◆ get_n_timesteps()

static unsigned long Global::get_n_timesteps ( )

inlinestatic

◆ get_npv_discount_rate()

static float Global::get_npv_discount_rate ( )

inlinestatic

◆ get_npv_factor_if_const()

static double Global::get_npv_factor_if_const ( )

inlinestatic

Returns the factor for multiplication in the NPV formula for the discounted revenues if the cashflow is constant.

◆ get_npv_time_horizon()

static unsigned int Global::get_npv_time_horizon ( )

inlinestatic

◆ get_open_space_pv_kWp()

static float Global::get_open_space_pv_kWp ( )

inlinestatic

◆ get_output_mode_per_cu()

static global::OutputModePerCU Global::get_output_mode_per_cu ( )

inlinestatic

◆ get_output_path()

static const std::string & Global::get_output_path ( )

inlinestatic

◆ get_parameter_varID()

static int Global::get_parameter_varID ( )

inlinestatic

◆ get_repetitions_selected()

static bool Global::get_repetitions_selected ( )

inlinestatic

◆ get_seed()

static unsigned int Global::get_seed ( )

inlinestatic

◆ get_select_buildings_wg_heatd_only()

static bool Global::get_select_buildings_wg_heatd_only ( )

inlinestatic

True, if only buildings are to be selected for the simulated addition for which an exact specified heat demand is given in the input data - Defaults to false.

◆ get_select_only_residential_buildings()

static bool Global::get_select_only_residential_buildings ( )

inlinestatic

Should only be residential buildings be considered for simulated component addition (SAC planning)?

◆ get_stop_on_cc_err()

static bool Global::get_stop_on_cc_err ( )

inlinestatic

Stores the value of command line option 'stop_on_cc_err'. True, if the simulation execution should be stopped on if an computation error occurs inside an optimization-based controller in any control unit.

◆ get_structure_database_name()

static const std::string & Global::get_structure_database_name ( )

inlinestatic

◆ get_time_step_size_in_h()

static float Global::get_time_step_size_in_h ( )

inlinestatic

◆ get_ts_end_tm()

static struct tm * Global::get_ts_end_tm ( )

inlinestatic

◆ get_ts_start_tm()

static struct tm * Global::get_ts_start_tm ( )

inlinestatic

◆ get_tsteps_per_hour()

static unsigned int Global::get_tsteps_per_hour ( )

inlinestatic

◆ get_use_emission_time_series_ia()

static bool Global::get_use_emission_time_series_ia ( )

inlinestatic

Return weather the emission time series (if it is available in the data) should be used or not.

◆ get_use_prices_time_series_ia()

static bool Global::get_use_prices_time_series_ia ( )

inlinestatic

Return weather the electricity prices time series (if it is available in the data) should be used or not.

◆ get_wind_kWp()

static float Global::get_wind_kWp ( )

inlinestatic

◆ get_work_stealing()

static bool Global::get_work_stealing ( )

inlinestatic

True, if work stealing is selected between the running worker threads.

◆ increment_seed()

void Global::increment_seed ( )

static

Thus class method increments the current seed at anytime during the simulation, no lock is applied to this function.

◆ InitializeStaticVariables()

void Global::InitializeStaticVariables ( )

static

◆ is_exp_ev_max_n_addition_set()

static bool Global::is_exp_ev_max_n_addition_set ( )

inlinestatic

Returns true iif a upper limit for the number of added EVs is set. The concrete value would be given by Global::get_exp_ev_max_n_addition().

◆ is_exp_hp_max_n_addition_set()

static bool Global::is_exp_hp_max_n_addition_set ( )

inlinestatic

Returns true iif a upper limit for the number of added heat pumps is set. The concrete value would be given by Global::get_exp_hp_max_n_addition().

◆ is_parameter_variation()

static bool Global::is_parameter_variation ( )

inlinestatic

◆ is_seed_set()

static bool Global::is_seed_set ( )

inlinestatic

◆ LockAllVariables()

void Global::LockAllVariables ( )

static

No (set) variable can be overwritten after this call, unset variables can still be set / overwritten once.

◆ PrintUninitializedVariables()

void Global::PrintUninitializedVariables ( )

static

Prints all variable names to stdout, that are not initialized.

◆ set_annual_heat_demand_limit_fsac()

void Global::set_annual_heat_demand_limit_fsac ( float value )

static

◆ set_battery_capacity_computation_mode()

void Global::set_battery_capacity_computation_mode ( global::BatteryCapacityComputationMode mode )

static

◆ set_battery_power_computation_mode()

void Global::set_battery_power_computation_mode ( global::BatteryPowerComputationMode mode )

static

◆ set_break_sac_loop_if_limit_reached()

void Global::set_break_sac_loop_if_limit_reached ( bool value )

static

◆ set_cache_dir_path()

void Global::set_cache_dir_path ( const std::string * path )

static

◆ set_compute_weekly_metrics()

void Global::set_compute_weekly_metrics ( bool mode )

static

◆ set_control_horizon_in_ts()

void Global::set_control_horizon_in_ts ( unsigned int value )

static

◆ set_control_update_freq_in_ts()

void Global::set_control_update_freq_in_ts ( unsigned int value )

static

◆ set_controller_bs_grid_charging_mode()

void Global::set_controller_bs_grid_charging_mode ( global::ControllerBSGridChargingMode mode )

static

◆ set_controller_mode()

void Global::set_controller_mode ( global::ControllerMode mode )

static

◆ set_controller_optimization_target()

void Global::set_controller_optimization_target ( global::ControllerOptimizationTarget mode )

static

◆ set_create_control_cmd_output()

void Global::set_create_control_cmd_output ( bool value )

static

◆ set_create_ev_detailed_output()

void Global::set_create_ev_detailed_output ( bool value )

static

◆ set_create_substation_output()

void Global::set_create_substation_output ( bool value )

static

◆ set_cs_max_charging_power_kW()

void Global::set_cs_max_charging_power_kW ( float value )

static

◆ set_cu_list_for_sac_planning()

void Global::set_cu_list_for_sac_planning ( const std::set< unsigned long > * selected_cuIDs )

static

◆ set_cu_selection_mode_fca()

void Global::set_cu_selection_mode_fca ( global::CUSModeFCA mode )

static

◆ set_demand_tariff()

void Global::set_demand_tariff ( float value )

static

◆ set_emissions_g_CO2eq_per_kWh()

void Global::set_emissions_g_CO2eq_per_kWh ( float value )

static

◆ set_ev_battery_size_kWh()

void Global::set_ev_battery_size_kWh ( float value )

static

◆ set_ev_consumption_kWh_km()

void Global::set_ev_consumption_kWh_km ( float value )

static

◆ set_ev_data_path()

void Global::set_ev_data_path ( std::string * path )

static

◆ set_ev_max_charging_power_kW()

void Global::set_ev_max_charging_power_kW ( float value )

static

◆ set_ev_plugin_probability()

void Global::set_ev_plugin_probability ( float value )

static

◆ set_exp_bess_E_P_ratio()

void Global::set_exp_bess_E_P_ratio ( float value )

static

◆ set_exp_bess_effi_in()

void Global::set_exp_bess_effi_in ( float value )

static

◆ set_exp_bess_effi_out()

void Global::set_exp_bess_effi_out ( float value )

static

◆ set_exp_bess_kW()

void Global::set_exp_bess_kW ( float exp_bess_kW )

static

◆ set_exp_bess_kWh()

void Global::set_exp_bess_kWh ( float exp_bess_kWh )

static

◆ set_exp_bess_max_capacity()

void Global::set_exp_bess_max_capacity ( float value )

static

◆ set_exp_bess_max_E_total()

void Global::set_exp_bess_max_E_total ( float value )

static

◆ set_exp_bess_max_P_total()

void Global::set_exp_bess_max_P_total ( float value )

static

◆ set_exp_bess_P_for_SOC_0()

void Global::set_exp_bess_P_for_SOC_0 ( float value )

static

◆ set_exp_bess_P_for_SOC_1()

void Global::set_exp_bess_P_for_SOC_1 ( float value )

static

◆ set_exp_bess_self_ds_ts()

void Global::set_exp_bess_self_ds_ts ( float value )

static

◆ set_exp_bess_sizingE_boPV()

void Global::set_exp_bess_sizingE_boPV ( float value )

static

◆ set_exp_bess_start_soc()

void Global::set_exp_bess_start_soc ( float exp_bess_start_soc )

static

◆ set_exp_cs_max_ev_per_cs()

void Global::set_exp_cs_max_ev_per_cs ( unsigned long value )

static

◆ set_exp_ev_max_n_addition()

void Global::set_exp_ev_max_n_addition ( unsigned long value )

static

◆ set_exp_hp_max_n_addition()

void Global::set_exp_hp_max_n_addition ( unsigned long value )

static

◆ set_exp_profile_mode()

void Global::set_exp_profile_mode ( global::ExpansionProfileAllocationMode mode )

static

◆ set_exp_pv_kWp_per_m2()

void Global::set_exp_pv_kWp_per_m2 ( float value )

static

◆ set_exp_pv_kWp_static()

void Global::set_exp_pv_kWp_static ( float value )

static

◆ set_exp_pv_max_kWp_per_unit()

void Global::set_exp_pv_max_kWp_per_unit ( float value )

static

◆ set_exp_pv_max_kWp_roof_sec()

void Global::set_exp_pv_max_kWp_roof_sec ( float value )

static

◆ set_exp_pv_max_kWp_total()

void Global::set_exp_pv_max_kWp_total ( float value )

static

◆ set_exp_pv_min_kWp_roof_sec()

void Global::set_exp_pv_min_kWp_roof_sec ( float value )

static

◆ set_exp_pv_sizing_mode()

void Global::set_exp_pv_sizing_mode ( global::PVSizingMode mode )

static

◆ set_exp_pv_static_profile_idx()

void Global::set_exp_pv_static_profile_idx ( int value )

static

◆ set_exp_pv_static_profile_orientation()

void Global::set_exp_pv_static_profile_orientation ( std::string * value )

static

◆ set_expansion_scenario_id()

void Global::set_expansion_scenario_id ( unsigned long expansion_scenario_id )

static

◆ set_feed_in_tariff()

void Global::set_feed_in_tariff ( float value )

static

◆ set_first_timestep()

void Global::set_first_timestep ( unsigned long ts )

static

◆ set_heat_cons_bobv_intercept()

void Global::set_heat_cons_bobv_intercept ( float value )

static

◆ set_heat_cons_bobv_slope()

void Global::set_heat_cons_bobv_slope ( float value )

static

◆ set_heat_demand_thermalE_to_hpE_conv_f()

void Global::set_heat_demand_thermalE_to_hpE_conv_f ( float value )

static

◆ set_hp_flexibility_in_ts()

void Global::set_hp_flexibility_in_ts ( unsigned int value )

static

◆ set_input_path()

void Global::set_input_path ( std::string * path )

static

◆ set_inst_cost_BS_per_kWh()

void Global::set_inst_cost_BS_per_kWh ( float value )

static

◆ set_inst_cost_CS_per_unit()

void Global::set_inst_cost_CS_per_unit ( float value )

static

◆ set_inst_cost_HP_per_kW()

void Global::set_inst_cost_HP_per_kW ( float value )

static

◆ set_inst_cost_PV_per_kWp()

void Global::set_inst_cost_PV_per_kWp ( float value )

static

◆ set_last_timestep()

void Global::set_last_timestep ( unsigned long ts )

static

◆ set_max_parallel_opti_vars()

void Global::set_max_parallel_opti_vars ( unsigned long value )

static

◆ set_n_CUs()

void Global::set_n_CUs ( unsigned long n_CUs )

static

◆ set_n_heatpump_profiles()

void Global::set_n_heatpump_profiles ( unsigned long n_hp_ts )

static

◆ set_n_MUs()

void Global::set_n_MUs ( unsigned long n_MUs )

static

◆ set_n_pv_profiles()

void Global::set_n_pv_profiles ( unsigned long n_pv_ts )

static

◆ set_n_repetitions()

void Global::set_n_repetitions ( unsigned int value )

static

◆ set_n_substations()

void Global::set_n_substations ( unsigned long n_substations )

static

◆ set_n_threads()

void Global::set_n_threads ( unsigned int value )

static

◆ set_n_timesteps()

void Global::set_n_timesteps ( unsigned long n_timesteps )

static

◆ set_npv_discount_rate()

void Global::set_npv_discount_rate ( float value )

static

◆ set_npv_time_horizon()

void Global::set_npv_time_horizon ( unsigned int value )

static

◆ set_open_space_pv_kWp()

void Global::set_open_space_pv_kWp ( float open_space_kWp )

static

◆ set_output_mode_per_cu()

void Global::set_output_mode_per_cu ( global::OutputModePerCU mode )

static

◆ set_output_path()

void Global::set_output_path ( std::string * path )

static

◆ set_pvar_vals()

void Global::set_pvar_vals	(	bool	pvar_set,
		int	pvarID
	)

static

◆ set_repetitions_selected()

void Global::set_repetitions_selected ( bool value )

static

◆ set_seed()

void Global::set_seed ( unsigned int value )

static

◆ set_select_buildings_wg_heatd_only()

void Global::set_select_buildings_wg_heatd_only ( bool value )

static

◆ set_select_only_residential_buildings()

void Global::set_select_only_residential_buildings ( bool value )

static

◆ set_stop_on_cc_err()

void Global::set_stop_on_cc_err ( bool value )

static

◆ set_structure_database_name()

void Global::set_structure_database_name ( std::string * fname )

static

◆ set_ts_end_tm()

void Global::set_ts_end_tm ( struct tm * ts_end_tm )

static

◆ set_ts_start_tm()

void Global::set_ts_start_tm ( struct tm * ts_start_tm )

static

◆ set_tsteps_per_hour()

void Global::set_tsteps_per_hour ( int tsteps_per_hour )

static

◆ set_use_emission_time_series_ia()

void Global::set_use_emission_time_series_ia ( bool use )

static

◆ set_use_prices_time_series_ia()

void Global::set_use_prices_time_series_ia ( bool use )

static

◆ set_wind_kWp()

void Global::set_wind_kWp ( float wind_kWp )

static

◆ set_work_stealing()

void Global::set_work_stealing ( bool value )

static

◆ UnlockAllVariables()

void Global::UnlockAllVariables ( )

static

All variables can now be overwritten.

The documentation for this class was generated from the following files:

Static Public Member Functions

Member Function Documentation

◆ AllVariablesInitialized()

◆ CheckTimeRelatedVariablesInitState()

◆ DeleteStaticVariables()

◆ get_annual_heat_demand_limit_fsac()

◆ get_annuity_factor()

◆ get_battery_capacity_computation_mode()

◆ get_battery_power_computation_mode()

◆ get_break_sac_loop_if_limit_reached()

◆ get_cache_dir_path()

◆ get_compute_weekly_metrics()

◆ get_control_horizon_in_ts()

◆ get_control_update_freq_in_ts()

◆ get_controller_bs_grid_charging_mode()

◆ get_controller_mode()

◆ get_controller_optimization_target()

◆ get_create_control_cmd_output()

◆ get_create_ev_detailed_output()

◆ get_create_substation_output()

◆ get_cs_max_charging_power_kW()

◆ get_cu_list_for_sac_planning()

◆ get_cu_selection_mode_fca()

◆ get_demand_tariff()

◆ get_emissions_g_CO2eq_per_kWh()

◆ get_ev_battery_size_kWh()

◆ get_ev_consumption_kWh_km()

◆ get_ev_data_path()

◆ get_ev_max_charging_power_kW()

◆ get_ev_plugin_probability()

◆ get_exp_bess_E_P_ratio()

◆ get_exp_bess_effi_in()

◆ get_exp_bess_effi_out()

◆ get_exp_bess_kW()

◆ get_exp_bess_kWh()

◆ get_exp_bess_max_capacity()

◆ get_exp_bess_max_E_total()

◆ get_exp_bess_max_P_total()

◆ get_exp_bess_P_for_SOC_0()

◆ get_exp_bess_P_for_SOC_1()

◆ get_exp_bess_self_ds_ts()

◆ get_exp_bess_sizingE_boPV()

◆ get_exp_bess_start_soc()

◆ get_exp_cs_max_ev_per_cs()

◆ get_exp_ev_max_n_addition()

◆ get_exp_hp_max_n_addition()

◆ get_exp_profile_mode()

◆ get_exp_pv_kWp_per_m2()

◆ get_exp_pv_kWp_static()

◆ get_exp_pv_max_kWp_per_unit()

◆ get_exp_pv_max_kWp_roof_sec()

◆ get_exp_pv_max_kWp_total()

◆ get_exp_pv_min_kWp_roof_sec()

◆ get_exp_pv_sizing_mode()

◆ get_exp_pv_static_profile_idx()

◆ get_exp_pv_static_profile_orientation()

◆ get_expansion_scenario_id()

◆ get_feed_in_tariff()

◆ get_first_timestep()

◆ get_heat_cons_bobv_intercept()

◆ get_heat_cons_bobv_slope()

◆ get_heat_demand_thermalE_to_hpE_conv_f()

◆ get_hp_flexibility_in_ts()

◆ get_input_path()

◆ get_inst_cost_BS_per_kWh()

◆ get_inst_cost_CS_per_unit()

◆ get_inst_cost_HP_per_kW()

◆ get_inst_cost_PV_per_kWp()

◆ get_last_timestep()

◆ get_max_parallel_opti_vars()

◆ get_n_CUs()

◆ get_n_heatpump_profiles()

◆ get_n_MUs()

◆ get_n_pv_profiles()

◆ get_n_repetitions()

◆ get_n_substations()

◆ get_n_threads()

◆ get_n_timesteps()

◆ get_npv_discount_rate()

◆ get_npv_factor_if_const()