/[MITgcm]/manual/s_phys_pkgs/text/exf.tex
ViewVC logotype

Diff of /manual/s_phys_pkgs/text/exf.tex

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.5 by heimbach, Mon Aug 1 22:31:36 2005 UTC revision 1.10 by heimbach, Tue Jan 15 21:37:14 2008 UTC
# Line 49  using the \texttt{packages.conf} file by Line 49  using the \texttt{packages.conf} file by
49  or using \texttt{genmake2} adding  or using \texttt{genmake2} adding
50  \texttt{-enable=exf} or \texttt{-disable=exf} switches  \texttt{-enable=exf} or \texttt{-disable=exf} switches
51  %  %
52    \item
53    \textit{required packages and CPP options}: \\
54    EXF requires the calendar package \texttt{cal} to be enabled;
55    no additional CPP options are required.
56    %
57  \end{itemize}  \end{itemize}
58  (see Section \ref{sect:buildingCode}).  (see Section \ref{sect:buildingCode}).
59    
# Line 58  via CPP preprocessor flags. These option Line 63  via CPP preprocessor flags. These option
63  Table \ref{tab:pkg:exf:cpp} summarizes these options.  Table \ref{tab:pkg:exf:cpp} summarizes these options.
64    
65  \begin{table}[b!]  \begin{table}[b!]
66    \centering
67    \label{tab:pkg:exf:cpp}    \label{tab:pkg:exf:cpp}
68    {\footnotesize    {\footnotesize
69      \begin{tabular}{|l|l|}      \begin{tabular}{|l|l|}
# Line 80  Table \ref{tab:pkg:exf:cpp} summarizes t Line 86  Table \ref{tab:pkg:exf:cpp} summarizes t
86        \hline        \hline
87           \multicolumn{2}{|c|}{\textit{used in conjunction with relaxation to prescribed (climatological) fields}} \\           \multicolumn{2}{|c|}{\textit{used in conjunction with relaxation to prescribed (climatological) fields}} \\
88           \hline           \hline
         \texttt{ALLOW\_CLIMTEMP\_RELAXATION} &  
           relaxation to 3-D temperature climatology \\  
         \texttt{ALLOW\_CLIMSALT\_RELAXATION} &  
           relaxation to 3-D salinity climatology \\  
89          \texttt{ALLOW\_CLIMSST\_RELAXATION} &          \texttt{ALLOW\_CLIMSST\_RELAXATION} &
90            relaxation to 2-D SST climatology \\            relaxation to 2-D SST climatology \\
91          \texttt{ALLOW\_CLIMSSS\_RELAXATION} &          \texttt{ALLOW\_CLIMSSS\_RELAXATION} &
# Line 125  For EXF this flag is omitted, i.e. EXF i Line 127  For EXF this flag is omitted, i.e. EXF i
127  ~ \\  ~ \\
128  %  %
129  \begin{table}[h!]  \begin{table}[h!]
130    \centering
131    \label{tab:pkg:exf:runtime_flags}    \label{tab:pkg:exf:runtime_flags}
132    {\footnotesize    {\footnotesize
133      \begin{tabular}{|l|c|l|}      \begin{tabular}{|l|c|l|}
# Line 146  For EXF this flag is omitted, i.e. EXF i Line 149  For EXF this flag is omitted, i.e. EXF i
149             max. allowed wind stress $N/m^2$ \\             max. allowed wind stress $N/m^2$ \\
150          exf\_albedo & \texttt{0.1} &          exf\_albedo & \texttt{0.1} &
151            surface albedo used to compute downward vs. net radiative fluxes \\            surface albedo used to compute downward vs. net radiative fluxes \\
152            climtempfreeze & \texttt{-1.9} &
153              ??? \\
154            ocean\_emissivity & \texttt{} &
155              longwave ocean-surface emissivity \\
156            ice\_emissivity & \texttt{} &
157              longwave seaice emissivity \\
158            snow\_emissivity & \texttt{} &
159              longwave  snow  emissivity \\
160            exf\_iceCd & \texttt{1.63E-3} &
161              drag coefficient over sea-ice \\
162            exf\_iceCe & \texttt{1.63E-3} &
163              evaporation transfer coeff. over sea-ice \\
164            exf\_iceCh & \texttt{1.63E-3} &
165              sensible heat transfer coeff. over sea-ice \\
166            exf\_scal\_BulkCdn & \texttt{1.} &
167              overall scaling of neutral drag coeff. \\
168            useStabilityFct\_overIce  & \texttt{.FALSE.} &
169              compute turbulent transfer coeff. over sea-ice \\
170            readStressOnAgrid & \texttt{.FALSE.} &
171              read wind-streess located on model-grid, A-grid point \\
172            readStressOnCgrid & \texttt{.FALSE.} &
173              read wind-streess located on model-grid, C-grid point \\
174            useRelativeWind & \texttt{.FALSE.} &
175              subtract [U/V]VEL or [U/VICE from U/V]WIND before \\
176            ~ & ~ &  computing [U/V]STRESS \\
177            zref & \texttt{10.} &
178              reference height \\
179            hu & \texttt{10.} &
180              height of mean wind \\
181            ht & \texttt{2.} &
182              height of mean temperature and rel. humidity \\
183            umin & \texttt{0.5} &
184              minimum absolute wind speed for computing Cd \\
185            atmrho & \texttt{1.2} &
186              mean atmospheric density [kg/m\^3] \\
187            atmcp & \texttt{1005.} &
188              mean atmospheric specific heat [J/kg/K] \\
189            cdrag\_[n] & \texttt{???} &
190              n = 1,2,3; parameters for drag coeff. function \\
191            cstanton\_[n] & \texttt{???} &
192              n = 1,2; parameters for Stanton number function \\
193            cdalton & \texttt{???} &
194              parameter for Dalton number function \\
195            flamb & \texttt{2500000.} &
196              latent heat of evaporation [J/kg] \\
197            flami & \texttt{334000.} &
198              latent heat of melting of pure ice [J/kg] \\
199            zolmin & \texttt{-100.} &
200              minimum stability parameter \\
201            cvapor\_fac & \texttt{640380.} &
202              ~ \\
203            cvapor\_exp & \texttt{5107.4} &
204              ~ \\
205            cvapor\_fac\_ice & \texttt{11637800.} &
206              ~ \\
207            cvapor\_fac\_ice & \texttt{5897.8} &
208              ~ \\
209            humid\_fac & \texttt{0.606} &
210              parameter for virtual temperature calculation \\
211            gamma\_blk & \texttt{0.010} &
212              adiabatic lapse rate \\
213            saltsat & \texttt{0.980} &
214              reduction of saturation vapor pressure over salt-water \\          
215            psim\_fac & \texttt{5.} &
216              ~ \\          
217            exf\_monFreq & \texttt{monitorFreq} &
218              output frequency [s] \\
219          exf\_iprec  & \texttt{32} &          exf\_iprec  & \texttt{32} &
220            precision of input fields (32-bit or 64-bit) \\            precision of input fields (32-bit or 64-bit) \\
221          exf\_yftype & \texttt{'RL'} &          exf\_yftype & \texttt{'RL'} &
# Line 177  prepend the field name to the listed att Line 247  prepend the field name to the listed att
247  %  %
248    
249  \begin{table}[h!]  \begin{table}[h!]
250    \centering
251    \label{tab:pkg:exf:runtime_attributes}    \label{tab:pkg:exf:runtime_attributes}
252    {\footnotesize    {\footnotesize
253      \begin{tabular}{|l|c|l|}      \begin{tabular}{|l|c|l|}
# Line 252  supplied as well. Line 323  supplied as well.
323    
324  %----------------------------------------------------------------------  %----------------------------------------------------------------------
325    
326    \subsubsection{EXF bulk formulae
327    \label{sec:pkg:exf:bulk_formulae}}
328    
329    T.B.D. (cross-ref. to parameter list table)
330    
331    %----------------------------------------------------------------------
332    
333  \subsubsection{EXF input fields and units  \subsubsection{EXF input fields and units
334  \label{sec:pkg:exf:fields_units}}  \label{sec:pkg:exf:fields_units}}
335    
# Line 284  c               |  Typical range: -0.5 < Line 362  c               |  Typical range: -0.5 <
362  c               |  Southwest C-grid V point  c               |  Southwest C-grid V point
363  c               |  Input field  c               |  Input field
364  c----------------------------------------------------------------------  c----------------------------------------------------------------------
365    c     hs        :: sensible heat flux into ocean in W/m^2
366    c               |  > 0 for increase in theta (ocean warming)
367    c----------------------------------------------------------------------
368    c     hl        :: latent   heat flux into ocean in W/m^2
369    c               |  > 0 for increase in theta (ocean warming)
370    c----------------------------------------------------------------------
371  c     hflux     :: Net upward surface heat flux in W/m^2  c     hflux     :: Net upward surface heat flux in W/m^2
372  c               |  excluding shortwave (on input)  c               |  excluding shortwave (on input)
373  c               |  hflux = latent + sensible + lwflux  c               |  hflux = latent + sensible + lwflux
# Line 320  c               |  Typical range: -10 < Line 404  c               |  Typical range: -10 <
404  c               |  Southwest C-grid V point  c               |  Southwest C-grid V point
405  c               |  Input or input/output field  c               |  Input or input/output field
406  c----------------------------------------------------------------------  c----------------------------------------------------------------------
407    c     wspeed    :: Surface (10-m) wind speed in m/s
408    c               |  >= 0 sqrt(u^2+v^2)
409    c               |  Typical range: 0 < wspeed < 10
410    c               |  Input or input/output field
411    c----------------------------------------------------------------------
412  c     atemp     :: Surface (2-m) air temperature in deg K  c     atemp     :: Surface (2-m) air temperature in deg K
413  c               |  Typical range: 200 < atemp < 300  c               |  Typical range: 200 < atemp < 300
414  c               |  Southwest C-grid tracer point  c               |  Southwest C-grid tracer point
# Line 349  c               |  Typical range: 0 < pr Line 438  c               |  Typical range: 0 < pr
438  c               |  Southwest C-grid tracer point  c               |  Southwest C-grid tracer point
439  c               |  Input or input/output field  c               |  Input or input/output field
440  c----------------------------------------------------------------------  c----------------------------------------------------------------------
441    c    snowprecip :: snow in m/s
442    c               |  > 0 for decrease in salt (ocean salinity)
443    c               |  Typical range: 0 < precip < 5e-7
444    c               |  Input or input/output field
445    c----------------------------------------------------------------------
446  c     runoff    :: River and glacier runoff in m/s  c     runoff    :: River and glacier runoff in m/s
447  c               |  > 0 for decrease in salt (ocean salinity)  c               |  > 0 for decrease in salt (ocean salinity)
448  c               |  Typical range: 0 < runoff < ????  c               |  Typical range: 0 < runoff < ????
# Line 394  c ... Line 488  c ...
488  c  exf_getforcing (TOP LEVEL ROUTINE)  c  exf_getforcing (TOP LEVEL ROUTINE)
489  c  |  c  |
490  c  |-- exf_getclim (get climatological fields used e.g. for relax.)  c  |-- exf_getclim (get climatological fields used e.g. for relax.)
 c  |   |--- exf_set_climtemp (relax. to 3-D temperature field)  
 c  |   |--- exf_set_climsalt (relax. to 3-D salinity field)  
491  c  |   |--- exf_set_climsst  (relax. to 2-D SST field)  c  |   |--- exf_set_climsst  (relax. to 2-D SST field)
492  c  |   |--- exf_set_climsss  (relax. to 2-D SSS field)  c  |   |--- exf_set_climsss  (relax. to 2-D SSS field)
493  c  |   o  c  |   o
# Line 406  c  |   |      depending on CPP options ( Line 498  c  |   |      depending on CPP options (
498  c  |   |      consecutive in time are read in and interpolated onto  c  |   |      consecutive in time are read in and interpolated onto
499  c  |   |      current time step).  c  |   |      current time step).
500  c  |   |   2. If forcing is atmos. state and control is atmos. state,  c  |   |   2. If forcing is atmos. state and control is atmos. state,
501  c  |   |      then the control variable anomalies are read here  c  |   |      then the control variable anomalies are read here via ctrl_get_gen
502  c  |   |          * ctrl_getatemp  c  |   |      (atemp, aqh, precip, swflux, swdown, uwind, vwind).
 c  |   |          * ctrl_getaqh  
 c  |   |          * ctrl_getuwind  
 c  |   |          * ctrl_getvwind  
503  c  |   |      If forcing and control are fluxes, then  c  |   |      If forcing and control are fluxes, then
504  c  |   |      controls are added later.  c  |   |      controls are added later.
505  c  |   o  c  |   o
506  c  |  c  |
507  c  |-- exf_check_range  c  |-- exf_radiation
508  c  |   |   1. Check whether read fields are within assumed range  c  |   |    Compute net or downwelling radiative fluxes via
509  c  |   |      (may capture mismatches in units)  c  |   |    Stefan-Boltzmann law in case only one is known.
510    c  |   o
511    c  |-- exf_wind
512    c  |   |   Computes wind speed and stresses, if required.
513  c  |   o  c  |   o
514  c  |  c  |
515  c  |-- exf_bulkformulae  c  |-- exf_bulkformulae
516  c  |   |   1. Compute net or downwelling radiative fluxes via  c  |   |   Compute air-sea buoyancy fluxes from
517  c  |   |      Stefan-Boltzmann law in case only one is known.  c  |   |   atmospheric state following Large and Pond, JPO, 1981/82
 c  |   |   2. Compute air-sea momentum and buoyancy fluxes from  
 c  |   |      atmospheric state following Large and Pond, JPO, 1981/82  
518  c  |   o  c  |   o
519  c  |  c  |
520  c  |-- < add time-mean river runoff here, if available >  c  |-- < hflux is sum of sensible, latent, longwave rad. >
521    c  |-- < sflux is sum of evap. minus precip. minus runoff  >
522    c  |
523    c  |-- exf_getsurfacefluxes
524    c  |   If forcing and control is flux, then the
525    c  |   control vector anomalies are read here via ctrl_get_gen
526    c  |   (hflux, sflux, ustress, vstress)
527  c  |  c  |
528  c  |-- < update tile edges here >  c  |-- < update tile edges here >
529  c  |  c  |
530  c  |-- exf_getsurfacefluxes  c  |-- exf_check_range
531  c  |   |   1. If forcing and control are fluxes, then  c  |   |   Check whether read fields are within assumed range
532  c  |   |      controls are added here.  c  |   |   (may capture mismatches in units)
533  c  |   o  c  |   o
534  c  |  c  |
535  c  |-- < treatment of hflux w.r.t. swflux >  c  |-- < add shortwave to hflux for diagnostics >
536  c  |  c  |
537  c  |-- exf_diagnostics_fill  c  |-- exf_diagnostics_fill
538  c  |   |   1. Do EXF-related diagnostics output here.  c  |   |   Do EXF-related diagnostics output here.
539  c  |   o  c  |   o
540  c  |  c  |
541  c  |-- exf_mapfields  c  |-- exf_mapfields
542  c  |   |   1. Map the EXF variables onto the core MITgcm  c  |   |   Forcing fields from exf package are mapped onto
543  c  |   |      forcing fields.  c  |   |   mitgcm forcing arrays.
544    c  |   |   Mapping enables a runtime rescaling of fields
545  c  |   o  c  |   o
546  c  |  C  o
 c  |-- exf_bulkformulae  
 c  |   If ALLOW_BULKFORMULAE, compute fluxes via bulkformulae  
 c  |  
 c  |-- exf_getsurfacefluxes  
 c  |   If forcing and control is flux, then the  
 c  |   control vector anomalies are read here  
 c  |      * ctrl_getheatflux  
 c  |      * ctrl_getsaltflux  
 c  |      * ctrl_getzonstress  
 c  |      * call ctrl_getmerstress  
 c  |  
 c  |-- exf_mapfields  
 c  |   Forcing fields from exf package are mapped onto  
 c  |   mitgcm forcing arrays.  
 c  |   Mapping enables a runtime rescaling of fields  
   
547  \end{verbatim}  \end{verbatim}
548  }  }
549    
550  Bulk formula routine: \texttt{exf\_bulkformulae.F}  Radiation calculation: \texttt{exf\_radiation.F}
551    
552  Generic I/O routine: \texttt{exf\_set\_gen.F}  Wind speed and stress calculation: \texttt{exf\_wind.F}
553    
554  Interpolation routine: \texttt{exf\_interp.F}  Bulk formula: \texttt{exf\_bulkformulae.F}
555    
556    Generic I/O: \texttt{exf\_set\_gen.F}
557    
558    Interpolation: \texttt{exf\_interp.F}
559    
560  Header routines  Header routines
561    
# Line 485  Available output fields are summarized i Line 570  Available output fields are summarized i
570  Table \ref{tab:pkg:exf:diagnostics}.  Table \ref{tab:pkg:exf:diagnostics}.
571    
572  \begin{table}[h!]  \begin{table}[h!]
573    \centering
574  \label{tab:pkg:exf:diagnostics}  \label{tab:pkg:exf:diagnostics}
575  {\footnotesize  {\footnotesize
576  \begin{verbatim}  \begin{verbatim}
577  ------------------------------------------------------  ------------------------------------------------------
578   <-Name->|Levs|grid|<--  Units   -->|<- Tile (max=80c)   <-Name->|Levs|grid|<--  Units   -->|<- Tile (max=80c)
579  ------------------------------------------------------  ------------------------------------------------------
580     EXFhs   |  1 | SM | W/m^2          | Sensible heat flux into ocean, >0 increases theta
581     EXFhl   |  1 | SM | W/m^2          | Latent heat flux into ocean, >0 increases theta
582     EXFlwnet|  1 | SM | W/m^2          | Net upward longwave radiation, >0 decreases theta
583     EXFswnet|  1 | SM | W/m^2          | Net upward shortwave radiation, >0 decreases theta
584   EXFlwdn |  1 | SM | W/m^2          | Downward longwave radiation, >0 increases theta   EXFlwdn |  1 | SM | W/m^2          | Downward longwave radiation, >0 increases theta
585   EXFswdn |  1 | SM | W/m^2          | Downward shortwave radiation, >0 increases theta   EXFswdn |  1 | SM | W/m^2          | Downward shortwave radiation, >0 increases theta
586   EXFqnet |  1 | SM | W/m^2          | Net upward heat flux (turb+rad), >0 decreases theta   EXFqnet |  1 | SM | W/m^2          | Net upward heat flux (turb+rad), >0 decreases theta
# Line 498  Table \ref{tab:pkg:exf:diagnostics}. Line 588  Table \ref{tab:pkg:exf:diagnostics}.
588   EXFtauy |  1 | SV | N/m^2          | meridional surface wind stress, >0 increases vVel   EXFtauy |  1 | SV | N/m^2          | meridional surface wind stress, >0 increases vVel
589   EXFuwind|  1 | SM | m/s            | zonal 10-m wind speed, >0 increases uVel   EXFuwind|  1 | SM | m/s            | zonal 10-m wind speed, >0 increases uVel
590   EXFvwind|  1 | SM | m/s            | meridional 10-m wind speed, >0 increases uVel   EXFvwind|  1 | SM | m/s            | meridional 10-m wind speed, >0 increases uVel
591     EXFwspee|  1 | SM | m/s            | 10-m wind speed modulus ( >= 0 )
592   EXFatemp|  1 | SM | degK           | surface (2-m) air temperature   EXFatemp|  1 | SM | degK           | surface (2-m) air temperature
593   EXFaqh  |  1 | SM | kg/kg          | surface (2-m) specific humidity   EXFaqh  |  1 | SM | kg/kg          | surface (2-m) specific humidity
594   EXFevap |  1 | SM | m/s            | evaporation, > 0 increases salinity   EXFevap |  1 | SM | m/s            | evaporation, > 0 increases salinity
595   EXFpreci|  1 | SM | m/s            | evaporation, > 0 decreases salinity   EXFpreci|  1 | SM | m/s            | evaporation, > 0 decreases salinity
596     EXFsnow |  1 | SM | m/s            | snow precipitation, > 0 decreases salinity
597   EXFempmr|  1 | SM | m/s            | net upward freshwater flux, > 0 increases salinity   EXFempmr|  1 | SM | m/s            | net upward freshwater flux, > 0 increases salinity
598   EXFpress|  1 | SM | N/m^2          | atmospheric pressure field   EXFpress|  1 | SM | N/m^2          | atmospheric pressure field
599  \end{verbatim}  \end{verbatim}
# Line 511  Table \ref{tab:pkg:exf:diagnostics}. Line 603  Table \ref{tab:pkg:exf:diagnostics}.
603    
604  %----------------------------------------------------------------------  %----------------------------------------------------------------------
605    
606  \subsubsection{Reference experiments}  \subsubsection{Experiments and tutorials that use exf}
607    \label{sec:pkg:exf:experiments}
608    
609  global\_with\_exf:  \begin{itemize}
610    \item{Global Ocean experiment, in global\_with\_exf verification directory }
611  lab\_sea:  \item{Labrador Sea experiment, in lab\_sea verification directory }
612    \end{itemize}
613    
614  %----------------------------------------------------------------------  %----------------------------------------------------------------------
615    

Legend:
Removed from v.1.5  
changed lines
  Added in v.1.10

  ViewVC Help
Powered by ViewVC 1.1.22