Difference between revisions of "Variables"

From WikiROMS
Jump to navigationJump to search
Line 1: Line 1:
=='''A'''==
==<span class="alphabet">'''A'''</span>==


=='''B'''==
==<span class="alphabet">'''B'''</span>==


=='''C'''==
==<span class="alphabet">'''C'''</span>==


=='''D'''==
==<span class="alphabet">'''D'''</span>==


=='''E'''==
==<span class="alphabet">'''E'''</span>==


=='''F'''==
==<span class="alphabet">'''F'''</span>==


=='''G'''==
==<span class="alphabet">'''G'''</span>==


=='''H'''==
==<span class="alphabet">'''H'''</span>==


;<span id="Hz"></span>'''Hz'''  
;<span id="Hz"></span>'''Hz'''  
Line 19: Line 19:
:'''dimension =''' '''Hz'''(LBi:UBi,LBj:UBj,N)
:'''dimension =''' '''Hz'''(LBi:UBi,LBj:UBj,N)
:'''pointer =''' GRID(ng)%'''Hz'''
:'''pointer =''' GRID(ng)%'''Hz'''
:'''tangent =''' <span style="color:red">tl_Hz</span>
:'''tangent =''' <span class="red">tl_Hz</span>
:'''adjoint =''' <span style="color:purple">ad_Hz</span>
:'''adjoint =''' <span class="purple">ad_Hz</span>
:'''units =''' meter
:'''units =''' meter
:'''grid =''' &rho;-points
:'''grid =''' &rho;-points
Line 26: Line 26:
:'''routine =''' [[set_depths.F]]
:'''routine =''' [[set_depths.F]]


=='''I'''==
==<span class="alphabet">'''I'''</span>==


=='''J'''==
==<span class="alphabet">'''J'''</span>==


=='''K'''==
==<span class="alphabet">'''K'''</span>==


=='''L'''==
==<span class="alphabet">'''L'''</span>==


=='''M'''==
==<span class="alphabet">'''M'''</span>==


=='''N'''==
==<span class="alphabet">'''N'''</span>==


=='''O'''==
==<span class="alphabet">'''O'''</span>==


=='''P'''==
==<span class="alphabet">'''P'''</span>==


=='''Q'''==
==<span class="alphabet">'''Q'''</span>==


=='''R'''==
==<span class="alphabet">'''R'''</span>==


;<span id="rho"></span>'''rho'''  
;<span id="rho"></span>'''rho'''  
Line 51: Line 51:
:'''dimension =''' '''rho'''(LBi:UBi,LBj:UBj,N)
:'''dimension =''' '''rho'''(LBi:UBi,LBj:UBj,N)
:'''pointer =''' OCEAN(ng)%'''rho'''
:'''pointer =''' OCEAN(ng)%'''rho'''
:'''tangent =''' <span style="color:red">tl_rho</span>
:'''tangent =''' <span class="red">tl_rho</span>
:'''adjoint =''' <span style="color:purple">ad_rho</span>
:'''adjoint =''' <span class="purple">ad_rho</span>
:'''units =''' kilogram meter<sup>-3</sup>
:'''units =''' kilogram meter<sup>-3</sup>
:'''grid =''' &rho;-points
:'''grid =''' &rho;-points
Line 58: Line 58:
:'''routine =''' [[rho_eos.F]]
:'''routine =''' [[rho_eos.F]]
:It can computed using a linear or nonlinear equation of state. The nonlinear equation of state is based on [[Bibliography#JackettDR_1995a | Jackett and McDougall (1992)]] polynomial expressions.   
:It can computed using a linear or nonlinear equation of state. The nonlinear equation of state is based on [[Bibliography#JackettDR_1995a | Jackett and McDougall (1992)]] polynomial expressions.   
=='''S'''==


=='''T'''==
==<span class="alphabet">'''S'''</span>==
 
==<span class="alphabet">'''T'''</span>==


;<span id="t"></span>'''t'''  
;<span id="t"></span>'''t'''  
Line 66: Line 67:
:'''dimension =''' '''t'''(LBi:UBi,LBj:UBj,N,3,NT)
:'''dimension =''' '''t'''(LBi:UBi,LBj:UBj,N,3,NT)
:'''pointer =''' OCEAN(ng)%'''t'''
:'''pointer =''' OCEAN(ng)%'''t'''
:'''tangent =''' <span style="color:red">tl_t</span>
:'''tangent =''' <span class="red">tl_t</span>
:'''adjoint =''' <span style="color:purple">ad_t</span>
:'''adjoint =''' <span class="purple">ad_t</span>
:'''grid =''' &rho;-points
:'''grid =''' &rho;-points
:'''CPP =''' [[SOLVE3D]]
:'''CPP =''' [[SOLVE3D]]
Line 107: Line 108:
|}
|}


=='''U'''==
==<span class="alphabet">'''U'''</span>==


;<span id="u"></span>'''u'''  
;<span id="u"></span>'''u'''  
Line 113: Line 114:
:'''dimension =''' '''u'''(LBi:UBi,LBj:UBj,N,2)
:'''dimension =''' '''u'''(LBi:UBi,LBj:UBj,N,2)
:'''pointer =''' OCEAN(ng)%'''u'''
:'''pointer =''' OCEAN(ng)%'''u'''
:'''tangent =''' <span style="color:red">tl_u</span>
:'''tangent =''' <span class="red">tl_u</span>
:'''adjoint =''' <span style="color:purple">ad_u</span>
:'''adjoint =''' <span class="purple">ad_u</span>
:'''units =''' meter second<sup>-1</sup>
:'''units =''' meter second<sup>-1</sup>
:'''grid =''' u-points
:'''grid =''' u-points
Line 125: Line 126:
:'''dimension =''' '''ubar'''(LBi:UBi,LBj:UBj,3)
:'''dimension =''' '''ubar'''(LBi:UBi,LBj:UBj,3)
:'''pointer =''' OCEAN(ng)%'''ubar'''
:'''pointer =''' OCEAN(ng)%'''ubar'''
:'''tangent =''' <span style="color:red">tl_ubar</span>
:'''tangent =''' <span class="red">tl_ubar</span>
:'''adjoint =''' <span style="color:purple">ad_ubar</span>
:'''adjoint =''' <span class="purple">ad_ubar</span>
:'''units =''' meter second<sup>-1</sup>
:'''units =''' meter second<sup>-1</sup>
:'''grid =''' u-points
:'''grid =''' u-points
:'''routine =''' [[step2d.F]]
:'''routine =''' [[step2d.F]]


=='''V'''==
==<span class="alphabet">'''V'''==


;<span id="v"></span>'''v'''  
;<span id="v"></span>'''v'''  
Line 137: Line 138:
:'''dimension =''' '''v'''(LBi:UBi,LBj:UBj,N,2)
:'''dimension =''' '''v'''(LBi:UBi,LBj:UBj,N,2)
:'''pointer =''' OCEAN(ng)%'''v'''
:'''pointer =''' OCEAN(ng)%'''v'''
:'''tangent =''' <span style="color:red">tl_u</span>
:'''tangent =''' <span class="red">tl_u</span>
:'''adjoint =''' <span style="color:purple">ad_u</span>
:'''adjoint =''' <span class="purple">ad_u</span>
:'''units =''' meter second<sup>-1</sup>
:'''units =''' meter second<sup>-1</sup>
:'''grid =''' v-points
:'''grid =''' v-points
Line 149: Line 150:
:'''dimension =''' '''vbar'''(LBi:UBi,LBj:UBj,3)
:'''dimension =''' '''vbar'''(LBi:UBi,LBj:UBj,3)
:'''pointer =''' OCEAN(ng)%'''vbar'''
:'''pointer =''' OCEAN(ng)%'''vbar'''
:'''tangent =''' <span style="color:red">tl_vbar</span>
:'''tangent =''' <span class="red">tl_vbar</span>
:'''adjoint =''' <span style="color:purple">ad_vbar</span>
:'''adjoint =''' <span class="purple">ad_vbar</span>
:'''units =''' meter second<sup>-1</sup>
:'''units =''' meter second<sup>-1</sup>
:'''grid =''' v-points
:'''grid =''' v-points
:'''routine =''' [[step2d.F]]
:'''routine =''' [[step2d.F]]


=='''W'''==
==<span class="alphabet">'''W'''</span>==


;<span id="W"></span>'''W'''  
;<span id="W"></span>'''W'''  
Line 161: Line 162:
:'''dimension =''' '''W'''(LBi:UBi,LBj:UBj,0:N)
:'''dimension =''' '''W'''(LBi:UBi,LBj:UBj,0:N)
:'''pointer =''' OCEAN(ng)%'''W'''
:'''pointer =''' OCEAN(ng)%'''W'''
:'''tangent =''' <span style="color:red">tl_W</span>
:'''tangent =''' <span class="red">tl_W</span>
:'''adjoint =''' <span style="color:purple">ad_W</span>
:'''adjoint =''' <span class="purple">ad_W</span>
:'''units =''' meter<sup>3</sup> second<sup>-1</sup>
:'''units =''' meter<sup>3</sup> second<sup>-1</sup>
:'''sign = ''' positive downwards (downwelling), negative upwards (upwelling)
:'''sign = ''' positive downwards (downwelling), negative upwards (upwelling)
Line 179: Line 180:
:'''routine =''' [[wvelocity.F]]
:'''routine =''' [[wvelocity.F]]


=='''X'''==
==<span class="alphabet">'''X'''</span>==


=='''Y'''==
==<span class="alphabet">'''Y'''</span>==


=='''Z'''==
==<span class="alphabet">'''Z'''</span>==


;<span id="zeta"></span>'''zeta'''  
;<span id="zeta"></span>'''zeta'''  
Line 189: Line 190:
:'''dimension =''' '''zeta'''(LBi:UBi,LBj:UBj,3)
:'''dimension =''' '''zeta'''(LBi:UBi,LBj:UBj,3)
:'''pointer =''' OCEAN(ng)%'''zeta'''
:'''pointer =''' OCEAN(ng)%'''zeta'''
:'''tangent =''' <span style="color:red">tl_zeta</span>
:'''tangent =''' <span class="red">tl_zeta</span>
:'''adjoint =''' <span style="color:purple">ad_zeta</span>
:'''adjoint =''' <span class="purple">ad_zeta</span>
:'''units =''' meter
:'''units =''' meter
:'''grid =''' &rho;-points
:'''grid =''' &rho;-points

Revision as of 16:50, 15 November 2006

A

B

C

D

E

F

G

H

Hz
Vertical level thicknesses, .
dimension = Hz(LBi:UBi,LBj:UBj,N)
pointer = GRID(ng)%Hz
tangent = tl_Hz
adjoint = ad_Hz
units = meter
grid = ρ-points
CPP = SOLVE3D
routine = set_depths.F

I

J

K

L

M

N

O

P

Q

R

rho
In situ density anomaly computed as a function of potential temperature, salinity, and depth.
.
dimension = rho(LBi:UBi,LBj:UBj,N)
pointer = OCEAN(ng)%rho
tangent = tl_rho
adjoint = ad_rho
units = kilogram meter-3
grid = ρ-points
CPP = SOLVE3D, NONLIN_EOS
routine = rho_eos.F
It can computed using a linear or nonlinear equation of state. The nonlinear equation of state is based on Jackett and McDougall (1992) polynomial expressions.

S

T

t
Tracer-type variables, .
dimension = t(LBi:UBi,LBj:UBj,N,3,NT)
pointer = OCEAN(ng)%t
tangent = tl_t
adjoint = ad_t
grid = ρ-points
CPP = SOLVE3D
routine = step3d_t.F
This array contains all the tracer fields. They are classified as active (potential temperature, salinity), inert (dyes, pollutants, oil spills, etc), passive (sediment, biology). There is a index identifier for each tracer field (see table below). Notice that salinity does not have physical units. Usually PSU is used to indicate that the practical salinity scale was used to determine conductivity.
Index Field Units CPP
itemp Potential temperature Celsius SOLVE3D
isalt Salinity None SALINITY
inert(1:NPT) NPT inert tracers kilogram meter-3 T_PASSIVE
idsed(1:NST) NST sediment tracers kilogram meter-3 SEDIMENT
idbio(1:NBT) NBT biology tracers millimole meter-3 BIOLOGY

U

u
Total momentum component in the ξ-direction, .
dimension = u(LBi:UBi,LBj:UBj,N,2)
pointer = OCEAN(ng)%u
tangent = tl_u
adjoint = ad_u
units = meter second-1
grid = u-points
CPP = SOLVE3D
routine = step3d_uv.F
ubar
Vertically-integrated momentum component in the ξ-direction, .
dimension = ubar(LBi:UBi,LBj:UBj,3)
pointer = OCEAN(ng)%ubar
tangent = tl_ubar
adjoint = ad_ubar
units = meter second-1
grid = u-points
routine = step2d.F

V

v
3D momentum component in the η-direction, .
dimension = v(LBi:UBi,LBj:UBj,N,2)
pointer = OCEAN(ng)%v
tangent = tl_u
adjoint = ad_u
units = meter second-1
grid = v-points
CPP = SOLVE3D
routine = step3d_uv.F
vbar
Vertically-integrated momentum component in the η-direction, .
dimension = vbar(LBi:UBi,LBj:UBj,3)
pointer = OCEAN(ng)%vbar
tangent = tl_vbar
adjoint = ad_vbar
units = meter second-1
grid = v-points
routine = step2d.F

W

W
Terrain-following, vertical velocity component, .
dimension = W(LBi:UBi,LBj:UBj,0:N)
pointer = OCEAN(ng)%W
tangent = tl_W
adjoint = ad_W
units = meter3 second-1
sign = positive downwards (downwelling), negative upwards (upwelling)
grid = w-points
CPP = SOLVE3D
routine = omega.F
wvel
True vertical velocity component, . It is computed only for output purposes.
dimension = wvel(LBi:UBi,LBj:UBj,0:N)
pointer = OCEAN(ng)%wvel
units = meter second-1
sign = positive downwards (downwelling), negative upwards (upwelling
grid = w-points
CPP = SOLVE3D
routine = wvelocity.F

X

Y

Z

zeta
Free-surface, .
dimension = zeta(LBi:UBi,LBj:UBj,3)
pointer = OCEAN(ng)%zeta
tangent = tl_zeta
adjoint = ad_zeta
units = meter
grid = ρ-points
routine = step2d.F
z_r
Actual depths of variables at ρ-points, .
dimension = z_r(LBi:UBi,LBj:UBj,N)
pointer = GRID(ng)%z_r
units = meter
sign = negative downwards
grid = ρ-points
CPP = SOLVE3D
routine = set_depths.F
z_w
Actual depths of variables at w-points, .
dimension = z_w(LBi:UBi,LBj:UBj,0:N)
pointer = GRID(ng)%z_w
units = meter
sign = negative downwards
grid = w-points
CPP = SOLVE3D
routine = set_depths.F