CheckAtm.lin: Check Linear Atmosphere

Description Usage Arguments Details Value Author(s) Examples

View source: R/CheckAtm.lin.R

Description

Verifies that an atmosphere contains all required elements and fills in missing elements with default values.

Usage

1
CheckAtm.lin(ATM = list())

Arguments

ATM

List that may include characteristics of an atmosphere

Details

A linear atmosphere variable must contain the elements described in the "Value" section. Default values for these are as follows: z0: 0 c0: 330 wx0: 0 wy0: 0 rho0: 1.2929 * exp(-ATM$z0/6800) gc: -10^9 gwx: 0 gwy: 0 grho: -0.0001901058 * exp(-ATM$z0/6800)

Other functions may encounter problems when working with an effective sound speed gradient of zero.

Value

List including the following elements:

z0

Elevation of intercept layer (m)

c0

Intrinsic sound speed at intercept layer (m/s)

wx0

Zonal (east-west) wind at intercept layer (m/s)

wy0

Meridional (north-south) wind at intercept layer (m/s)

rho0

Density at intercept layer (kg/m^3)

gc

Vertical intrinsic sound speed gradient (1/s)

gwx

Vertical zonal wind gradient (1/s)

gwy

Vertical meridional wind gradient (1/s)

grho

Vertical density gradient (kg/m^4)

Author(s)

Jake Anderson

Examples

1
2
3
4
5
6
# quickly make a new default atmosphere
ATM = CheckAtm.lin()

# fill in missing values for an existing atmosphere
ATM = list(c0 = 343, gc = -0.006)
ATM = CheckAtm.lin(ATM)

AtmRay documentation built on May 2, 2019, 6:52 a.m.

Related to CheckAtm.lin in AtmRay...