import Atmosphere from 'dirtybomb/src/Dispersion/Atmosphere.js'

public class | source

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, setting: string, isNight: boolean) Only windSpeed, skyCover, and solarElevation are required.

Member Summary

Public Members
public	setting: string
public	skyCover: number
public	solarElevation: number
public	temp: number
public	windSpeedVec: Vector

Method Summary

Public Methods
public	getGrade(): number
public	getLetterGrade(): string The Human readable
public	getSetting(): string
public	getSkyCover(): number
public	getSolarElevation(): number
public	getTemperature(): number \| *
public	getWindSpeed(): number
public	getWindSpeedAt(height: number): number Adjusts wind speed to a specific height.
public	getWindSpeedVec(): Vector \| *
public	isNight(): boolean \| *
public	setIsNight(isNight: boolean): 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	toString(): string

Static Public Methods

public static calculateGrade(skyCover: number, solarElevation: number, windSpeed: number, isNight: boolean): number source

Calculates a grade with given parameters

Params:

Name	Type	Attribute	Description
skyCover	number
solarElevation	number
windSpeed	number
isNight	boolean

Return:

number

0 - 6

Public Constructors

public constructor(windSpeed: array | number, skyCover: number, solarElevation: number, temperature: 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)
setting	string	optional default: "urban"
isNight	boolean	optional default: false	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 setting: string source

public skyCover: number source

public solarElevation: number source

public temp: number source

public windSpeedVec: Vector source

Public Methods

public getGrade(): number source

Return:

number

0-6

public getLetterGrade(): string source

The Human readable

Return:

string

A - F

public getSetting(): string source

Return:

string

public getSkyCover(): number source

Return:

number

public getSolarElevation(): number source

Return:

number

degrees

public getTemperature(): number | * source

Return:

number | *

Kelvin

public getWindSpeed(): number source

Return:

number

m/s

public getWindSpeedAt(height: number): number source

Adjusts wind speed to a specific height. Approximation.

Params:

Name	Type	Attribute	Description
height	number		m

Return:

number

The approx. wind speed at a specified height above the ground (m/s)

public getWindSpeedVec(): Vector | * source

Return:

Vector | *

public isNight(): boolean | * source

Return:

boolean | *

public setIsNight(isNight: boolean): Atmosphere source

Params:

Name	Type	Attribute	Description
isNight	boolean

Return:

Atmosphere

public setSetting(setting: string): Atmosphere source

Params:

Name	Type	Attribute	Description
setting	string		Either "rural" or "urban"

Return:

Atmosphere

public setSkyCover(cover: number): Atmosphere source

The percentage of the sky is covered

Params:

Name	Type	Attribute	Description
cover	number		0 - 1

Return:

Atmosphere

public setSolarElevation(elevation: number): Atmosphere source

Params:

Name	Type	Attribute	Description
elevation	number		degrees

Return:

Atmosphere

public setTemperature(temp: number): Atmosphere source

Params:

Name	Type	Attribute	Description
temp	number		Kelvin

Return:

Atmosphere

public setWindSpeed(speed: *): Atmosphere source

Params:

Name	Type	Attribute	Description
speed	*		{number[]\|number} m/s

Atmosphere

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Static Public Methods

public static calculateGrade(skyCover: number, solarElevation: number, windSpeed: number, isNight: boolean): number source

Params:

Return:

Public Constructors

public constructor(windSpeed: array | number, skyCover: number, solarElevation: number, temperature: number, setting: string, isNight: boolean) source

Params:

Public Members

public setting: string source

public skyCover: number source

public solarElevation: number source

public temp: number source

public windSpeedVec: Vector source

Public Methods

public getGrade(): number source

Return:

public getLetterGrade(): string source

Return:

public getSetting(): string source

Return:

public getSkyCover(): number source

Return:

public getSolarElevation(): number source

Return:

public getTemperature(): number | * source

Return:

public getWindSpeed(): number source

Return:

public getWindSpeedAt(height: number): number source

Params:

Return:

public getWindSpeedVec(): Vector | * source

Return:

public isNight(): boolean | * source

Return:

public setIsNight(isNight: boolean): Atmosphere source

Params:

Return:

public setSetting(setting: string): Atmosphere source

Params:

Return:

public setSkyCover(cover: number): Atmosphere source

Params:

Return:

public setSolarElevation(elevation: number): Atmosphere source

Params:

Return:

public setTemperature(temp: number): Atmosphere source

Params:

Return:

public setWindSpeed(speed: *): Atmosphere source

Params:

Return:

public toString(): string source

Return: