OOPS
l95/src/lorenz95/ObsBias.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 LORENZ95_OBSBIAS_H_
12 #define LORENZ95_OBSBIAS_H_
13 
14 #include <cmath>
15 #include <string>
16 #include <boost/noncopyable.hpp>
17 
18 #include "oops/base/Variables.h"
19 #include "oops/util/ObjectCounter.h"
20 #include "oops/util/Printable.h"
21 
22 namespace eckit {
23  class Configuration;
24 }
25 
26 namespace lorenz95 {
27  class ObsBiasCorrection;
28  class ObsTableView;
29 
30 /// Class to handle observation bias parameters.
31 
32 // -----------------------------------------------------------------------------
33 
34 class ObsBias : public util::Printable,
35  private boost::noncopyable,
36  private util::ObjectCounter<ObsBias> {
37  public:
38  static const std::string classname() {return "lorenz95::ObsBias";}
39 
40  ObsBias(const ObsTableView &, const eckit::Configuration &);
41  ObsBias(const ObsBias &, const bool);
42  ~ObsBias() {}
43 
45  ObsBias & operator=(const ObsBias &);
46 
47  const double & value() const {return bias_;}
48  double & value() {return bias_;}
49 
50 /// I/O and diagnostics
51  void read(const eckit::Configuration &) {}
52  void write(const eckit::Configuration &) const {}
53  double norm() const {return std::abs(bias_);}
54 
55 /// Other
56  const oops::Variables & requiredVars() const {return geovars_;}
57  const oops::Variables & requiredHdiagnostics() const {return hdiags_;}
58 
59  private:
60  void print(std::ostream &) const;
61  double bias_;
62  bool active_;
65 };
66 
67 // -----------------------------------------------------------------------------
68 
69 } // namespace lorenz95
70 
71 #endif // LORENZ95_OBSBIAS_H_
lorenz95::ObsBias::geovars_
const oops::Variables geovars_
Definition: l95/src/lorenz95/ObsBias.h:63
lorenz95::ObsBias
Class to handle observation bias parameters.
Definition: l95/src/lorenz95/ObsBias.h:36
lorenz95::ObsBias::bias_
double bias_
Definition: l95/src/lorenz95/ObsBias.h:61
lorenz95::ObsBias::classname
static const std::string classname()
Definition: l95/src/lorenz95/ObsBias.h:38
lorenz95::ObsBias::requiredVars
const oops::Variables & requiredVars() const
Other.
Definition: l95/src/lorenz95/ObsBias.h:56
lorenz95::ObsBias::write
void write(const eckit::Configuration &) const
Definition: l95/src/lorenz95/ObsBias.h:52
eckit
Definition: FieldL95.h:22
lorenz95::ObsBias::ObsBias
ObsBias(const ObsTableView &, const eckit::Configuration &)
Definition: l95/src/lorenz95/ObsBias.cc:23
lorenz95::ObsBias::hdiags_
const oops::Variables hdiags_
Definition: l95/src/lorenz95/ObsBias.h:64
lorenz95::ObsBias::operator+=
ObsBias & operator+=(const ObsBiasCorrection &)
Definition: l95/src/lorenz95/ObsBias.cc:43
lorenz95::ObsBias::active_
bool active_
Definition: l95/src/lorenz95/ObsBias.h:62
lorenz95::ObsBias::value
double & value()
Definition: l95/src/lorenz95/ObsBias.h:48
lorenz95::ObsBias::value
const double & value() const
Definition: l95/src/lorenz95/ObsBias.h:47
lorenz95::ObsBias::operator=
ObsBias & operator=(const ObsBias &)
Definition: l95/src/lorenz95/ObsBias.cc:48
lorenz95::ObsBias::print
void print(std::ostream &) const
Definition: l95/src/lorenz95/ObsBias.cc:53
lorenz95::ObsTableView
A Simple Observation Data Handler.
Definition: ObsTableView.h:38
lorenz95::ObsBias::requiredHdiagnostics
const oops::Variables & requiredHdiagnostics() const
Definition: l95/src/lorenz95/ObsBias.h:57
oops::Variables
Definition: oops/base/Variables.h:23
lorenz95::ObsBias::read
void read(const eckit::Configuration &)
I/O and diagnostics.
Definition: l95/src/lorenz95/ObsBias.h:51
lorenz95
The namespace for the L95 model.
Definition: l95/src/lorenz95/AnalyticInit.cc:17
lorenz95::ObsBiasCorrection
Definition: ObsBiasCorrection.h:32
Variables.h
lorenz95::ObsBias::~ObsBias
~ObsBias()
Definition: l95/src/lorenz95/ObsBias.h:42
lorenz95::ObsBias::norm
double norm() const
Definition: l95/src/lorenz95/ObsBias.h:53