FV3 Bundle
overview.h
Go to the documentation of this file.
1 /*
2  * (C) Copyright 2009-2016 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 #ifndef DOCUMENTS_OVERVIEW_H_
12 #define DOCUMENTS_OVERVIEW_H_
13 
14 // This file defines what appears on the "Related Pages" part of the
15 // documentation generated by doxygen. This file contains no code, and does
16 // not appear in any cpp include statement.
17 //
18 /*!
19  * \page Overview Overview
20  * This page is still under development!
21  *
22  * Over time, we aim to have a collection of documents that describe the
23  * high-level structure of OOPS. Currently, we have the following:
24  *
25  * <A HREF="../two_level_qg.pdf">A short description of the two-level
26  * quasi-geostrophic model</A>.
27  *
28  * <A HREF="../weak_4dvar.pdf">Formulation of Weak Constraint 4D-Var</A>.
29  *
30  * <A HREF="../solvers.pdf">Documentation of the OOPS Linear Equation
31  * Solvers</A>.
32  *
33  *
34  */
35 #endif // DOCUMENTS_OVERVIEW_H_