#include <components.h>

Inheritance diagram for ComponentBS:

Public Member Functions
	ComponentBS (double maxE_kWh, double maxP_kW, double E_over_P_ratio, double discharge_rate_per_step, double efficiency_in, double efficiency_out, double initial_SoC)
	Default constructor if the battery should represent a large-scale or household-style battery system.

	ComponentBS (double maxE_kWh, double discharge_rate_per_step, double efficiency_in, double initial_SoC)
	Constructor to use if it is the battery of an EV.

double	get_SOC () const
	Returns the current state of charge of the battery.

double	get_SOE () const
	Returns the current amount of energy stored in the battery. Equivalent to ComponentBS::get_currentCharge_kWh().

double	get_currentCharge_kWh () const
	Returns the charge of the battery (i.e. how much kWh are stored inside). Equivalent to ComponentBS::get_SOE().

double	get_currentLoad_kW () const
	Returns the current load of the battery (from outside perspective). Positive values denotes battery charging, while negative values denote discharging.

double	get_gridOnly_discharge_kW () const
	Returns the amount of energy that is currently discharged, see ComponentBS::get_currentLoad_kW() if smaller 0.0, in kW that has been stored in the BS from the grid and not from surplus PV. With values from 0.0 to maxP.

double	get_maxE_kWh () const
	Returns the maximum available capacity of the battery. For the current state of energy / charge, see ComponentBS::get_SOC() and ComponentBS::get_SOE().

double	get_maxP_kW () const
	Returns the maximum available capacity of the battery. For the current power, see ComponentBS::get_currentLoad_kW().

double	get_current_EFC () const
	Returns the equivalent full cycles (EFC)

double	get_cweek_EFC () const
	Returns the equivalent full cycles (EFC) for the current week only.

unsigned long	get_n_ts_empty () const
	Returns the number of time steps where the battery is empty.

unsigned long	get_n_ts_full () const
	Returns the number of time steps where the battery is fully charged.

double	get_cweek_withdrawn_E_kWh () const
	Returns the total energy that is taken from the battery from the beginning of the current week until now.

double	get_total_withdrawn_E_kWh () const
	Returns the total energy that is taken from the battery from the beginning of the simulation run until now.

double	get_cweek_withdrawn_E_gridOnly_kWh () const
	Returns the total energy that is taken from the battery and that was initially charged from the grid (not PV!) from the beginning of the current week until now.

double	get_total_withdrawn_E_gridOnly_kWh () const
	Returns the total energy that is taken from the battery and that was initially charged from the grid (not PV!) from the beginning of the simulation run until now.

void	set_chargeRequest (double requested_charge_kW)

void	set_grid_charged_amount (double grid_charged_kW)
	Sets the amount that has been charged from the grid (and not from the PV) for the current step. Must be executed AFTER ComponentBS::calculateActions() has been called. This call is optional, but at maximum it must not be called more than once, before calculateActions() is called again!

void	set_maxE_kWh (double value)

void	set_maxP_kW (double value)

void	set_maxP_by_EPRatio (double EP_ratio)

void	calculateActions ()

void	resetWeeklyCounter ()
	Resets the internal, weekly counters.

void	resetInternalState ()
	Resets the internal simulation state (like counters), but retains the structural state like attached sub-components.

Public Member Functions inherited from BaseComponent
virtual	~BaseComponent ()

Protected Member Functions
void	set_SOE_without_computations (double new_SOE_kWh)
	Changes the current SOE without updating other internal variables! Should only be used by class EVFSM for the pre-computation!

Friends
class	EVFSM

Constructor & Destructor Documentation

◆ ComponentBS() [1/2]

ComponentBS::ComponentBS	(	double	maxE_kWh,
		double	maxP_kW,
		double	E_over_P_ratio,
		double	discharge_rate_per_step,
		double	efficiency_in,
		double	efficiency_out,
		double	initial_SoC
	)

Default constructor if the battery should represent a large-scale or household-style battery system.

◆ ComponentBS() [2/2]

ComponentBS::ComponentBS	(	double	maxE_kWh,
		double	discharge_rate_per_step,
		double	efficiency_in,
		double	initial_SoC
	)

Constructor to use if it is the battery of an EV.

Member Function Documentation

◆ calculateActions()

void ComponentBS::calculateActions ( )

◆ get_current_EFC()

double ComponentBS::get_current_EFC ( ) const

inline

Returns the equivalent full cycles (EFC)

◆ get_currentCharge_kWh()

double ComponentBS::get_currentCharge_kWh ( ) const

inline

Returns the charge of the battery (i.e. how much kWh are stored inside). Equivalent to ComponentBS::get_SOE().

◆ get_currentLoad_kW()

double ComponentBS::get_currentLoad_kW ( ) const

inline

Returns the current load of the battery (from outside perspective). Positive values denotes battery charging, while negative values denote discharging.

◆ get_cweek_EFC()

double ComponentBS::get_cweek_EFC ( ) const

inline

Returns the equivalent full cycles (EFC) for the current week only.

◆ get_cweek_withdrawn_E_gridOnly_kWh()

double ComponentBS::get_cweek_withdrawn_E_gridOnly_kWh ( ) const

inline

Returns the total energy that is taken from the battery and that was initially charged from the grid (not PV!) from the beginning of the current week until now.

◆ get_cweek_withdrawn_E_kWh()

double ComponentBS::get_cweek_withdrawn_E_kWh ( ) const

inline

Returns the total energy that is taken from the battery from the beginning of the current week until now.

◆ get_gridOnly_discharge_kW()

double ComponentBS::get_gridOnly_discharge_kW ( ) const

inline

Returns the amount of energy that is currently discharged, see ComponentBS::get_currentLoad_kW() if smaller 0.0, in kW that has been stored in the BS from the grid and not from surplus PV. With values from 0.0 to maxP.

◆ get_maxE_kWh()

double ComponentBS::get_maxE_kWh ( ) const

inline

Returns the maximum available capacity of the battery. For the current state of energy / charge, see ComponentBS::get_SOC() and ComponentBS::get_SOE().

◆ get_maxP_kW()

double ComponentBS::get_maxP_kW ( ) const

inline

Returns the maximum available capacity of the battery. For the current power, see ComponentBS::get_currentLoad_kW().

◆ get_n_ts_empty()

unsigned long ComponentBS::get_n_ts_empty ( ) const

inline

Returns the number of time steps where the battery is empty.

◆ get_n_ts_full()

unsigned long ComponentBS::get_n_ts_full ( ) const

inline

Returns the number of time steps where the battery is fully charged.

◆ get_SOC()

double ComponentBS::get_SOC ( ) const

inline

Returns the current state of charge of the battery.

◆ get_SOE()

double ComponentBS::get_SOE ( ) const

inline

Returns the current amount of energy stored in the battery. Equivalent to ComponentBS::get_currentCharge_kWh().

◆ get_total_withdrawn_E_gridOnly_kWh()

double ComponentBS::get_total_withdrawn_E_gridOnly_kWh ( ) const

inline

Returns the total energy that is taken from the battery and that was initially charged from the grid (not PV!) from the beginning of the simulation run until now.

◆ get_total_withdrawn_E_kWh()

double ComponentBS::get_total_withdrawn_E_kWh ( ) const

inline

Returns the total energy that is taken from the battery from the beginning of the simulation run until now.

◆ resetInternalState()

void ComponentBS::resetInternalState ( )

virtual

Resets the internal simulation state (like counters), but retains the structural state like attached sub-components.

Implements BaseComponent.

◆ resetWeeklyCounter()

void ComponentBS::resetWeeklyCounter ( )

virtual

Resets the internal, weekly counters.

Implements BaseComponent.

◆ set_chargeRequest()

void ComponentBS::set_chargeRequest ( double requested_charge_kW )

inline

◆ set_grid_charged_amount()

void ComponentBS::set_grid_charged_amount ( double grid_charged_kW )

Sets the amount that has been charged from the grid (and not from the PV) for the current step. Must be executed AFTER ComponentBS::calculateActions() has been called. This call is optional, but at maximum it must not be called more than once, before calculateActions() is called again!

◆ set_maxE_kWh()

void ComponentBS::set_maxE_kWh ( double value )

◆ set_maxP_by_EPRatio()

void ComponentBS::set_maxP_by_EPRatio ( double EP_ratio )

◆ set_maxP_kW()

void ComponentBS::set_maxP_kW ( double value )

◆ set_SOE_without_computations()

void ComponentBS::set_SOE_without_computations ( double new_SOE_kWh )

protected

Changes the current SOE without updating other internal variables! Should only be used by class EVFSM for the pre-computation!

Friends And Related Symbol Documentation

◆ EVFSM

friend class EVFSM

friend

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

Public Member Functions

Protected Member Functions

Friends

Constructor & Destructor Documentation

◆ ComponentBS() [1/2]

◆ ComponentBS() [2/2]

Member Function Documentation

◆ calculateActions()

◆ get_current_EFC()

◆ get_currentCharge_kWh()

◆ get_currentLoad_kW()

◆ get_cweek_EFC()

◆ get_cweek_withdrawn_E_gridOnly_kWh()

◆ get_cweek_withdrawn_E_kWh()

◆ get_gridOnly_discharge_kW()

◆ get_maxE_kWh()

◆ get_maxP_kW()

◆ get_n_ts_empty()

◆ get_n_ts_full()

◆ get_SOC()

◆ get_SOE()

◆ get_total_withdrawn_E_gridOnly_kWh()

◆ get_total_withdrawn_E_kWh()

◆ resetInternalState()

◆ resetWeeklyCounter()

◆ set_chargeRequest()

◆ set_grid_charged_amount()

◆ set_maxE_kWh()

◆ set_maxP_by_EPRatio()

◆ set_maxP_kW()

◆ set_SOE_without_computations()

Friends And Related Symbol Documentation

◆ EVFSM