GetValueTLADs.h

Go to the documentation of this file.

/*
 * (C) Copyright 2021-2021 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 OOPS_BASE_GETVALUETLADS_H_
#define OOPS_BASE_GETVALUETLADS_H_
 
#include <memory>
#include <vector>
 
#include "oops/base/GetValueTLAD.h"
#include "oops/base/Increment.h"
#include "oops/base/PostBaseTLAD.h"
#include "oops/base/State.h"
#include "oops/util/DateTime.h"
#include "oops/util/Duration.h"
 
namespace oops {
 
/// Computes observation equivalent TL and AD to/from increments.
 
template <typename MODEL, typename OBS>
class GetValueTLADs : public PostBaseTLAD<MODEL> {
  typedef Increment<MODEL>          Increment_;
  typedef State<MODEL>              State_;
  typedef std::shared_ptr<GetValueTLAD<MODEL, OBS>> GetValPtr_;
 
 public:
  GetValueTLADs(const util::DateTime &, const util::DateTime &);
 
  void append(GetValPtr_);
 
 private:
// Methods
  void doInitializeTraj(const State_ &, const util::DateTime &, const util::Duration &) override;
  void doProcessingTraj(const State_ &) override;
  void doFinalizeTraj(const State_ &) override {}
 
  void doInitializeTL(const Increment_ &, const util::DateTime &, const util::Duration &) override;
  void doProcessingTL(const Increment_ &) override;
  void doFinalizeTL(const Increment_ &) override {}
 
  void doFirstAD(Increment_ &, const util::DateTime &, const util::Duration &) override;
  void doProcessingAD(Increment_ &) override;
  void doLastAD(Increment_ &) override {}
 
// Data
  std::vector<GetValPtr_> getvals_;
};
 
// -----------------------------------------------------------------------------
template <typename MODEL, typename OBS>
GetValueTLADs<MODEL, OBS>::GetValueTLADs(const util::DateTime & bgn, const util::DateTime & end)
  : PostBaseTLAD<MODEL>(bgn, end), getvals_()
{
  Log::trace() << "GetValueTLADs::GetValueTLADs" << std::endl;
}
// -----------------------------------------------------------------------------
template <typename MODEL, typename OBS>
void GetValueTLADs<MODEL, OBS>::append(GetValPtr_ getval) {
  Log::trace() << "GetValuePosts::append start" << std::endl;
  getvals_.push_back(getval);
  Log::trace() << "GetValuePosts::append done" << std::endl;
}
// -----------------------------------------------------------------------------
template <typename MODEL, typename OBS>
void GetValueTLADs<MODEL, OBS>::doInitializeTraj(const State_ &, const util::DateTime &,
                                                 const util::Duration & tstep) {
  Log::trace() << "GetValueTLADs::doInitializeTraj start" << std::endl;
  for (GetValPtr_ getval : getvals_) getval->initializeTraj(tstep);
  Log::trace() << "GetValueTLADs::doInitializeTraj done" << std::endl;
}
// -----------------------------------------------------------------------------
template <typename MODEL, typename OBS>
void GetValueTLADs<MODEL, OBS>::doProcessingTraj(const State_ & xx) {
  Log::trace() << "GetValueTLADs::doProcessingTraj start" << std::endl;
//  Change of variables traj will go here
  for (GetValPtr_ getval : getvals_) getval->processTraj(xx);
  Log::trace() << "GetValueTLADs::doProcessingTraj done" << std::endl;
}
// -----------------------------------------------------------------------------
template <typename MODEL, typename OBS>
void GetValueTLADs<MODEL, OBS>::doInitializeTL(const Increment_ &, const util::DateTime &,
                                               const util::Duration & tstep) {
  Log::trace() << "GetValueTLADs::doInitializeTL start" << std::endl;
  for (GetValPtr_ getval : getvals_) getval->initializeTL(tstep);
  Log::trace() << "GetValueTLADs::doInitializeTL done" << std::endl;
}
// -----------------------------------------------------------------------------
template <typename MODEL, typename OBS>
void GetValueTLADs<MODEL, OBS>::doProcessingTL(const Increment_ & dx) {
  Log::trace() << "GetValueTLADs::doProcessingTL start" << std::endl;
// TL change of variables will go here
  for (GetValPtr_ getval : getvals_) getval->processTL(dx);
  Log::trace() << "GetValueTLADs::doProcessingTL done" << std::endl;
}
// -----------------------------------------------------------------------------
template <typename MODEL, typename OBS>
void GetValueTLADs<MODEL, OBS>::doFirstAD(Increment_ &, const util::DateTime &,
                                          const util::Duration & tstep) {
  Log::trace() << "GetValueTLADs::doFirstAD start" << std::endl;
  for (GetValPtr_ getval : getvals_) getval->initializeAD(tstep);
  Log::trace() << "GetValueTLADs::doFirstAD done" << std::endl;
}
// -----------------------------------------------------------------------------
template <typename MODEL, typename OBS>
void GetValueTLADs<MODEL, OBS>::doProcessingAD(Increment_ & dx) {
  Log::trace() << "GetValueTLADs::doProcessingAD start" << std::endl;
//  AD change of variables will go here
  for (GetValPtr_ getval : getvals_) getval->processAD(dx);
  Log::trace() << "GetValueTLADs::doProcessingAD done" << std::endl;
}
// -----------------------------------------------------------------------------
 
}  // namespace oops
 
#endif  // OOPS_BASE_GETVALUETLADS_H_