ObsProfileAverageTLAD.h

Go to the documentation of this file.

/*
 * (C) Copyright 2021 UK Met Office
 * 
 * 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_PROFILE_OBSPROFILEAVERAGETLAD_H_
#define UFO_PROFILE_OBSPROFILEAVERAGETLAD_H_
 
#include <memory>
#include <ostream>
#include <string>
#include <vector>
 
#include "oops/base/Variables.h"
#include "oops/util/ObjectCounter.h"
 
#include "ufo/LinearObsOperatorBase.h"
 
#include "ufo/profile/ObsProfileAverageData.h"
#include "ufo/profile/ObsProfileAverageParameters.h"
 
/// Forward declarations
namespace eckit {
  class Configuration;
}
 
namespace ioda {
  class ObsSpace;
  class ObsVector;
}
 
namespace ufo {
  class GeoVaLs;
  class ObsDiagnostics;
 
/// \brief TL/AD code for the ProfileAverage observation operator.
class ObsProfileAverageTLAD : public LinearObsOperatorBase,
  private util::ObjectCounter<ObsProfileAverageTLAD> {
 public:
  static const std::string classname() {return "ufo::ObsProfileAverageTLAD";}
 
  ObsProfileAverageTLAD(const ioda::ObsSpace &, const eckit::Configuration &);
  virtual ~ObsProfileAverageTLAD();
 
  void setTrajectory(const GeoVaLs &, ObsDiagnostics &) override;
  void simulateObsTL(const GeoVaLs &, ioda::ObsVector &) const override;
  void simulateObsAD(GeoVaLs &, const ioda::ObsVector &) const override;
 
  const oops::Variables & requiredVars() const override { return data_.requiredVars(); }
 
  oops::Variables simulatedVars() const override { return data_.simulatedVars(); }
 
 private:
  void print(std::ostream &) const override;
 
 private:
  /// ObsSpace.
  const ioda::ObsSpace& odb_;
 
  /// Data handler for the ProfileAverage operator and TL/AD code.
  ObsProfileAverageData data_;
};
 
// -----------------------------------------------------------------------------
 
}  // namespace ufo
#endif  // UFO_PROFILE_OBSPROFILEAVERAGETLAD_H_