Last data update: 2014.03.03

R: Check Linear Atmosphere
CheckAtm.linR Documentation

Check Linear Atmosphere

Description

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

Usage

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

# 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)

Results


R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.

R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.

Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.

> library(AtmRay)
> png(filename="/home/ddbj/snapshot/RGM3/R_CC/result/AtmRay/CheckAtm.lin.Rd_%03d_medium.png", width=480, height=480)
> ### Name: CheckAtm.lin
> ### Title: Check Linear Atmosphere
> ### Aliases: CheckAtm.lin
> ### Keywords: misc
> 
> ### ** Examples
> 
> # 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)
> 
> 
> 
> 
> 
> 
> dev.off()
null device 
          1 
>