RadiationSource Struct Reference

Radiation source data object. More...

#include <RadiationModel.h>

Public Member Functions
	RadiationSource (const helios::vec3 &position)
	Constructor for collimated radiation source.
	RadiationSource (const helios::vec3 &position, float width)
	Constructor for spherical radiation source.
	RadiationSource (const helios::vec3 &position, float position_scaling_factor, float width, float flux_scaling_factor)
	Constructor for sun sphere radiation source.
	RadiationSource (const helios::vec3 &position, const helios::vec2 &size, const helios::vec3 &rotation)
	Constructor for rectangular radiation source.
	RadiationSource (const helios::vec3 &position, float width, const helios::vec3 &rotation)
	Constructor for disk radiation source.

Data Fields
helios::vec3	source_position
	Positions of radiation source.
float	source_position_scaling_factor
	Source position factors used to scale position in case of a sun sphere source.
std::vector< helios::vec2 >	source_spectrum
	Spectral distribution of radiation source. Each element of the vector is a wavelength band, where .x is the wavelength in nm and .y is the spectral flux in W/m^2/nm.
std::string	source_spectrum_label = "none"
uint64_t	source_spectrum_version = 0
	Cached version number of source spectrum for change detection.
helios::vec2	source_width
	Widths for each radiation source (N/A for collimated sources)
helios::vec3	source_rotation
	Rotation (rx,ry,rz) for radiation source (area sources only)
float	source_flux_scaling_factor
	Source flux factors used to scale flux in case of a sun sphere source.
RadiationSourceType	source_type
	Types of all radiation sources.
std::map< std::string, float >	source_fluxes
	Fluxes of radiation source for all bands.

Detailed Description

Radiation source data object.

Definition at line 558 of file RadiationModel.h.

Constructor & Destructor Documentation

RadiationSource() [1/5]

RadiationSource::RadiationSource ( const helios::vec3 &  position )

inlineexplicit

Constructor for collimated radiation source.

Definition at line 561 of file RadiationModel.h.

RadiationSource() [2/5]

RadiationSource::RadiationSource ( const helios::vec3 &  position, float  width  )

inline

Constructor for spherical radiation source.

Definition at line 570 of file RadiationModel.h.

RadiationSource() [3/5]

RadiationSource::RadiationSource ( const helios::vec3 &  position, float  position_scaling_factor, float  width, float  flux_scaling_factor  )

inline

Constructor for sun sphere radiation source.

Definition at line 581 of file RadiationModel.h.

RadiationSource() [4/5]

RadiationSource::RadiationSource ( const helios::vec3 &  position, const helios::vec2 &  size, const helios::vec3 &  rotation  )

inline

Constructor for rectangular radiation source.

Definition at line 589 of file RadiationModel.h.

RadiationSource() [5/5]

RadiationSource::RadiationSource ( const helios::vec3 &  position, float  width, const helios::vec3 &  rotation  )

inline

Constructor for disk radiation source.

Definition at line 598 of file RadiationModel.h.

Field Documentation

source_flux_scaling_factor

float RadiationSource::source_flux_scaling_factor

Source flux factors used to scale flux in case of a sun sphere source.

Definition at line 629 of file RadiationModel.h.

source_fluxes

std::map<std::string, float> RadiationSource::source_fluxes

Fluxes of radiation source for all bands.

Definition at line 635 of file RadiationModel.h.

source_position

helios::vec3 RadiationSource::source_position

Positions of radiation source.

Definition at line 609 of file RadiationModel.h.

source_position_scaling_factor

float RadiationSource::source_position_scaling_factor

Source position factors used to scale position in case of a sun sphere source.

Definition at line 612 of file RadiationModel.h.

source_rotation

helios::vec3 RadiationSource::source_rotation

Rotation (rx,ry,rz) for radiation source (area sources only)

Definition at line 626 of file RadiationModel.h.

source_spectrum

std::vector<helios::vec2> RadiationSource::source_spectrum

Spectral distribution of radiation source. Each element of the vector is a wavelength band, where .x is the wavelength in nm and .y is the spectral flux in W/m^2/nm.

Definition at line 615 of file RadiationModel.h.

source_spectrum_label

std::string RadiationSource::source_spectrum_label = "none"

Definition at line 617 of file RadiationModel.h.

source_spectrum_version

uint64_t RadiationSource::source_spectrum_version = 0

Cached version number of source spectrum for change detection.

Definition at line 620 of file RadiationModel.h.

source_type

RadiationSourceType RadiationSource::source_type

Types of all radiation sources.

Definition at line 632 of file RadiationModel.h.

source_width

helios::vec2 RadiationSource::source_width

Widths for each radiation source (N/A for collimated sources)

Definition at line 623 of file RadiationModel.h.

---

The documentation for this struct was generated from the following file:

• plugins/radiation/include/RadiationModel.h