ObsBiasCovariance.h

Go to the documentation of this file.

/*
 * (C) Copyright 2017-2018 UCAR
 * 
 * This software is licensed under the terms of the Apache Licence Version 2.0
 * which can be obtained at http://www.apache.org/licenses/LICENSE-2.0. 
 */
 
#ifndef UFO_OBSBIASCOVARIANCE_H_
#define UFO_OBSBIASCOVARIANCE_H_
 
#include <map>
#include <string>
#include <vector>
#include <boost/noncopyable.hpp>
 
#include "eckit/config/LocalConfiguration.h"
 
#include "oops/base/Variables.h"
#include "oops/util/ObjectCounter.h"
#include "oops/util/Printable.h"
 
#include "ufo/ObsBiasParameters.h"
 
namespace eckit {
  class Configuration;
}
 
namespace ioda {
  class ObsSpace;
}
 
namespace ufo {
  class ObsBias;
  class ObsBiasIncrement;
 
// -----------------------------------------------------------------------------
 
class ObsBiasCovariance : public util::Printable,
                          private boost::noncopyable,
                          private util::ObjectCounter<ObsBiasCovariance> {
 public:
  typedef ObsBiasParameters Parameters_;
 
  static const std::string classname() {return "ufo::ObsBiasCovariance";}
 
// Constructor, destructor
  ObsBiasCovariance(ioda::ObsSpace & odb, const Parameters_ & params);
  ~ObsBiasCovariance() {}
 
// Linear algebra operators
  void linearize(const ObsBias &, const eckit::Configuration &);
  void multiply(const ObsBiasIncrement &, ObsBiasIncrement &) const;
  void inverseMultiply(const ObsBiasIncrement &, ObsBiasIncrement &) const;
  void randomize(ObsBiasIncrement &) const;
 
// Utilities
  void read(const ObsBiasCovariancePriorParameters &);
  void write(const eckit::Configuration &);
  const std::vector<std::string> predictorNames() const {return prednames_;}
 
 private:
  void print(std::ostream &) const {}
 
  ioda::ObsSpace & odb_;
 
// Hessian contribution from Jo bias correction terms
  std::vector<double> ht_rinv_h_;
 
// preconditioner
  std::vector<double> preconditioner_;
 
// QCed obs numbers <channel>
  std::vector<std::size_t> obs_num_;
 
// Minimal required QCed obs number to add contribution
  std::size_t minimal_required_obs_number_;
 
// Analysis error variances
  std::vector<double> analysis_variances_;
 
// Error variances
  Eigen::VectorXd variances_;
 
// Smallest variance value
  double smallest_variance_ = ObsBiasCovarianceParameters::defaultSmallestVariance();
 
// Largest variance value
  double largest_variance_ = ObsBiasCovarianceParameters::defaultLargestVariance();
 
// Largest analysis error variance
  double largest_analysis_variance_ = ObsBiasCovarianceParameters::defaultLargestAnalysisVariance();
 
// Step size
  double step_size_ = ObsBiasCovarianceParameters::defaultStepSize();
 
  std::vector<std::string> prednames_;
 
  /// variables for which bias correction coefficients will be updated
  oops::Variables vars_;
};
 
// -----------------------------------------------------------------------------
 
}  // namespace ufo
 
#endif  // UFO_OBSBIASCOVARIANCE_H_