Skip to content

Commit

Permalink
update docs about unit of pm and pn
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexander-Barth committed Jan 23, 2023
1 parent 9cc4f2d commit 232c039
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions src/domain.jl
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,8 @@ end
mask,(pm,pn),(xi,yi) = DIVAnd.domain(bathname,bathisglobal,lonr,latr)
Generate a 2D geospatial domain based on the topography from the netCDF file
`bathname`.
`bathname`. `lonr` and `latr` are expressed in degrees East and North
respectively (as are `xi` and `yi`). `pm` and `pn` are in m⁻¹.
"""
function domain(bathname, bathisglobal, lonr, latr)
mask, (pm, pn), (xi, yi) = DIVAnd.DIVAnd_rectdom(lonr, latr)
Expand All @@ -86,12 +87,16 @@ function domain(bathname, bathisglobal, lonr, latr)
end

"""
mask,(pm,pn,po),(xi,yi,zi) = DIVAnd.domain(bathname,bathisglobal,lonr,latr,depthr)
mask,(pm,pn,po),(xi,yi,zi) = DIVAnd.domain(bathname,bathisglobal,lonr,latr,depthr; zlevel = :surface)
Generate a 3D geospatial domain based on the topography from the netCDF file
`bathname`. If `zlevel` is `:surface`, then `depthr` is zero for the sea surface and
positive in water (positive is down). If `zlevel` is `:floor`, then `depthr` is
zero for the sea floor and positive in water (positive is up)
zero for the sea floor and positive in water (positive is up).
`lonr` and `latr` are expressed in degrees East and North
respectively (as are `xi` and `yi`). `depthr` and `zi` are in meters and
`pm`, `pn` and `po` are in m⁻¹.
"""
function domain(bathname, bathisglobal, lonr, latr, depthr; zlevel = :surface)

Expand Down

0 comments on commit 232c039

Please sign in to comment.