TrajectorySaver.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_BASE_TRAJECTORYSAVER_H_
#define OOPS_BASE_TRAJECTORYSAVER_H_

#include <boost/ptr_container/ptr_vector.hpp>

#include "eckit/config/LocalConfiguration.h"
#include "oops/base/PostBase.h"
#include "oops/interface/Geometry.h"
#include "oops/interface/LinearModel.h"
#include "oops/interface/ModelAuxControl.h"
#include "oops/interface/State.h"
#include "oops/util/DateTime.h"
#include "oops/util/Duration.h"

namespace oops {

/// Save trajectory during forecast run.

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

template <typename MODEL>
class TrajectorySaver : public PostBase<State<MODEL> > {
  typedef Geometry<MODEL>          Geometry_;
  typedef LinearModel<MODEL>       LinearModel_;
  typedef ModelAuxControl<MODEL>   ModelAux_;
  typedef PostProcessorTLAD<MODEL> PPTLAD_;
  typedef State<MODEL>             State_;

 public:
  TrajectorySaver(const eckit::Configuration &, const Geometry_ &,
                  const ModelAux_ &, boost::ptr_vector<LinearModel_> &, PPTLAD_);
  ~TrajectorySaver() {}

 private:
  const Geometry_    resol_;
  const eckit::LocalConfiguration tlConf_;
  const ModelAux_    lrBias_;
  boost::ptr_vector<LinearModel_> & tlm_;
  LinearModel_ *     subtlm_;
  PPTLAD_ pptraj_;

  void doInitialize(const State_ &, const util::DateTime &, const util::Duration &) override;
  void doProcessing(const State_ &) override;
  void doFinalize(const State_ &) override;
};

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

template <typename MODEL>
TrajectorySaver<MODEL>::TrajectorySaver(const eckit::Configuration & conf,
                                        const Geometry_ & resol,
                                        const ModelAux_ & bias,
                                        boost::ptr_vector<LinearModel_> & tlm,
                                        PPTLAD_ pptraj):
  PostBase<State_>(conf),
  resol_(resol), tlConf_(conf), lrBias_(resol, bias),
  tlm_(tlm), subtlm_(0), pptraj_(pptraj)
{
  Log::trace() << "TrajectorySaver::TrajectorySaver" << std::endl;
}
// -----------------------------------------------------------------------------
template <typename MODEL>
void TrajectorySaver<MODEL>::doInitialize(const State_ & x0,
                                          const util::DateTime & end,
                                          const util::Duration & step) {
  Log::trace() << "TrajectorySaver::doInitialize start" << std::endl;
  subtlm_ = new LinearModel_(resol_, tlConf_);
  State_ xlr(resol_, x0);
  pptraj_.initializeTraj(xlr, end, step);
  Log::trace() << "TrajectorySaver::doInitialize done" << std::endl;
}
// -----------------------------------------------------------------------------
template <typename MODEL>
void TrajectorySaver<MODEL>::doProcessing(const State_ & xx) {
  Log::trace() << "TrajectorySaver::doProcessing start" << std::endl;
  ASSERT(subtlm_ != 0);
  State_ xlr(resol_, xx);
  subtlm_->setTrajectory(xx, xlr, lrBias_);
  pptraj_.processTraj(xlr);
  Log::trace() << "TrajectorySaver::doProcessing done" << std::endl;
}
// -----------------------------------------------------------------------------
template <typename MODEL>
void TrajectorySaver<MODEL>::doFinalize(const State_ & xx) {
  Log::trace() << "TrajectorySaver::doFinalize start" << std::endl;
  State_ xlr(resol_, xx);
  tlm_.push_back(subtlm_);
  pptraj_.finalizeTraj(xlr);
  subtlm_ = 0;
  Log::trace() << "TrajectorySaver::doFinalize done" << std::endl;
}
// -----------------------------------------------------------------------------

}  // namespace oops

#endif  // OOPS_BASE_TRAJECTORYSAVER_H_