OOPS
ObsBiasIncrement.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 QG_MODEL_OBSBIASINCREMENT_H_
12 #define QG_MODEL_OBSBIASINCREMENT_H_
13 
14 #include <iostream>
15 #include <vector>
16 
17 #include "oops/util/Printable.h"
18 #include "oops/util/Serializable.h"
19 
20 namespace eckit {
21  class Configuration;
22 }
23 
24 namespace qg {
25  class ObsBias;
26  class ObsSpaceQG;
27 
28 // -----------------------------------------------------------------------------
29 
30 class ObsBiasIncrement : public util::Printable,
31  public util::Serializable {
32  public:
33 /// Constructor, destructor
35  ObsBiasIncrement(const ObsSpaceQG &, const eckit::Configuration &);
36  ObsBiasIncrement(const ObsBiasIncrement &, const bool copy = true);
37  ObsBiasIncrement(const ObsBiasIncrement &, const eckit::Configuration &);
39 
40 /// Linear algebra operators
41  void diff(const ObsBias &, const ObsBias &);
42  void zero();
46  ObsBiasIncrement & operator*=(const double);
47  void axpy(const double, const ObsBiasIncrement &);
48  double dot_product_with(const ObsBiasIncrement &) const;
49 
50 /// I/O and diagnostics
51  void read(const eckit::Configuration &) {}
52  void write(const eckit::Configuration &) const {}
53  double norm() const;
54 
55  double & operator[](const unsigned int ii) {return bias_[ii];}
56  const double & operator[](const unsigned int ii) const {return bias_[ii];}
57 
58  double & stream() {return bias_[0];}
59  double & wind() {return bias_[1];}
60  double & wspd() {return bias_[3];}
61  const double & stream() const {return bias_[0];}
62  const double & wind() const {return bias_[1];}
63  const double & wspd() const {return bias_[3];}
64 
65 /// Serialization
66  size_t serialSize() const override;
67  void serialize(std::vector<double> &) const override;
68  void deserialize(const std::vector<double> &, size_t &) override;
69 
70  private:
71  void print(std::ostream &) const override;
72  void makePassive();
73 
74  std::vector<double> bias_;
75  std::vector<bool> active_;
76 };
77 
78 // -----------------------------------------------------------------------------
79 
80 } // namespace qg
81 
82 #endif // QG_MODEL_OBSBIASINCREMENT_H_
qg::ObsBiasIncrement::dot_product_with
double dot_product_with(const ObsBiasIncrement &) const
Definition: ObsBiasIncrement.cc:114
qg::ObsBiasIncrement::wind
double & wind()
Definition: ObsBiasIncrement.h:59
qg
The namespace for the qg model.
Definition: qg/model/AnalyticInit.cc:13
qg::ObsBiasIncrement::stream
double & stream()
Definition: ObsBiasIncrement.h:58
qg::ObsBiasIncrement::makePassive
void makePassive()
Definition: ObsBiasIncrement.cc:68
qg::ObsBiasIncrement::ObsBiasIncrement
ObsBiasIncrement()
Constructor, destructor.
qg::ObsBiasIncrement::operator-=
ObsBiasIncrement & operator-=(const ObsBiasIncrement &)
Definition: ObsBiasIncrement.cc:97
qg::ObsBias
Class to handle observation bias parameters.
Definition: qg/model/ObsBias.h:37
qg::ObsBiasIncrement::zero
void zero()
Definition: ObsBiasIncrement.cc:81
qg::ObsBiasIncrement::read
void read(const eckit::Configuration &)
I/O and diagnostics.
Definition: ObsBiasIncrement.h:51
qg::ObsBiasIncrement::active_
std::vector< bool > active_
Definition: ObsBiasIncrement.h:75
qg::ObsSpaceQG
ObsSpace for QG model.
Definition: ObsSpaceQG.h:44
qg::ObsBiasIncrement::write
void write(const eckit::Configuration &) const
Definition: ObsBiasIncrement.h:52
qg::ObsBiasIncrement::serialSize
size_t serialSize() const override
Serialization.
Definition: ObsBiasIncrement.cc:135
qg::ObsBiasIncrement::stream
const double & stream() const
Definition: ObsBiasIncrement.h:61
qg::ObsBiasIncrement::wind
const double & wind() const
Definition: ObsBiasIncrement.h:62
eckit
Definition: FieldL95.h:22
qg::ObsBiasIncrement::print
void print(std::ostream &) const override
Definition: ObsBiasIncrement.cc:153
qg::ObsBiasIncrement::operator=
ObsBiasIncrement & operator=(const ObsBiasIncrement &)
Definition: ObsBiasIncrement.cc:85
qg::ObsBiasIncrement::operator[]
double & operator[](const unsigned int ii)
Definition: ObsBiasIncrement.h:55
qg::ObsBiasIncrement::operator[]
const double & operator[](const unsigned int ii) const
Definition: ObsBiasIncrement.h:56
qg::ObsBiasIncrement::bias_
std::vector< double > bias_
Definition: ObsBiasIncrement.h:74
qg::ObsBiasIncrement::wspd
const double & wspd() const
Definition: ObsBiasIncrement.h:63
qg::ObsBiasIncrement
Definition: ObsBiasIncrement.h:31
qg::ObsBiasIncrement::diff
void diff(const ObsBias &, const ObsBias &)
Linear algebra operators.
Definition: ObsBiasIncrement.cc:74
qg::ObsBiasIncrement::serialize
void serialize(std::vector< double > &) const override
Definition: ObsBiasIncrement.cc:140
qg::ObsBiasIncrement::operator+=
ObsBiasIncrement & operator+=(const ObsBiasIncrement &)
Definition: ObsBiasIncrement.cc:91
qg::ObsBiasIncrement::~ObsBiasIncrement
~ObsBiasIncrement()
Definition: ObsBiasIncrement.h:38
qg::ObsBiasIncrement::deserialize
void deserialize(const std::vector< double > &, size_t &) override
Definition: ObsBiasIncrement.cc:145
qg::ObsBiasIncrement::axpy
void axpy(const double, const ObsBiasIncrement &)
Definition: ObsBiasIncrement.cc:109
qg::ObsBiasIncrement::norm
double norm() const
Definition: ObsBiasIncrement.cc:122
qg::ObsBiasIncrement::operator*=
ObsBiasIncrement & operator*=(const double)
Definition: ObsBiasIncrement.cc:103
qg::ObsBiasIncrement::wspd
double & wspd()
Definition: ObsBiasIncrement.h:60