Atmosphere
Represents the physical surroundings of a Gaussian Plume
Static Method Summary
| Static Public Methods | ||
| public static |
calculateGrade(skyCover: number, solarElevation: number, windSpeed: number, isNight: boolean): number Calculates a grade with given parameters |
|
Constructor Summary
| Public Constructor | ||
| public |
constructor(windSpeed: Array | number, skyCover: number, solarElevation: number, temperature: number, pressure: number, setting: string, isNight: boolean) Only windSpeed, _skyCover, and _solarElevation are required. |
|
Member Summary
| Public Members | ||
| public get |
|
|
| public get |
|
|
| public get |
letterGrade: string: * The Human readable |
|
| public get |
|
|
| public get |
|
|
| public get |
|
|
| public get |
solarElevation: number: * |
|
| public get |
temperature: number | *: * |
|
| public get |
|
|
| public get |
windSpeedVec: Vector | *: * |
|
Method Summary
| Public Methods | ||
| public |
getWindSpeedAt(height: number): number Adjusts wind speed to a specific height. |
|
| public |
setIsNight(isNight: boolean): Atmosphere |
|
| public |
setPressure(pressure: *): Atmosphere |
|
| public |
setSetting(setting: string): Atmosphere |
|
| public |
setSkyCover(cover: number): Atmosphere The percentage of the sky is covered |
|
| public |
setSolarElevation(elevation: number): Atmosphere |
|
| public |
setTemperature(temp: number): Atmosphere |
|
| public |
setWindSpeed(speed: *): Atmosphere |
|
| public |
|
|
Static Public Methods
Public Constructors
public constructor(windSpeed: Array | number, skyCover: number, solarElevation: number, temperature: number, pressure: number, setting: string, isNight: boolean) source
Only windSpeed, _skyCover, and _solarElevation are required. Temperature is required when not _setting effective source height manually The default is urban daytime.
Params:
| Name | Type | Attribute | Description |
| windSpeed | Array | number | at ground level (m/s) |
|
| skyCover | number | a percentage 0-1 |
|
| solarElevation | number | (degrees) |
|
| temperature | number | (Kelvin) |
|
| pressure | number | (atm) |
|
| setting | string |
|
|
| isNight | boolean |
|
Can change this to a Date, but should be simple enough to keep track of for the user 1 hour before sunset and 1 hour past sunrise |
Public Members
Public Methods
public getWindSpeedAt(height: number): number source
Adjusts wind speed to a specific height. Approximation.
Params:
| Name | Type | Attribute | Description |
| height | number | m |
public setIsNight(isNight: boolean): Atmosphere source
Params:
| Name | Type | Attribute | Description |
| isNight | boolean |
public setPressure(pressure: *): Atmosphere source
Params:
| Name | Type | Attribute | Description |
| pressure | * |
public setSetting(setting: string): Atmosphere source
Params:
| Name | Type | Attribute | Description |
| setting | string | Either "rural" or "urban" |
public setSkyCover(cover: number): Atmosphere source
The percentage of the sky is covered
Params:
| Name | Type | Attribute | Description |
| cover | number | 0 - 1 |
public setSolarElevation(elevation: number): Atmosphere source
Params:
| Name | Type | Attribute | Description |
| elevation | number | degrees |
public setTemperature(temp: number): Atmosphere source
Params:
| Name | Type | Attribute | Description |
| temp | number | Kelvin |
public setWindSpeed(speed: *): Atmosphere source
Params:
| Name | Type | Attribute | Description |
| speed | * | {number[]|number} m/s |