ObsOpBaseTLAD.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 QG_MODEL_OBSOPBASETLAD_H_
#define QG_MODEL_OBSOPBASETLAD_H_

#include <map>
#include <string>

#include <boost/noncopyable.hpp>

#include "eckit/config/Configuration.h"
#include "model/ObsSpaceQG.h"
#include "oops/base/Variables.h"
#include "oops/util/abor1_cpp.h"
#include "oops/util/Logger.h"
#include "oops/util/Printable.h"

namespace qg {
class GomQG;
class ObsBias;
class ObsBiasIncrement;
class ObsVecQG;

// -----------------------------------------------------------------------------
/// Base class for observation operators

class ObsOpBaseTLAD : public util::Printable,
                      private boost::noncopyable {
 public:
  ObsOpBaseTLAD() {}
  virtual ~ObsOpBaseTLAD() {}

/// Obs Operator
  virtual void setTrajectory(const GomQG &, const ObsBias &) = 0;
  virtual void simulateObsTL(const GomQG &, ObsVecQG &, const ObsBiasIncrement &) const = 0;
  virtual void simulateObsAD(GomQG &, const ObsVecQG &, ObsBiasIncrement &) const = 0;

/// Other
  virtual const oops::Variables & variables() const = 0;  // Required from Model

 private:
  virtual void print(std::ostream &) const = 0;
};

// -----------------------------------------------------------------------------

/// Obs Operator Factory
class ObsOpTLADFactory {
 public:
  static ObsOpBaseTLAD * create(const ObsSpaceQG &, const eckit::Configuration &);
  virtual ~ObsOpTLADFactory() { getMakers().clear(); }
 protected:
  explicit ObsOpTLADFactory(const std::string &);
 private:
  virtual ObsOpBaseTLAD * make(const ObsSpaceQG &, const eckit::Configuration &) = 0;
  static std::map < std::string, ObsOpTLADFactory * > & getMakers() {
    static std::map < std::string, ObsOpTLADFactory * > makers_;
    return makers_;
  }
};

// -----------------------------------------------------------------------------

template<class T>
class ObsOpTLADMaker : public ObsOpTLADFactory {
  virtual ObsOpBaseTLAD * make(const ObsSpaceQG & odb, const eckit::Configuration & conf)
    { return new T(odb, conf); }
 public:
  explicit ObsOpTLADMaker(const std::string & name) : ObsOpTLADFactory(name) {}
};

// -----------------------------------------------------------------------------

}  // namespace qg

#endif  // QG_MODEL_OBSOPBASETLAD_H_