Documentation of UrbanFireXDT
Documentation of UrbanFireXDT
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
ComponentHP Class Reference

#include <components.h>

Inheritance diagram for ComponentHP:
Inheritance graph

Public Member Functions

 ComponentHP (const ControlUnit *connected_unit, float annual_econs_kWh)
 
double get_currentDemand_kW () const
 
double get_total_consumption_kWh () const
 
double get_cweek_consumption_kWh () const
 
float get_rated_power_without_AUX () const
 
const std::vector< double > * get_future_max_power_kW () const
 
const std::vector< double > * get_future_min_power_kW () const
 
void set_horizon_in_ts (unsigned int new_horizon)
 
void computeNextInternalState (unsigned long ts)
 
void setDemandToProfileData (unsigned long ts)
 
bool setDemandToGivenValue (double new_demand_kW)
 
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.
 
virtual double get_currentDemand_kW () const=0
 
const std::vector< double > * get_future_max_consumption_kWh () const
 
const std::vector< double > * get_future_min_consumption_kWh () const
 
void set_horizon_in_ts (unsigned int new_horizon)
 
virtual void setDemandToProfileData (unsigned long ts)=0
 
virtual bool setDemandToGivenValue (double new_demand_kW)=0
 
- Public Member Functions inherited from BaseComponentSemiFlexible
 BaseComponentSemiFlexible ()
 
 ~BaseComponentSemiFlexible ()
 
const std::vector< double > * get_future_max_consumption_kWh () const
 
const std::vector< double > * get_future_min_consumption_kWh () const
 
void set_horizon_in_ts (unsigned int new_horizon)
 
- Public Member Functions inherited from BaseComponent
virtual ~BaseComponent ()
 

Static Public Member Functions

static void InitializeRandomGenerator ()
 
static void VacuumStaticVariables ()
 

Additional Inherited Members

- Protected Attributes inherited from BaseComponentSemiFlexible
std::vector< double > future_maxE_storage
 
std::vector< double > future_minE_storage
 

Constructor & Destructor Documentation

◆ ComponentHP()

ComponentHP::ComponentHP ( const ControlUnit connected_unit,
float  annual_econs_kWh 
)

Member Function Documentation

◆ computeNextInternalState()

void ComponentHP::computeNextInternalState ( unsigned long  ts)

Computes the internal state for the first / next time step with a given timestep ID as parameter.

◆ get_currentDemand_kW() [1/2]

double ComponentHP::get_currentDemand_kW ( ) const
inlinevirtual

◆ get_currentDemand_kW() [2/2]

virtual double BaseComponentSemiFlexible::get_currentDemand_kW ( ) const
virtual

◆ get_cweek_consumption_kWh()

double ComponentHP::get_cweek_consumption_kWh ( ) const
inline

Returns the total consumption from the beginning of the current week up to the latest executed step in kWh.

◆ get_future_max_consumption_kWh()

const std::vector< double > * BaseComponentSemiFlexible::get_future_max_consumption_kWh ( ) const
inline

Returns the maximum electricity consumption of a component for the next n time steps (given some flexibility). This means that the value at position 0 returns the maximum cummulated consumption AT THE END of the current time step. This method assumes to start in the current time step, i.e. the consumption up to the current time step is considered to be 0. The length of the resulting vector is set using BaseComponentSemiFlexible::set_horizon_in_ts(). Attention: The object the returned pointer referes to is overwritten on subsequent calls!

Returns
: Returns a pointer to a vector storing min/max demand per future time step - READ THE ATTENTION NOTICE

◆ get_future_max_power_kW()

const std::vector< double > * ComponentHP::get_future_max_power_kW ( ) const
inline

Returns the maximum power of this component for the next n time steps (given some flexibility). The length of the resulting vector is set using BaseComponentSemiFlexible::set_horizon_in_ts(). Attention: The object the returned pointer referes to is overwritten on subsequent calls!

Returns
: Returns a pointer to a vector storing min/max power per future time step - READ THE ATTENTION NOTICE

◆ get_future_min_consumption_kWh()

const std::vector< double > * BaseComponentSemiFlexible::get_future_min_consumption_kWh ( ) const
inline

Returns the minimum electricity consumption of a component for the next n time steps (given some flexibility). This means that the value at position 0 returns the minimum cummulated consumption AT THE END of the current time step. This method assumes to start in the current time step, i.e. the consumption up to the current time step is considered to be 0. The length of the resulting vector is set using BaseComponentSemiFlexible::set_horizon_in_ts(). Attention: The object the returned pointer referes to is overwritten on subsequent calls!

Returns
: Returns a pointer to a vector storing min/max demand per future time step - READ THE ATTENTION NOTICE

◆ get_future_min_power_kW()

const std::vector< double > * ComponentHP::get_future_min_power_kW ( ) const
inline

Returns the minimum power of this component for the next n time steps (given some flexibility). The length of the resulting vector is set using BaseComponentSemiFlexible::set_horizon_in_ts(). Attention: The object the returned pointer referes to is overwritten on subsequent calls!

Returns
: Returns a pointer to a vector storing min/max power per future time step - READ THE ATTENTION NOTICE

◆ get_rated_power_without_AUX()

float ComponentHP::get_rated_power_without_AUX ( ) const
inline

Returns the (simulated) rated power of the heat pump without the AUX heating.

◆ get_total_consumption_kWh()

double ComponentHP::get_total_consumption_kWh ( ) const
inline

Returns the total consumption from the beginning of the simulation up to the latest executed step in kWh.

◆ InitializeRandomGenerator()

void ComponentHP::InitializeRandomGenerator ( )
static

◆ resetInternalState()

void ComponentHP::resetInternalState ( )
virtual

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

Implements BaseComponent.

◆ resetWeeklyCounter()

void ComponentHP::resetWeeklyCounter ( )
virtual

Resets the internal, weekly counters.

Implements BaseComponent.

◆ set_horizon_in_ts() [1/2]

void BaseComponentSemiFlexible::set_horizon_in_ts ( unsigned int  new_horizon)

Sets another horizon for the number of time steps returned by BaseComponentSemiFlexible::get_future_min_max_demand()

◆ set_horizon_in_ts() [2/2]

void ComponentHP::set_horizon_in_ts ( unsigned int  new_horizon)

◆ setDemandToGivenValue() [1/2]

bool ComponentHP::setDemandToGivenValue ( double  new_demand_kW)
virtual

Changes the (shiftable) demand of the component for the current time step. It must be called before the current demand and total consumption values are set correctly. If this function is called, BaseComponentSemiFlexible::setDemandToProfileData() must not be called anymore.

Parameters
new_demand_kWThe new power for this time step in kW.
Returns
true if no error occured or false, if the upper or lower bound was violated

Implements BaseComponentSemiFlexible.

◆ setDemandToGivenValue() [2/2]

virtual bool BaseComponentSemiFlexible::setDemandToGivenValue ( double  new_demand_kW)
virtual

Changes the (shiftable) demand of the component for the current time step. It must be called before the current demand and total consumption values are set correctly. If this function is called, BaseComponentSemiFlexible::setDemandToProfileData() must not be called anymore.

Parameters
new_demand_kWThe new power for this time step in kW.
Returns
true if no error occured or false, if the upper or lower bound was violated

Implements BaseComponentSemiFlexible.

◆ setDemandToProfileData() [1/2]

void ComponentHP::setDemandToProfileData ( unsigned long  ts)
virtual

Sets the demand value to the value as given in the data. If this function is called, BaseComponentSemiFlexible::setDemandToGivenValues() must not be called anymore.

Implements BaseComponentSemiFlexible.

◆ setDemandToProfileData() [2/2]

virtual void BaseComponentSemiFlexible::setDemandToProfileData ( unsigned long  ts)
virtual

Sets the demand value to the value as given in the data. If this function is called, BaseComponentSemiFlexible::setDemandToGivenValues() must not be called anymore.

Implements BaseComponentSemiFlexible.

◆ VacuumStaticVariables()

void ComponentHP::VacuumStaticVariables ( )
static

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