ControlVariable.h

Go to the documentation of this file.

/*
 * (C) Copyright 2009-2016 ECMWF.
 *
 * 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.
 * In applying this licence, ECMWF does not waive the privileges and immunities
 * granted to it by virtue of its status as an intergovernmental organisation nor
 * does it submit to any jurisdiction.
 */
 
#ifndef OOPS_ASSIMILATION_CONTROLVARIABLE_H_
#define OOPS_ASSIMILATION_CONTROLVARIABLE_H_
 
#include <cmath>
#include <ostream>
#include <string>
 
#include "eckit/config/Configuration.h"
#include "oops/base/ObsAuxControls.h"
#include "oops/base/ObsSpaces.h"
#include "oops/base/Variables.h"
#include "oops/interface/Geometry.h"
#include "oops/interface/ModelAuxControl.h"
#include "oops/interface/State.h"
#include "oops/util/ObjectCounter.h"
#include "oops/util/Printable.h"
 
namespace oops {
 
/// Control variable
/*!
 * The control variable acts as a container for the inputs of the variational
 * data assimilation cost functions in physical space.
 * That includes the states at the start the assimilation window or of each
 * sub-window but also additional variables such as model bias, VarBC
 * coefficients, or other control variables for algorithms that use them.
 * This is mostly a convenience class that is used to keep things together
 * and reduce the number of arguments to be passed around.
 */
 
template<typename MODEL, typename OBS> class ControlVariable;
 
// -----------------------------------------------------------------------------
template<typename MODEL, typename OBS>
class ControlVariable : public util::Printable,
                        private util::ObjectCounter<ControlVariable<MODEL, OBS> > {
  typedef Geometry<MODEL>            Geometry_;
  typedef ModelAuxControl<MODEL>     ModelAux_;
  typedef ObsAuxControls<OBS>        ObsAuxCtrls_;
  typedef ObsSpaces<OBS>             ObsSpaces_;
  typedef State<MODEL>               State_;
 
 public:
  static const std::string classname() {return "oops::ControlVariable";}
 
/// The arguments define the number of sub-windows and the resolution
  ControlVariable(const eckit::Configuration &, const Geometry_ &, const ObsSpaces_ &);
/// Constructor added for generic 1d-var under development in ufo
  ControlVariable(const eckit::Configuration &, const State_ &, const ObsSpaces_ &);
  explicit ControlVariable(const ControlVariable &);
  ~ControlVariable();
 
/// I/O and diagnostics
  void read(const eckit::Configuration &);
  void write(const eckit::Configuration &) const;
  double norm() const;
 
/// Get state control variable
  State_ & state() {return state_;}
  const State_ & state() const {return state_;}
 
/// Get augmented model control variable
  ModelAux_ & modVar() {return modbias_;}
  const ModelAux_ & modVar() const {return modbias_;}
 
/// Get augmented observation control variable
  ObsAuxCtrls_ & obsVar() {return obsbias_;}
  const ObsAuxCtrls_ & obsVar() const {return obsbias_;}
 
 private:
  ControlVariable & operator= (const ControlVariable &);  // No assignment
  void print(std::ostream &) const;
 
  State_ state_;
  ModelAux_ modbias_;     // not only for bias, better name?
  ObsAuxCtrls_ obsbias_;  // not only for bias, better name?
};
 
// =============================================================================
 
template<typename MODEL, typename OBS>
ControlVariable<MODEL, OBS>::ControlVariable(const eckit::Configuration & conf,
                                             const Geometry_ & resol, const ObsSpaces_ & odb)
  : state_(resol, eckit::LocalConfiguration(conf, "background")),
    modbias_(resol, conf.getSubConfiguration("model aux control")),
    obsbias_(odb, conf)
{
  Log::trace() << "ControlVariable contructed" << std::endl;
}
 
// =============================================================================
/// Constructor added for generic 1d-var under development in ufo
template<typename MODEL, typename OBS>
ControlVariable<MODEL, OBS>::ControlVariable(const eckit::Configuration & conf,
                                             const State_ & statein, const ObsSpaces_ & odb)
  : state_(statein),
    modbias_(statein.geometry(), conf.getSubConfiguration("model aux control")),
    obsbias_(odb, conf)
{
  Log::trace() << "ControlVariable contructed" << std::endl;
}
 
// -----------------------------------------------------------------------------
 
template<typename MODEL, typename OBS>
ControlVariable<MODEL, OBS>::ControlVariable(const ControlVariable & other)
  : state_(other.state_), modbias_(other.modbias_), obsbias_(other.obsbias_)
{
  Log::trace() << "ControlVariable copied" << std::endl;
}
 
// -----------------------------------------------------------------------------
 
template<typename MODEL, typename OBS>
ControlVariable<MODEL, OBS>::~ControlVariable() {
  Log::trace() << "ControlVariable destructed" << std::endl;
}
 
// -----------------------------------------------------------------------------
 
template<typename MODEL, typename OBS>
void ControlVariable<MODEL, OBS>::read(const eckit::Configuration & config) {
  state_.read(config);
  modbias_.read(config);
  obsbias_.read(config);
}
 
// -----------------------------------------------------------------------------
 
template<typename MODEL, typename OBS>
void ControlVariable<MODEL, OBS>::write(const eckit::Configuration & config) const {
  state_.write(config);
  modbias_.write(config);
  obsbias_.write(config);
}
 
// -----------------------------------------------------------------------------
 
template <typename MODEL, typename OBS>
void ControlVariable<MODEL, OBS>::print(std::ostream & outs) const {
  outs << state_;
  outs << modbias_;
  outs << obsbias_;
}
 
// -----------------------------------------------------------------------------
 
template<typename MODEL, typename OBS>
double ControlVariable<MODEL, OBS>::norm() const {
  double zz = state_.norm();
  double zn = zz * zz;
  zz = modbias_.norm();
  zn += zz * zz;
  zz = obsbias_.norm();
  zn += zz * zz;
  return sqrt(zn);
}
 
// -----------------------------------------------------------------------------
}  // namespace oops
 
#endif  // OOPS_ASSIMILATION_CONTROLVARIABLE_H_