source: flex_extract.git/documentation/Sphinx/build/html/_modules/disaggregation.html @ 2625ca8

ctbtodev
Last change on this file since 2625ca8 was 2625ca8, checked in by Anne Philipp <anne.philipp@…>, 5 years ago

new build of sphinx for updated api

  • Property mode set to 100644
File size: 67.0 KB
Line 
1
2
3<!DOCTYPE html>
4<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
5<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
6<head>
7  <meta charset="utf-8">
8 
9  <meta name="viewport" content="width=device-width, initial-scale=1.0">
10 
11  <title>disaggregation &mdash; flex_extract 7.1 alpha documentation</title>
12 
13
14 
15 
16 
17 
18
19 
20
21 
22 
23   
24
25 
26
27  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
28  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
29    <link rel="index" title="Index" href="../genindex.html" />
30    <link rel="search" title="Search" href="../search.html" /> 
31
32 
33  <script src="../_static/js/modernizr.min.js"></script>
34
35</head>
36
37<body class="wy-body-for-nav">
38
39   
40  <div class="wy-grid-for-nav">
41
42   
43    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
44      <div class="wy-side-scroll">
45        <div class="wy-side-nav-search">
46         
47
48         
49            <a href="../index.html" class="icon icon-home"> flex_extract
50         
51
52         
53          </a>
54
55         
56           
57           
58              <div class="version">
59                7.1
60              </div>
61           
62         
63
64         
65<div role="search">
66  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
67    <input type="text" name="q" placeholder="Search docs" />
68    <input type="hidden" name="check_keywords" value="yes" />
69    <input type="hidden" name="area" value="default" />
70  </form>
71</div>
72
73         
74        </div>
75
76        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
77         
78           
79           
80             
81           
82           
83              <p class="caption"><span class="caption-text">Table of Contents:</span></p>
84<ul>
85<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Downloads</a></li>
86<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
87<li class="toctree-l1"><a class="reference internal" href="../program_structure.html">Program Structure</a></li>
88<li class="toctree-l1"><a class="reference internal" href="../user_guide.html">User Guide</a></li>
89<li class="toctree-l1"><a class="reference internal" href="../api.html">Auto Generated Documentation</a></li>
90<li class="toctree-l1"><a class="reference internal" href="../support.html">Support</a></li>
91</ul>
92
93           
94         
95        </div>
96      </div>
97    </nav>
98
99    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
100
101     
102      <nav class="wy-nav-top" aria-label="top navigation">
103       
104          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
105          <a href="../index.html">flex_extract</a>
106       
107      </nav>
108
109
110      <div class="wy-nav-content">
111       
112        <div class="rst-content">
113       
114         
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130<div role="navigation" aria-label="breadcrumbs navigation">
131
132  <ul class="wy-breadcrumbs">
133   
134      <li><a href="../index.html">Docs</a> &raquo;</li>
135       
136          <li><a href="index.html">Module code</a> &raquo;</li>
137       
138      <li>disaggregation</li>
139   
140   
141      <li class="wy-breadcrumbs-aside">
142       
143      </li>
144   
145  </ul>
146
147 
148  <hr/>
149</div>
150          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
151           <div itemprop="articleBody">
152           
153  <h1>Source code for disaggregation</h1><div class="highlight"><pre>
154<span></span><span class="ch">#!/usr/bin/env python</span>
155<span class="c1"># -*- coding: utf-8 -*-</span>
156<span class="c1">#*******************************************************************************</span>
157<span class="c1"># @Author: Anne Philipp (University of Vienna)</span>
158<span class="c1">#</span>
159<span class="c1"># @Date: March 2018</span>
160<span class="c1">#</span>
161<span class="c1"># @Change History:</span>
162<span class="c1">#</span>
163<span class="c1">#    November 2015 - Leopold Haimberger (University of Vienna):</span>
164<span class="c1">#        - migration of the methods dapoly and darain from Fortran</span>
165<span class="c1">#          (flex_extract_v6 and earlier) to Python</span>
166<span class="c1">#</span>
167<span class="c1">#    April 2018 - Anne Philipp (University of Vienna):</span>
168<span class="c1">#        - applied PEP8 style guide</span>
169<span class="c1">#        - added structured documentation</span>
170<span class="c1">#        - outsourced the disaggregation functions dapoly and darain</span>
171<span class="c1">#          to a new module named disaggregation</span>
172<span class="c1">#        - added the new disaggregation method for precipitation</span>
173<span class="c1">#</span>
174<span class="c1"># @License:</span>
175<span class="c1">#    (C) Copyright 2014-2019.</span>
176<span class="c1">#    Anne Philipp, Leopold Haimberger</span>
177<span class="c1">#</span>
178<span class="c1">#    This work is licensed under the Creative Commons Attribution 4.0</span>
179<span class="c1">#    International License. To view a copy of this license, visit</span>
180<span class="c1">#    http://creativecommons.org/licenses/by/4.0/ or send a letter to</span>
181<span class="c1">#    Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.</span>
182<span class="c1">#</span>
183<span class="c1"># @Methods:</span>
184<span class="c1">#    - dapoly</span>
185<span class="c1">#    - darain</span>
186<span class="c1">#    - IA3</span>
187<span class="c1">#*******************************************************************************</span>
188<span class="sd">&#39;&#39;&#39;Disaggregation of deaccumulated flux data from an ECMWF model FG field.</span>
189
190<span class="sd">Initially the flux data to be concerned are:</span>
191<span class="sd">    - large-scale precipitation</span>
192<span class="sd">    - convective precipitation</span>
193<span class="sd">    - surface sensible heat flux</span>
194<span class="sd">    - surface solar radiation</span>
195<span class="sd">    - u stress</span>
196<span class="sd">    - v stress</span>
197
198<span class="sd">Different versions of disaggregation is provided for rainfall</span>
199<span class="sd">data (darain, modified linear) and the surface fluxes and</span>
200<span class="sd">stress data (dapoly, cubic polynomial).</span>
201<span class="sd">&#39;&#39;&#39;</span>
202
203<span class="c1"># ------------------------------------------------------------------------------</span>
204<span class="c1"># MODULES</span>
205<span class="c1"># ------------------------------------------------------------------------------</span>
206
207<span class="c1"># ------------------------------------------------------------------------------</span>
208<span class="c1"># FUNCTIONS</span>
209<span class="c1"># ------------------------------------------------------------------------------</span>
210<div class="viewcode-block" id="dapoly"><a class="viewcode-back" href="../api.html#disaggregation.dapoly">[docs]</a><span class="k">def</span> <span class="nf">dapoly</span><span class="p">(</span><span class="n">alist</span><span class="p">):</span>
211    <span class="sd">&quot;&quot;&quot;Cubic polynomial interpolation of deaccumulated fluxes.</span>
212
213<span class="sd">    Interpolation of deaccumulated fluxes of an ECMWF model FG field</span>
214<span class="sd">    using a cubic polynomial solution which conserves the integrals</span>
215<span class="sd">    of the fluxes within each timespan.</span>
216<span class="sd">    Disaggregation is done for 4 accumluated timespans which</span>
217<span class="sd">    generates a new, disaggregated value which is output at the</span>
218<span class="sd">    central point of the 4 accumulation timespans.</span>
219<span class="sd">    This new point is used for linear interpolation of the complete</span>
220<span class="sd">    timeseries afterwards.</span>
221
222<span class="sd">    Parameters</span>
223<span class="sd">    ----------</span>
224<span class="sd">    alist : list of array of float</span>
225<span class="sd">        List of 4 timespans as 2-dimensional, horizontal fields.</span>
226<span class="sd">        E.g. [[array_t1], [array_t2], [array_t3], [array_t4]]</span>
227
228<span class="sd">    Return</span>
229<span class="sd">    ------</span>
230<span class="sd">    nfield : array of float</span>
231<span class="sd">        Interpolated flux at central point of accumulation timespan.</span>
232
233<span class="sd">    Note</span>
234<span class="sd">    ----</span>
235<span class="sd">    March 2000    : P. JAMES</span>
236<span class="sd">        Original author</span>
237
238<span class="sd">    June 2003     : A. BECK</span>
239<span class="sd">        Adaptations</span>
240
241<span class="sd">    November 2015 : Leopold Haimberger (University of Vienna)</span>
242<span class="sd">        Migration from Fortran to Python</span>
243
244<span class="sd">    &quot;&quot;&quot;</span>
245
246    <span class="n">pya</span> <span class="o">=</span> <span class="p">(</span><span class="n">alist</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span> <span class="o">-</span> <span class="n">alist</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">+</span> <span class="mf">3.</span> <span class="o">*</span> <span class="p">(</span><span class="n">alist</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">-</span> <span class="n">alist</span><span class="p">[</span><span class="mi">2</span><span class="p">]))</span> <span class="o">/</span> <span class="mf">6.</span>
247    <span class="n">pyb</span> <span class="o">=</span> <span class="p">(</span><span class="n">alist</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span> <span class="o">+</span> <span class="n">alist</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="o">/</span> <span class="mf">2.</span> <span class="o">-</span> <span class="n">alist</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">-</span> <span class="mf">9.</span> <span class="o">*</span> <span class="n">pya</span> <span class="o">/</span> <span class="mf">2.</span>
248    <span class="n">pyc</span> <span class="o">=</span> <span class="n">alist</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">-</span> <span class="n">alist</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">-</span> <span class="mf">7.</span> <span class="o">*</span> <span class="n">pya</span> <span class="o">/</span> <span class="mf">2.</span> <span class="o">-</span> <span class="mf">2.</span> <span class="o">*</span> <span class="n">pyb</span>
249    <span class="n">pyd</span> <span class="o">=</span> <span class="n">alist</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">-</span> <span class="n">pya</span> <span class="o">/</span> <span class="mf">4.</span> <span class="o">-</span> <span class="n">pyb</span> <span class="o">/</span> <span class="mf">3.</span> <span class="o">-</span> <span class="n">pyc</span> <span class="o">/</span> <span class="mf">2.</span>
250    <span class="n">nfield</span> <span class="o">=</span> <span class="mf">8.</span> <span class="o">*</span> <span class="n">pya</span> <span class="o">+</span> <span class="mf">4.</span> <span class="o">*</span> <span class="n">pyb</span> <span class="o">+</span> <span class="mf">2.</span> <span class="o">*</span> <span class="n">pyc</span> <span class="o">+</span> <span class="n">pyd</span>
251
252    <span class="k">return</span> <span class="n">nfield</span></div>
253
254
255<div class="viewcode-block" id="darain"><a class="viewcode-back" href="../api.html#disaggregation.darain">[docs]</a><span class="k">def</span> <span class="nf">darain</span><span class="p">(</span><span class="n">alist</span><span class="p">):</span>
256    <span class="sd">&quot;&quot;&quot;Linear interpolation of deaccumulated fluxes.</span>
257
258<span class="sd">    Interpolation of deaccumulated fluxes of an ECMWF model FG rainfall</span>
259<span class="sd">    field using a modified linear solution which conserves the integrals</span>
260<span class="sd">    of the fluxes within each timespan.</span>
261<span class="sd">    Disaggregation is done for 4 accumluated timespans which generates</span>
262<span class="sd">    a new, disaggregated value which is output at the central point</span>
263<span class="sd">    of the 4 accumulation timespans. This new point is used for linear</span>
264<span class="sd">    interpolation of the complete timeseries afterwards.</span>
265
266<span class="sd">    Parameters</span>
267<span class="sd">    ----------</span>
268<span class="sd">    alist : list of array of float</span>
269<span class="sd">        List of 4 timespans as 2-dimensional, horizontal fields.</span>
270<span class="sd">        E.g. [[array_t1], [array_t2], [array_t3], [array_t4]]</span>
271
272<span class="sd">    Return</span>
273<span class="sd">    ------</span>
274<span class="sd">    nfield : array of float</span>
275<span class="sd">        Interpolated flux at central point of accumulation timespan.</span>
276
277<span class="sd">    Note</span>
278<span class="sd">    ----</span>
279<span class="sd">    March 2000    : P. JAMES</span>
280<span class="sd">        Original author</span>
281
282<span class="sd">    June 2003     : A. BECK</span>
283<span class="sd">        Adaptations</span>
284
285<span class="sd">    November 2015 : Leopold Haimberger (University of Vienna)</span>
286<span class="sd">        Migration from Fortran to Python</span>
287<span class="sd">    &quot;&quot;&quot;</span>
288
289    <span class="n">xa</span> <span class="o">=</span> <span class="n">alist</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
290    <span class="n">xb</span> <span class="o">=</span> <span class="n">alist</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
291    <span class="n">xc</span> <span class="o">=</span> <span class="n">alist</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>
292    <span class="n">xd</span> <span class="o">=</span> <span class="n">alist</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span>
293    <span class="n">xa</span><span class="p">[</span><span class="n">xa</span> <span class="o">&lt;</span> <span class="mf">0.</span><span class="p">]</span> <span class="o">=</span> <span class="mf">0.</span>
294    <span class="n">xb</span><span class="p">[</span><span class="n">xb</span> <span class="o">&lt;</span> <span class="mf">0.</span><span class="p">]</span> <span class="o">=</span> <span class="mf">0.</span>
295    <span class="n">xc</span><span class="p">[</span><span class="n">xc</span> <span class="o">&lt;</span> <span class="mf">0.</span><span class="p">]</span> <span class="o">=</span> <span class="mf">0.</span>
296    <span class="n">xd</span><span class="p">[</span><span class="n">xd</span> <span class="o">&lt;</span> <span class="mf">0.</span><span class="p">]</span> <span class="o">=</span> <span class="mf">0.</span>
297
298    <span class="n">xac</span> <span class="o">=</span> <span class="mf">0.5</span> <span class="o">*</span> <span class="n">xb</span>
299    <span class="n">mask</span> <span class="o">=</span> <span class="n">xa</span> <span class="o">+</span> <span class="n">xc</span> <span class="o">&gt;</span> <span class="mf">0.</span>
300    <span class="n">xac</span><span class="p">[</span><span class="n">mask</span><span class="p">]</span> <span class="o">=</span> <span class="n">xb</span><span class="p">[</span><span class="n">mask</span><span class="p">]</span> <span class="o">*</span> <span class="n">xc</span><span class="p">[</span><span class="n">mask</span><span class="p">]</span> <span class="o">/</span> <span class="p">(</span><span class="n">xa</span><span class="p">[</span><span class="n">mask</span><span class="p">]</span> <span class="o">+</span> <span class="n">xc</span><span class="p">[</span><span class="n">mask</span><span class="p">])</span>
301    <span class="n">xbd</span> <span class="o">=</span> <span class="mf">0.5</span> <span class="o">*</span> <span class="n">xc</span>
302    <span class="n">mask</span> <span class="o">=</span> <span class="n">xb</span> <span class="o">+</span> <span class="n">xd</span> <span class="o">&gt;</span> <span class="mf">0.</span>
303    <span class="n">xbd</span><span class="p">[</span><span class="n">mask</span><span class="p">]</span> <span class="o">=</span> <span class="n">xb</span><span class="p">[</span><span class="n">mask</span><span class="p">]</span> <span class="o">*</span> <span class="n">xc</span><span class="p">[</span><span class="n">mask</span><span class="p">]</span> <span class="o">/</span> <span class="p">(</span><span class="n">xb</span><span class="p">[</span><span class="n">mask</span><span class="p">]</span> <span class="o">+</span> <span class="n">xd</span><span class="p">[</span><span class="n">mask</span><span class="p">])</span>
304    <span class="n">nfield</span> <span class="o">=</span> <span class="n">xac</span> <span class="o">+</span> <span class="n">xbd</span>
305
306    <span class="k">return</span> <span class="n">nfield</span></div>
307
308<div class="viewcode-block" id="IA3"><a class="viewcode-back" href="../api.html#disaggregation.IA3">[docs]</a><span class="k">def</span> <span class="nf">IA3</span><span class="p">(</span><span class="n">g</span><span class="p">):</span>
309    <span class="sd">&quot;&quot;&quot; Interpolation with a non-negative geometric mean based algorithm.</span>
310
311<span class="sd">    The original grid is reconstructed by adding two sampling points in each</span>
312<span class="sd">    data series interval. This subgrid is used to keep all information during</span>
313<span class="sd">    the interpolation within the associated interval. Additionally, an advanced</span>
314<span class="sd">    monotonicity filter is applied to improve the monotonicity properties of</span>
315<span class="sd">    the series.</span>
316
317<span class="sd">    Note</span>
318<span class="sd">    ----</span>
319<span class="sd">    (C) Copyright 2017-2019</span>
320<span class="sd">    Sabine Hittmeir, Anne Philipp, Petra Seibert</span>
321
322<span class="sd">    This work is licensed under the Creative Commons Attribution 4.0</span>
323<span class="sd">    International License. To view a copy of this license, visit</span>
324<span class="sd">    http://creativecommons.org/licenses/by/4.0/ or send a letter to</span>
325<span class="sd">    Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.</span>
326
327<span class="sd">    Parameters</span>
328<span class="sd">    ----------</span>
329<span class="sd">    g : list of float</span>
330<span class="sd">        Complete data series that will be interpolated having</span>
331<span class="sd">        the dimension of the original raw series.</span>
332
333<span class="sd">    Return</span>
334<span class="sd">    ------</span>
335<span class="sd">    f : list of float</span>
336<span class="sd">        The interpolated data series with additional subgrid points.</span>
337<span class="sd">        Its dimension is equal to the length of the input data series</span>
338<span class="sd">        times three.</span>
339
340
341<span class="sd">    References</span>
342<span class="sd">    ----------</span>
343<span class="sd">    For more information see article:</span>
344<span class="sd">    Hittmeir, S.; Philipp, A.; Seibert, P. (2017): A conservative</span>
345<span class="sd">    interpolation scheme for extensive quantities with application to the</span>
346<span class="sd">    Lagrangian particle dispersion model FLEXPART.,</span>
347<span class="sd">    Geoscientific Model Development</span>
348<span class="sd">    &quot;&quot;&quot;</span>
349
350    <span class="c1">#######################  variable description #############################</span>
351    <span class="c1">#                                                                         #</span>
352    <span class="c1"># i      - index variable for looping over the data series                #</span>
353    <span class="c1"># g      - input data series                                              #</span>
354    <span class="c1"># f      - interpolated and filtered data series with additional          #</span>
355    <span class="c1">#          grid points                                                    #</span>
356    <span class="c1"># fi     - function value at position i, f_i                              #</span>
357    <span class="c1"># fi1    - first  sub-grid function value f_i^1                           #</span>
358    <span class="c1"># fi2    - second sub-grid function value f_i^2                           #</span>
359    <span class="c1"># fip1   - next function value at position i+1, f_(i+1)                   #</span>
360    <span class="c1"># dt     - time step                                                      #</span>
361    <span class="c1"># fmon   - monotonicity filter                                            #</span>
362    <span class="c1">#                                                                         #</span>
363    <span class="c1">###########################################################################</span>
364
365
366    <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
367
368    <span class="c1"># time step</span>
369    <span class="n">dt</span> <span class="o">=</span> <span class="mf">1.0</span>
370
371    <span class="c1">############### Non-negative Geometric Mean Based Algorithm ###############</span>
372
373    <span class="c1"># for the left boundary the following boundary condition is valid:</span>
374    <span class="c1"># the value at t=0 of the interpolation algorithm coincides with the</span>
375    <span class="c1"># first data value according to the persistence hypothesis</span>
376    <span class="n">f</span> <span class="o">=</span> <span class="p">[</span><span class="n">g</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span>
377
378    <span class="c1"># compute two first sub-grid intervals without monotonicity check</span>
379    <span class="c1"># go through the data series and extend each interval by two sub-grid</span>
380    <span class="c1"># points and interpolate the corresponding data values</span>
381    <span class="c1"># except for the last interval due to boundary conditions</span>
382    <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">2</span><span class="p">):</span>
383
384        <span class="c1"># as a requirement:</span>
385        <span class="c1"># if there is a zero data value such that g[i]=0, then the whole</span>
386        <span class="c1"># interval in f has to be zero to such that f[i+1]=f[i+2]=f[i+3]=0</span>
387        <span class="c1"># according to Eq. (6)</span>
388        <span class="k">if</span> <span class="n">g</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">==</span> <span class="mf">0.</span><span class="p">:</span>
389            <span class="n">f</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span><span class="mf">0.</span><span class="p">,</span> <span class="mf">0.</span><span class="p">,</span> <span class="mf">0.</span><span class="p">])</span>
390
391        <span class="c1"># otherwise the sub-grid values are calculated and added to the list</span>
392        <span class="k">else</span><span class="p">:</span>
393            <span class="c1"># temporal save of last value in interpolated list</span>
394            <span class="c1"># since it is the left boundary and hence the new (fi) value</span>
395            <span class="n">fi</span> <span class="o">=</span> <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
396
397            <span class="c1"># the value at the end of the interval (fip1) is prescribed by the</span>
398            <span class="c1"># geometric mean, restricted such that non-negativity is guaranteed</span>
399            <span class="c1"># according to Eq. (25)</span>
400            <span class="n">fip1</span><span class="o">=</span><span class="nb">min</span><span class="p">(</span> <span class="mf">3.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="p">,</span> <span class="mf">3.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="n">i</span><span class="o">+</span><span class="mi">1</span><span class="p">]</span> <span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">g</span><span class="p">[</span><span class="n">i</span><span class="o">+</span><span class="mi">1</span><span class="p">]</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="n">i</span><span class="p">])</span> <span class="p">)</span>
401
402            <span class="c1"># the function value at the first sub-grid point (fi1) is determined</span>
403            <span class="c1"># according to the equal area condition with Eq. (19)</span>
404            <span class="n">fi1</span> <span class="o">=</span> <span class="mf">3.</span><span class="o">/</span><span class="mf">2.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="n">i</span><span class="p">]</span><span class="o">-</span><span class="mf">5.</span><span class="o">/</span><span class="mf">12.</span><span class="o">*</span><span class="n">fip1</span><span class="o">-</span><span class="mf">1.</span><span class="o">/</span><span class="mf">12.</span><span class="o">*</span><span class="n">fi</span>
405
406            <span class="c1"># the function value at the second sub-grid point (fi2) is determined</span>
407            <span class="c1"># according Eq. (18)</span>
408            <span class="n">fi2</span> <span class="o">=</span> <span class="n">fi1</span><span class="o">+</span><span class="mf">1.</span><span class="o">/</span><span class="mf">3.</span><span class="o">*</span><span class="p">(</span><span class="n">fip1</span><span class="o">-</span><span class="n">fi</span><span class="p">)</span>
409
410            <span class="c1"># add next interval of interpolated (sub-)grid values</span>
411            <span class="n">f</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">fi1</span><span class="p">)</span>
412            <span class="n">f</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">fi2</span><span class="p">)</span>
413            <span class="n">f</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">fip1</span><span class="p">)</span>
414
415    <span class="c1"># compute rest of the data series intervals</span>
416    <span class="c1"># go through the data series and extend each interval by two sub-grid</span>
417    <span class="c1"># points and interpolate the corresponding data values</span>
418    <span class="c1"># except for the last interval due to boundary conditions</span>
419    <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">g</span><span class="p">)</span><span class="o">-</span><span class="mi">1</span><span class="p">):</span>
420
421        <span class="c1"># as a requirement:</span>
422        <span class="c1"># if there is a zero data value such that g[i]=0, then the whole</span>
423        <span class="c1"># interval in f has to be zero to such that f[i+1]=f[i+2]=f[i+3]=0</span>
424        <span class="c1"># according to Eq. (6)</span>
425        <span class="k">if</span> <span class="n">g</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">==</span> <span class="mf">0.</span><span class="p">:</span>
426            <span class="c1"># apply monotonicity filter for interval before</span>
427            <span class="c1"># check if there is &quot;M&quot; or &quot;W&quot; shape</span>
428            <span class="k">if</span>     <span class="n">np</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">5</span><span class="p">]</span><span class="o">-</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">6</span><span class="p">])</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">4</span><span class="p">]</span><span class="o">-</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">5</span><span class="p">])</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span> \
429               <span class="ow">and</span> <span class="n">np</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">4</span><span class="p">]</span><span class="o">-</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">5</span><span class="p">])</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span><span class="o">-</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">4</span><span class="p">])</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span> \
430               <span class="ow">and</span> <span class="n">np</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span><span class="o">-</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">4</span><span class="p">])</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span><span class="o">-</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">])</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span><span class="p">:</span>
431
432                <span class="c1"># the monotonicity filter corrects the value at (fim1) by</span>
433                <span class="c1"># substituting (fim1) with (fmon), see Eq. (27), (28) and (29)</span>
434                <span class="n">fmon</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="mf">3.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="n">i</span><span class="o">-</span><span class="mi">2</span><span class="p">],</span> \
435                           <span class="mf">3.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="n">i</span><span class="o">-</span><span class="mi">1</span><span class="p">],</span> \
436                           <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="nb">max</span><span class="p">(</span><span class="mi">0</span><span class="p">,(</span><span class="mf">18.</span><span class="o">/</span><span class="mf">13.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="n">i</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span> <span class="o">-</span> <span class="mf">5.</span><span class="o">/</span><span class="mf">13.</span><span class="o">*</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">7</span><span class="p">])</span> <span class="o">*</span>
437                                         <span class="p">(</span><span class="mf">18.</span><span class="o">/</span><span class="mf">13.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="n">i</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">-</span> <span class="mf">5.</span><span class="o">/</span><span class="mf">13.</span><span class="o">*</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]))))</span>
438
439                <span class="c1"># recomputation of the sub-grid interval values while the</span>
440                <span class="c1"># interval boundaries (fi) and (fip2) remains unchanged</span>
441                <span class="c1"># see Eq. (18) and (19)</span>
442                <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">4</span><span class="p">]</span> <span class="o">=</span> <span class="n">fmon</span>
443                <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">6</span><span class="p">]</span> <span class="o">=</span> <span class="mf">3.</span><span class="o">/</span><span class="mf">2.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="n">i</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span><span class="o">-</span><span class="mf">5.</span><span class="o">/</span><span class="mf">12.</span><span class="o">*</span><span class="n">fmon</span><span class="o">-</span><span class="mf">1.</span><span class="o">/</span><span class="mf">12.</span><span class="o">*</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">7</span><span class="p">]</span>
444                <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">5</span><span class="p">]</span> <span class="o">=</span> <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">6</span><span class="p">]</span><span class="o">+</span><span class="p">(</span><span class="n">fmon</span><span class="o">-</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">7</span><span class="p">])</span><span class="o">/</span><span class="mf">3.</span>
445                <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span> <span class="o">=</span> <span class="mf">3.</span><span class="o">/</span><span class="mf">2.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="n">i</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">-</span><span class="mf">5.</span><span class="o">/</span><span class="mf">12.</span><span class="o">*</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">-</span><span class="mf">1.</span><span class="o">/</span><span class="mf">12.</span><span class="o">*</span><span class="n">fmon</span>
446                <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span> <span class="o">=</span> <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span><span class="o">+</span><span class="p">(</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">-</span><span class="n">fmon</span><span class="p">)</span><span class="o">/</span><span class="mf">3.</span>
447
448            <span class="n">f</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span><span class="mf">0.</span><span class="p">,</span><span class="mf">0.</span><span class="p">,</span><span class="mf">0.</span><span class="p">])</span>
449
450        <span class="c1"># otherwise the sub-grid values are calculated and added to the list</span>
451        <span class="k">else</span><span class="p">:</span>
452            <span class="c1"># temporal save of last value in interpolated list</span>
453            <span class="c1"># since it is the left boundary and hence the new (fi) value</span>
454            <span class="n">fi</span> <span class="o">=</span> <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
455
456            <span class="c1"># the value at the end of the interval (fip1) is prescribed by the</span>
457            <span class="c1"># geometric mean, restricted such that non-negativity is guaranteed</span>
458            <span class="c1"># according to Eq. (25)</span>
459            <span class="n">fip1</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span> <span class="mf">3.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="p">,</span> <span class="mf">3.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="n">i</span><span class="o">+</span><span class="mi">1</span><span class="p">]</span> <span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">g</span><span class="p">[</span><span class="n">i</span><span class="o">+</span><span class="mi">1</span><span class="p">]</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="n">i</span><span class="p">])</span> <span class="p">)</span>
460
461            <span class="c1"># the function value at the first sub-grid point (fi1) is determined</span>
462            <span class="c1"># according to the equal area condition with Eq. (19)</span>
463            <span class="n">fi1</span> <span class="o">=</span> <span class="mf">3.</span><span class="o">/</span><span class="mf">2.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="n">i</span><span class="p">]</span><span class="o">-</span><span class="mf">5.</span><span class="o">/</span><span class="mf">12.</span><span class="o">*</span><span class="n">fip1</span><span class="o">-</span><span class="mf">1.</span><span class="o">/</span><span class="mf">12.</span><span class="o">*</span><span class="n">fi</span>
464
465            <span class="c1"># the function value at the second sub-grid point (fi2) is determined</span>
466            <span class="c1"># according Eq. (18)</span>
467            <span class="n">fi2</span> <span class="o">=</span> <span class="n">fi1</span><span class="o">+</span><span class="mf">1.</span><span class="o">/</span><span class="mf">3.</span><span class="o">*</span><span class="p">(</span><span class="n">fip1</span><span class="o">-</span><span class="n">fi</span><span class="p">)</span>
468
469            <span class="c1"># apply monotonicity filter for interval before</span>
470            <span class="c1"># check if there is &quot;M&quot; or &quot;W&quot; shape</span>
471            <span class="k">if</span>     <span class="n">np</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">5</span><span class="p">]</span><span class="o">-</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">6</span><span class="p">])</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">4</span><span class="p">]</span><span class="o">-</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">5</span><span class="p">])</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span> \
472               <span class="ow">and</span> <span class="n">np</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">4</span><span class="p">]</span><span class="o">-</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">5</span><span class="p">])</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span><span class="o">-</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">4</span><span class="p">])</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span> \
473               <span class="ow">and</span> <span class="n">np</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span><span class="o">-</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">4</span><span class="p">])</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span><span class="o">-</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">])</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span><span class="p">:</span>
474
475                <span class="c1"># the monotonicity filter corrects the value at (fim1) by</span>
476                <span class="c1"># substituting (fim1) with fmon, see Eq. (27), (28) and (29)</span>
477                <span class="n">fmon</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="mf">3.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="n">i</span><span class="o">-</span><span class="mi">2</span><span class="p">],</span> \
478                           <span class="mf">3.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="n">i</span><span class="o">-</span><span class="mi">1</span><span class="p">],</span> \
479                           <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="nb">max</span><span class="p">(</span><span class="mi">0</span><span class="p">,(</span><span class="mf">18.</span><span class="o">/</span><span class="mf">13.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="n">i</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span> <span class="o">-</span> <span class="mf">5.</span><span class="o">/</span><span class="mf">13.</span><span class="o">*</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">7</span><span class="p">])</span> <span class="o">*</span>
480                                         <span class="p">(</span><span class="mf">18.</span><span class="o">/</span><span class="mf">13.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="n">i</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">-</span> <span class="mf">5.</span><span class="o">/</span><span class="mf">13.</span><span class="o">*</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]))))</span>
481
482                <span class="c1"># recomputation of the sub-grid interval values while the</span>
483                <span class="c1"># interval boundaries (fi) and (fip2) remains unchanged</span>
484                <span class="c1"># see Eq. (18) and (19)</span>
485                <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">4</span><span class="p">]</span> <span class="o">=</span> <span class="n">fmon</span>
486                <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">6</span><span class="p">]</span> <span class="o">=</span> <span class="mf">3.</span><span class="o">/</span><span class="mf">2.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="n">i</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span><span class="o">-</span><span class="mf">5.</span><span class="o">/</span><span class="mf">12.</span><span class="o">*</span><span class="n">fmon</span><span class="o">-</span><span class="mf">1.</span><span class="o">/</span><span class="mf">12.</span><span class="o">*</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">7</span><span class="p">]</span>
487                <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">5</span><span class="p">]</span> <span class="o">=</span> <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">6</span><span class="p">]</span><span class="o">+</span><span class="p">(</span><span class="n">fmon</span><span class="o">-</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">7</span><span class="p">])</span><span class="o">/</span><span class="mf">3.</span>
488                <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span> <span class="o">=</span> <span class="mf">3.</span><span class="o">/</span><span class="mf">2.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="n">i</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">-</span><span class="mf">5.</span><span class="o">/</span><span class="mf">12.</span><span class="o">*</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">-</span><span class="mf">1.</span><span class="o">/</span><span class="mf">12.</span><span class="o">*</span><span class="n">fmon</span>
489                <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span> <span class="o">=</span> <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span><span class="o">+</span><span class="p">(</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">-</span><span class="n">fmon</span><span class="p">)</span><span class="o">/</span><span class="mf">3.</span>
490
491            <span class="c1"># add next interval of interpolated (sub-)grid values</span>
492            <span class="n">f</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">fi1</span><span class="p">)</span>
493            <span class="n">f</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">fi2</span><span class="p">)</span>
494            <span class="n">f</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">fip1</span><span class="p">)</span>
495
496    <span class="c1"># separate treatment of the final interval</span>
497
498    <span class="c1"># as a requirement:</span>
499    <span class="c1"># if there is a zero data value such that g[i]=0, then the whole</span>
500    <span class="c1"># interval in f has to be zero to such that f[i+1]=f[i+2]=f[i+3]=0</span>
501    <span class="c1"># according to Eq. (6)</span>
502    <span class="k">if</span> <span class="n">g</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="mf">0.</span><span class="p">:</span>
503        <span class="c1"># apply monotonicity filter for interval before</span>
504        <span class="c1"># check if there is &quot;M&quot; or &quot;W&quot; shape</span>
505        <span class="k">if</span>     <span class="n">np</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">5</span><span class="p">]</span><span class="o">-</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">6</span><span class="p">])</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">4</span><span class="p">]</span><span class="o">-</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">5</span><span class="p">])</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span> \
506           <span class="ow">and</span> <span class="n">np</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">4</span><span class="p">]</span><span class="o">-</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">5</span><span class="p">])</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span><span class="o">-</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">4</span><span class="p">])</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span> \
507           <span class="ow">and</span> <span class="n">np</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span><span class="o">-</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">4</span><span class="p">])</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span><span class="o">-</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">])</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span><span class="p">:</span>
508
509            <span class="c1"># the monotonicity filter corrects the value at (fim1) by</span>
510            <span class="c1"># substituting (fim1) with (fmon), see Eq. (27), (28) and (29)</span>
511            <span class="n">fmon</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="mf">3.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">],</span> \
512                       <span class="mf">3.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="o">-</span><span class="mi">2</span><span class="p">],</span> \
513                       <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="nb">max</span><span class="p">(</span><span class="mi">0</span><span class="p">,(</span><span class="mf">18.</span><span class="o">/</span><span class="mf">13.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span> <span class="o">-</span> <span class="mf">5.</span><span class="o">/</span><span class="mf">13.</span><span class="o">*</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">7</span><span class="p">])</span> <span class="o">*</span>
514                                     <span class="p">(</span><span class="mf">18.</span><span class="o">/</span><span class="mf">13.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span> <span class="o">-</span> <span class="mf">5.</span><span class="o">/</span><span class="mf">13.</span><span class="o">*</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]))))</span>
515
516            <span class="c1"># recomputation of the sub-grid interval values while the</span>
517            <span class="c1"># interval boundaries (fi) and (fip2) remains unchanged</span>
518            <span class="c1"># see Eq. (18) and (19)</span>
519            <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">4</span><span class="p">]</span> <span class="o">=</span> <span class="n">fmon</span>
520            <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">6</span><span class="p">]</span> <span class="o">=</span> <span class="mf">3.</span><span class="o">/</span><span class="mf">2.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span><span class="o">-</span><span class="mf">5.</span><span class="o">/</span><span class="mf">12.</span><span class="o">*</span><span class="n">fmon</span><span class="o">-</span><span class="mf">1.</span><span class="o">/</span><span class="mf">12.</span><span class="o">*</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">7</span><span class="p">]</span>
521            <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">5</span><span class="p">]</span> <span class="o">=</span> <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">6</span><span class="p">]</span><span class="o">+</span><span class="p">(</span><span class="n">fmon</span><span class="o">-</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">7</span><span class="p">])</span><span class="o">/</span><span class="mf">3.</span>
522            <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span> <span class="o">=</span> <span class="mf">3.</span><span class="o">/</span><span class="mf">2.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span><span class="o">-</span><span class="mf">5.</span><span class="o">/</span><span class="mf">12.</span><span class="o">*</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">-</span><span class="mf">1.</span><span class="o">/</span><span class="mf">12.</span><span class="o">*</span><span class="n">fmon</span>
523            <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span> <span class="o">=</span> <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span><span class="o">+</span><span class="p">(</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">-</span><span class="n">fmon</span><span class="p">)</span><span class="o">/</span><span class="mf">3.</span>
524
525        <span class="n">f</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span><span class="mf">0.</span><span class="p">,</span><span class="mf">0.</span><span class="p">,</span><span class="mf">0.</span><span class="p">])</span>
526
527    <span class="c1"># otherwise the sub-grid values are calculated and added to the list</span>
528    <span class="c1"># using the persistence hypothesis as boundary condition</span>
529    <span class="k">else</span><span class="p">:</span>
530        <span class="c1"># temporal save of last value in interpolated list</span>
531        <span class="c1"># since it is the left boundary and hence the new (fi) value</span>
532        <span class="n">fi</span> <span class="o">=</span> <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
533        <span class="c1"># since last interval in series, last value is also fip1</span>
534        <span class="n">fip1</span> <span class="o">=</span> <span class="n">g</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
535        <span class="c1"># the function value at the first sub-grid point (fi1) is determined</span>
536        <span class="c1"># according to the equal area condition with Eq. (19)</span>
537        <span class="n">fi1</span> <span class="o">=</span> <span class="mf">3.</span><span class="o">/</span><span class="mf">2.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">-</span><span class="mf">5.</span><span class="o">/</span><span class="mf">12.</span><span class="o">*</span><span class="n">fip1</span><span class="o">-</span><span class="mf">1.</span><span class="o">/</span><span class="mf">12.</span><span class="o">*</span><span class="n">fi</span>
538        <span class="c1"># the function value at the second sub-grid point (fi2) is determined</span>
539        <span class="c1"># according Eq. (18)</span>
540        <span class="n">fi2</span> <span class="o">=</span> <span class="n">fi1</span><span class="o">+</span><span class="n">dt</span><span class="o">/</span><span class="mf">3.</span><span class="o">*</span><span class="p">(</span><span class="n">fip1</span><span class="o">-</span><span class="n">fi</span><span class="p">)</span>
541
542        <span class="c1"># apply monotonicity filter for interval before</span>
543        <span class="c1"># check if there is &quot;M&quot; or &quot;W&quot; shape</span>
544        <span class="k">if</span>     <span class="n">np</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">5</span><span class="p">]</span><span class="o">-</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">6</span><span class="p">])</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">4</span><span class="p">]</span><span class="o">-</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">5</span><span class="p">])</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span> \
545           <span class="ow">and</span> <span class="n">np</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">4</span><span class="p">]</span><span class="o">-</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">5</span><span class="p">])</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span><span class="o">-</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">4</span><span class="p">])</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span> \
546           <span class="ow">and</span> <span class="n">np</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span><span class="o">-</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">4</span><span class="p">])</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span><span class="o">-</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">])</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span><span class="p">:</span>
547
548            <span class="c1"># the monotonicity filter corrects the value at (fim1) by</span>
549            <span class="c1"># substituting (fim1) with (fmon), see Eq. (27), (28) and (29)</span>
550            <span class="n">fmon</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="mf">3.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">],</span> \
551                       <span class="mf">3.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="o">-</span><span class="mi">2</span><span class="p">],</span> \
552                       <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="nb">max</span><span class="p">(</span><span class="mi">0</span><span class="p">,(</span><span class="mf">18.</span><span class="o">/</span><span class="mf">13.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span> <span class="o">-</span> <span class="mf">5.</span><span class="o">/</span><span class="mf">13.</span><span class="o">*</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">7</span><span class="p">])</span> <span class="o">*</span>
553                                     <span class="p">(</span><span class="mf">18.</span><span class="o">/</span><span class="mf">13.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span> <span class="o">-</span> <span class="mf">5.</span><span class="o">/</span><span class="mf">13.</span><span class="o">*</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]))))</span>
554
555            <span class="c1"># recomputation of the sub-grid interval values while the</span>
556            <span class="c1"># interval boundaries (fi) and (fip2) remains unchanged</span>
557            <span class="c1"># see Eq. (18) and (19)</span>
558            <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">4</span><span class="p">]</span> <span class="o">=</span> <span class="n">fmon</span>
559            <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">6</span><span class="p">]</span> <span class="o">=</span> <span class="mf">3.</span><span class="o">/</span><span class="mf">2.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span><span class="o">-</span><span class="mf">5.</span><span class="o">/</span><span class="mf">12.</span><span class="o">*</span><span class="n">fmon</span><span class="o">-</span><span class="mf">1.</span><span class="o">/</span><span class="mf">12.</span><span class="o">*</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">7</span><span class="p">]</span>
560            <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">5</span><span class="p">]</span> <span class="o">=</span> <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">6</span><span class="p">]</span><span class="o">+</span><span class="p">(</span><span class="n">fmon</span><span class="o">-</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">7</span><span class="p">])</span><span class="o">/</span><span class="mf">3.</span>
561            <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span> <span class="o">=</span> <span class="mf">3.</span><span class="o">/</span><span class="mf">2.</span><span class="o">*</span><span class="n">g</span><span class="p">[</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span><span class="o">-</span><span class="mf">5.</span><span class="o">/</span><span class="mf">12.</span><span class="o">*</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">-</span><span class="mf">1.</span><span class="o">/</span><span class="mf">12.</span><span class="o">*</span><span class="n">fmon</span>
562            <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span> <span class="o">=</span> <span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span><span class="o">+</span><span class="p">(</span><span class="n">f</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">-</span><span class="n">fmon</span><span class="p">)</span><span class="o">/</span><span class="mf">3.</span>
563
564        <span class="c1"># add next interval of interpolated (sub-)grid values</span>
565        <span class="n">f</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">fi1</span><span class="p">)</span>
566        <span class="n">f</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">fi2</span><span class="p">)</span>
567        <span class="n">f</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">fip1</span><span class="p">)</span>
568
569    <span class="k">return</span> <span class="n">f</span></div>
570</pre></div>
571
572           </div>
573           
574          </div>
575          <footer>
576 
577
578  <hr/>
579
580  <div role="contentinfo">
581    <p>
582        &copy; Copyright 2018, Anne Philipp and Leopold Haimberger
583
584    </p>
585  </div>
586  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
587
588</footer>
589
590        </div>
591      </div>
592
593    </section>
594
595  </div>
596 
597
598
599 
600
601   
602   
603      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
604        <script type="text/javascript" src="../_static/jquery.js"></script>
605        <script type="text/javascript" src="../_static/underscore.js"></script>
606        <script type="text/javascript" src="../_static/doctools.js"></script>
607   
608
609 
610
611  <script type="text/javascript" src="../_static/js/theme.js"></script>
612
613  <script type="text/javascript">
614      jQuery(function () {
615          SphinxRtdTheme.Navigation.enable(true);
616      });
617  </script> 
618
619</body>
620</html>
Note: See TracBrowser for help on using the repository browser.
hosted by ZAMG