Debian Codegraph @

src/atlas/util/function/VortexRollup.h

raw
1 /*
2 * (C) Copyright 2013 ECMWF.
3 *
4 * This software is licensed under the terms of the Apache Licence Version 2.0
5 * which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
6 * In applying this licence, ECMWF does not waive the privileges and immunities
7 * granted to it by virtue of its status as an intergovernmental organisation nor
8 * does it submit to any jurisdiction.
9 */
10
11
12 #pragma once
13
14 namespace atlas {
15
16 namespace util {
17
18 namespace function {
19
20 /// \brief An analytic function that provides a vortex rollup on a 2D sphere
21 ///
22 /// \detailed The formula is found in
23 /// "A Lagrangian Particle Method with Remeshing for Tracer Transport on the Sphere"
24 /// by Peter Bosler, James Kent, Robert Krasny, Christiane Jablonowski, JCP 2015
25 /// as the tracer density in Test Case 1.
26 /// The longitude (lon) and latitude (lat) are assumed to be in degrees,
27 /// The time parameter associated with the vortex rollup is set by (t).
28 ///
29 /// The time it takes for the counter-rotating vortices along
30 /// the equator to return to its original position takes
31 /// time t = 1.0;
32 ///
33 double vortex_rollup(double lon, double lat, double t);
34
35 } // namespace function
36
37 } // namespace util
38
39 } // namespace atlas