Debian Codegraph @

src/atlas/field/FieldCreatorIFS.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
8 * nor does it submit to any jurisdiction.
9 */
10
11 /// @author Willem Deconinck
12 /// @date June 2015
13
14 #pragma once
15
16 #include "atlas/field/FieldCreator.h"
17
18 namespace eckit {
19 class Parametrisation;
20 }
21 namespace atlas {
22 namespace field {
23 class FieldImpl;
24 }
25 } // namespace atlas
26
27 namespace atlas {
28 namespace field {
29
30 // ------------------------------------------------------------------
31
32 /*!
33 * \brief Field creator using IFS parametrisation
34 * \details
35 * Ideally this class should belong to IFS.
36 * The only reference to IFS in Atlas should be here.
37 * Example use:
38 * \code{.cpp}
39 * FieldImpl* field = Field::create(
40 * Config
41 * ("creator","IFS") // IFS FieldCreator
42 * ("ngptot",ngptot) // Total number of grid points
43 * ("nproma",nproma) // Grouping of grid points for vectorlength
44 * ("nlev",nlev) // Number of levels
45 * ("nvar",nvar) // Number of variables
46 * ("kind",8) // Real kind in bytes
47 * );
48 * \endcode
49 */
50 class FieldCreatorIFS : public FieldCreator {
51 public:
52 FieldCreatorIFS() {}
53 FieldCreatorIFS(const eckit::Parametrisation&) {}
54 virtual FieldImpl* createField(const eckit::Parametrisation&) const;
55 };
56
57 // ------------------------------------------------------------------
58
59 } // namespace field
60 } // namespace atlas