adding windowing docs

versions/replay215/html/_sources/api.rst.txt

@@ -137,7 +137,12 @@ Source path: components/cam/src/physics/cam/
 .. f:subroutine:: replay_readnl 
 
     Read replay namelist parameters. End job and throw error if namelist parameters not properly
-    defined. Send parameters to all processors. 
+    defined. Send parameters to all processors.
+
+.. f:subroutine:: replay_init
+
+    Process windowing parameters if there are any in the namelist and send the updated values
+    to all processors.   
 
 .. f:subroutine:: replay_register 
 
@@ -159,7 +164,17 @@ Source path: components/cam/src/physics/cam/
     model to reset (currently 03z, 09z, 15z, 21z), calls read of reanalysis file for current time. 
     Calculates difference between model state and reanalysis. Sets state replay forcing variables 
     as that difference. Applies replay forcing as tendency (divided by forcing time, which is
-    6 hours in seconds by default) during replay forcing steps. 
+    6 hours in seconds by default) during replay forcing steps.
+
+.. f:subroutine:: replaying_set_profile 
+
+    Set the spatial regions where the replay is being applied using the windowing parameters for
+    the 3D replay varaibles. If no windowing parameters, then the full globe will be replayed.
+
+.. f:subroutine:: replaying_set_PSprofile 
+
+    Set the spatial regions where the replay is being applied using the windowing parameters for PS. 
+    If no windowing parameters, then the full globe will be replayed.  
 
 **Module** :f:mod:`cam_diagnostics.F90`
 

versions/replay215/html/_sources/replay_configurations.rst.txt

@@ -63,10 +63,164 @@ Replay_coef:
 
          Default: 1.
 
+Replay_coef_U
+       type="real" category="replay", group="replay_nl"
+         U Coeffcient for replay -- usually 1 (full forcing) or 0 (no forcing)
+         [0.,1.] fraction of nudging tendency applied.
 
-Hopeful future configuration options
-------------------------------------
+         Default: 1.
+
+Replay_coef_V
+       type="real" category="replay", group="replay_nl"
+         V Coeffcient for replay -- usually 1 (full forcing) or 0 (no forcing)
+         [0.,1.] fraction of nudging tendency applied.
+
+         Default: 1.
+
+Replay_coef_T
+       type="real" category="replay", group="replay_nl"
+         T Coeffcient for replay -- usually 1 (full forcing) or 0 (no forcing)
+         [0.,1.] fraction of nudging tendency applied.
+
+         Default: 1.
+
+Replay_coef_Q
+       type="real" category="replay", group="replay_nl"
+         Q Coeffcient for replay -- usually 1 (full forcing) or 0 (no forcing)
+         [0.,1.] fraction of nudging tendency applied.
+
+         Default: 1.
+
+Replay_coef_PS
+       type="real" category="replay", group="replay_nl"
+         PS Coeffcient for replay -- usually 1 (full forcing) or 0 (no forcing)
+         [0.,1.] fraction of nudging tendency applied.
+
+         Default: 1.
+
+Replay_Hwin_lat0
+       type="real" category="replay", group="replay_nl"
+         LAT0 center of Horizontal Window in degrees [-90.,90.].
+
+         Default: 0
+
+Replay_Hwin_latWidth
+       type="real" category="replay", group="replay_nl"
+         Width of LAT Window in degrees.
+
+         Default: 9999 (all latitudes)
+
+Replay_Hwin_latDelta
+       type="real" category="replay", group="replay_nl"
+         Width of transition which controls the steepness of window transition in latitude.
+         0. --> Step function
+
+         Default: 1
+
+Replay_Hwin_lon0
+       type="real" category="replay", group="replay_nl"
+         LON0 center of Horizontal Window in degrees [0.,360.].
+
+         Default: 180
+
+Replay_Hwin_lonWidth
+       type="real" category="replay", group="replay_nl"
+         Width of LON Window in degrees.
+
+         Default: 9999 (all longitudes)
+
+Replay_Hwin_lonDelta
+       type="real" category="replay", group="replay_nl"
+         Width of transition which controls the steepness of window transition in longitude.
+          0. --> Step function
+
+         Default: none
+
+Replay_Hwin_Invert
+       type="real" category="replay", group="replay_nl"
+         Invert Horizontal Window Function to its Compliment.
+         TRUE  = value=0 inside the specified window, 1 outside (unforced model within window, replay outside)
+         FALSE = value=1 inside the specified window, 0 outside (replay within window, unforced model outside)
+
+         Default: FALSE
+
+Replay_Vwin_Hindex
+       type="real" category="replay", group="replay_nl"
+         HIGH Level Index for Verical Window specified in terms of model level indices.
+         (e.g. For a 30 level model, Replay_Vwin_Hindex ~ 30 ).
+         For CAM, this is the bound closer to the surface
+
+         Default: Vertical levels + 1
+
+Replay_Vwin_Hdelta
+       type="real" category="replay", group="replay_nl"
+         Width of transition for HIGH end of Vertical Window.
+
+         Default: 0.001
+
+Replay_Vwin_Lindex
+       type="real" category="replay", group="replay_nl"
+         LOW Level Index for Verical Window specified in terms of model level indices.
+         (e.g. Replay_Vwin_Lindex ~ 0 )
+         For CAM, this is the bound closer to the top of atmosphere.
+
+         Default: 0
+
+Replay_Vwin_Ldelta
+       type="real" category="replay", group="replay_nl"
+         Width of transition for LOW end of Vertical Window.
+
+         Default: 0.001
+
+Replay_Vwin_Invert
+       type="real" category="replay", group="replay_nl"
+         Invert Vertical Window Function to its Compliment.
+         TRUE  = value=0 inside the specified window, 1 outside
+         FALSE = value=1 inside the specified window, 0 outside
+
+         Default: FALSE
 
-#. Windowing for replay like in the nudging toolbox.
-#. Allow for setting on and off each variable.
-#. Ability to change duration of replay and forcing times.
+Replay_Uprof
+       type="real" category="replay", group="replay_nl"
+         Profile index for U replaying.
+         0 == OFF      (No replaying of this variable)
+         1 == CONSTANT (Spatially Uniform Replaying)
+         2 == HEAVISIDE WINDOW FUNCTION (Use windowing)
+
+         Default: 1
+
+Replay_Vprof
+       type="real" category="replay", group="replay_nl"
+         Profile index for V replaying.
+         0 == OFF      (No replaying of this variable)
+         1 == CONSTANT (Spatially Uniform Replaying)
+         2 == HEAVISIDE WINDOW FUNCTION (Use windowing)
+
+         Default: 1
+
+Replay_Tprof
+       type="real" category="replay", group="replay_nl"
+         Profile index for T replaying.
+         0 == OFF      (No replaying of this variable)
+         1 == CONSTANT (Spatially Uniform Replaying)
+         2 == HEAVISIDE WINDOW FUNCTION (Use windowing)
+
+         Default: 1
+
+Replay_Qprof
+       type="real" category="replay", group="replay_nl"
+         Profile index for Q replaying.
+         0 == OFF      (No replaying of this variable)
+         1 == CONSTANT (Spatially Uniform Replaying)
+         2 == HEAVISIDE WINDOW FUNCTIO (Use windowing)N
+
+         Default: 1
+
+Replay_PSprof
+       type="real" category="replay", group="replay_nl"
+         Profile index for PS replaying.
+         0 == OFF      (No replaying of this variable)
+         1 == CONSTANT (Spatially Uniform Replaying)
+         2 == HEAVISIDE WINDOW FUNCTIO (Use windowing)N
+
+         Default: 0

versions/replay215/html/api.html

@@ -311,6 +311,13 @@ <h2>CAM<a class="headerlink" href="#cam" title="Permalink to this heading">¶</a
 defined. Send parameters to all processors.</p>
 </dd></dl>
 
+<dl>
+<dt class="sig sig-object f" id="f/replay.F90/replay_init">
+<em class="property"><span class="pre">subroutine</span>&#160; </em><span class="sig-prename descclassname"><span class="pre">replay.F90/</span></span><span class="sig-name descname"><span class="pre">replay_init</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#f/replay.F90/replay_init" title="Permalink to this definition">¶</a></dt>
+<dd><p>Process windowing parameters if there are any in the namelist and send the updated values
+to all processors.</p>
+</dd></dl>
+
 <dl>
 <dt class="sig sig-object f" id="f/replay.F90/replay_register">
 <em class="property"><span class="pre">subroutine</span>&#160; </em><span class="sig-prename descclassname"><span class="pre">replay.F90/</span></span><span class="sig-name descname"><span class="pre">replay_register</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#f/replay.F90/replay_register" title="Permalink to this definition">¶</a></dt>
@@ -341,6 +348,20 @@ <h2>CAM<a class="headerlink" href="#cam" title="Permalink to this heading">¶</a
 6 hours in seconds by default) during replay forcing steps.</p>
 </dd></dl>
 
+<dl>
+<dt class="sig sig-object f" id="f/replay.F90/replaying_set_profile">
+<em class="property"><span class="pre">subroutine</span>&#160; </em><span class="sig-prename descclassname"><span class="pre">replay.F90/</span></span><span class="sig-name descname"><span class="pre">replaying_set_profile</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#f/replay.F90/replaying_set_profile" title="Permalink to this definition">¶</a></dt>
+<dd><p>Set the spatial regions where the replay is being applied using the windowing parameters for
+the 3D replay varaibles. If no windowing parameters, then the full globe will be replayed.</p>
+</dd></dl>
+
+<dl>
+<dt class="sig sig-object f" id="f/replay.F90/replaying_set_PSprofile">
+<em class="property"><span class="pre">subroutine</span>&#160; </em><span class="sig-prename descclassname"><span class="pre">replay.F90/</span></span><span class="sig-name descname"><span class="pre">replaying_set_PSprofile</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#f/replay.F90/replaying_set_PSprofile" title="Permalink to this definition">¶</a></dt>
+<dd><p>Set the spatial regions where the replay is being applied using the windowing parameters for PS.
+If no windowing parameters, then the full globe will be replayed.</p>
+</dd></dl>
+
 <p><strong>Module</strong> <a class="reference internal" href="#f/cam_diagnostics.F90" title="f/cam_diagnostics.F90"><code class="xref f f-mod docutils literal notranslate"><span class="pre">cam_diagnostics.F90</span></code></a></p>
 <p>Source path: components/cam/src/physics/cam/</p>
 <span class="target" id="f/cam_diagnostics.F90"></span><dl>

versions/replay215/html/genindex.html

@@ -363,13 +363,19 @@ <h2 id="R">R</h2>
 </li>
       <li><a href="api.html#f/replay.F90"><strong>replay.F90 (module)</strong></a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api.html#f/replay.F90/replay_correction"><strong>replay_correction() (fortran subroutine in module replay.F90)</strong></a>
 </li>
+      <li><a href="api.html#f/replay.F90/replay_init"><strong>replay_init() (fortran subroutine in module replay.F90)</strong></a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api.html#f/replay.F90/replay_readnl"><strong>replay_readnl() (fortran subroutine in module replay.F90)</strong></a>
 </li>
       <li><a href="api.html#f/replay.F90/replay_register"><strong>replay_register() (fortran subroutine in module replay.F90)</strong></a>
+</li>
+      <li><a href="api.html#f/replay.F90/replaying_set_profile"><strong>replaying_set_profile() (fortran subroutine in module replay.F90)</strong></a>
+</li>
+      <li><a href="api.html#f/replay.F90/replaying_set_PSprofile"><strong>replaying_set_PSprofile() (fortran subroutine in module replay.F90)</strong></a>
 </li>
       <li><a href="api.html#f/restart_dynamics.F90"><strong>restart_dynamics.F90 (module)</strong></a>
 </li>

versions/replay215/html/index.html

@@ -199,7 +199,6 @@ <h2>Table of contents<a class="headerlink" href="#table-of-contents" title="Perm
 <li class="toctree-l2"><a class="reference internal" href="replay_configurations.html#available-compsets">Available Compsets</a></li>
 <li class="toctree-l2"><a class="reference internal" href="replay_configurations.html#available-resolutions">Available Resolutions</a></li>
 <li class="toctree-l2"><a class="reference internal" href="replay_configurations.html#namelist-parameters">Namelist parameters</a></li>
-<li class="toctree-l2"><a class="reference internal" href="replay_configurations.html#hopeful-future-configuration-options">Hopeful future configuration options</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="api.html">Changes to SourceMods for Replay</a><ul>