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

#include <components.h>

Inheritance diagram for ComponentPV:
Inheritance graph

Public Member Functions

 ComponentPV (float kWp_static, unsigned long locationID)
 Constructor in the case of static kWp computation.
 
 ComponentPV (float kWp_per_m2, float min_kWp_sec, float max_kWp_sec, float max_kWp_unit, unsigned long locationID)
 Constructor in the case of dynamic kWp computation. If max_kWp is set to a value <= 0, it will be ignored.
 
double get_kWp () const
 Returns the total peak power, summed over all sections. See also ComponentPV::get_kWp_per_section().
 
float get_currentGeneration_kW () const
 
double get_cweek_generation_kWh ()
 Returns the produced energy in kWh from the start of the current week until the current time step.
 
double get_total_generation_kWh ()
 Returns the total produced energy in kWh from the start of the simulation run until the current time step.
 
float get_generation_at_ts_kW (unsigned long ts) const
 Returns the generation at a given time step in kW. If there is no data available for this time step, 0.0 is returned.
 
std::string * get_section_string (const std::string &prefix_per_line)
 Returns a string listing information about all existing, simulated roof sections - one line per section.
 
const std::vector< double > * get_future_generation_kW () const
 
std::list< std::vector< double > > get_total_generation_by_section_kW () const
 
std::list< double > get_kWp_per_section () const
 
void calculateCurrentFeedin (unsigned long ts)
 
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.
 
void set_horizon_in_ts (unsigned int new_horizon)
 Sets another horizon for the number of time steps returned by ComponentPV::get_future_generation_kW()
 
void set_kWp_per_section (const std::list< double > &new_values)
 
- Public Member Functions inherited from BaseComponent
virtual ~BaseComponent ()
 

Constructor & Destructor Documentation

◆ ComponentPV() [1/2]

ComponentPV::ComponentPV ( float  kWp_static,
unsigned long  locationID 
)

Constructor in the case of static kWp computation.

◆ ComponentPV() [2/2]

ComponentPV::ComponentPV ( float  kWp_per_m2,
float  min_kWp_sec,
float  max_kWp_sec,
float  max_kWp_unit,
unsigned long  locationID 
)

Constructor in the case of dynamic kWp computation. If max_kWp is set to a value <= 0, it will be ignored.

Member Function Documentation

◆ calculateCurrentFeedin()

void ComponentPV::calculateCurrentFeedin ( unsigned long  ts)

◆ get_currentGeneration_kW()

float ComponentPV::get_currentGeneration_kW ( ) const
inline

◆ get_cweek_generation_kWh()

double ComponentPV::get_cweek_generation_kWh ( )
inline

Returns the produced energy in kWh from the start of the current week until the current time step.

◆ get_future_generation_kW()

const std::vector< double > * ComponentPV::get_future_generation_kW ( ) const
inline

Returns the future electricity generation power for the future time steps over the complete (control) time horizon. Attention: The object the returned pointer referes to is overwritten on subsequent calls! Do NOT delete the returned object.

Returns
: Returns a vector storing future generation in kW per future time step - READ THE ATTENTION NOTICE

◆ get_generation_at_ts_kW()

float ComponentPV::get_generation_at_ts_kW ( unsigned long  ts) const

Returns the generation at a given time step in kW. If there is no data available for this time step, 0.0 is returned.

◆ get_kWp()

double ComponentPV::get_kWp ( ) const
inline

Returns the total peak power, summed over all sections. See also ComponentPV::get_kWp_per_section().

◆ get_kWp_per_section()

std::list< double > ComponentPV::get_kWp_per_section ( ) const

Computes and returns the installed power in kWp per section (not in total). See also ComponentPV::get_kWp().

Returns
: A list of kWp per orientation with the same ordering as the internal variable ComponentPV::roof_sections.

◆ get_section_string()

string * ComponentPV::get_section_string ( const std::string &  prefix_per_line)

Returns a string listing information about all existing, simulated roof sections - one line per section.

◆ get_total_generation_by_section_kW()

std::list< std::vector< double > > ComponentPV::get_total_generation_by_section_kW ( ) const

Computes and returns the total electricity generation for the future, starting at time step 0 and ending with the final time step of the simulation.

Returns
: A list of orientations, containing the vector with the length of the full simulation horizon - with the same ordering as the internal variable ComponentPV::roof_sections.

◆ get_total_generation_kWh()

double ComponentPV::get_total_generation_kWh ( )
inline

Returns the total produced energy in kWh from the start of the simulation run until the current time step.

◆ resetInternalState()

void ComponentPV::resetInternalState ( )
virtual

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

Implements BaseComponent.

◆ resetWeeklyCounter()

void ComponentPV::resetWeeklyCounter ( )
virtual

Resets the internal, weekly counters.

Implements BaseComponent.

◆ set_horizon_in_ts()

void ComponentPV::set_horizon_in_ts ( unsigned int  new_horizon)

Sets another horizon for the number of time steps returned by ComponentPV::get_future_generation_kW()

◆ set_kWp_per_section()

void ComponentPV::set_kWp_per_section ( const std::list< double > &  new_values)

This method updates the PV size per section, according to the given list. The order must be the ssame as it is in the internal variable roof_sections.


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