PCGMinimizer.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_PCGMINIMIZER_H_
#define OOPS_ASSIMILATION_PCGMINIMIZER_H_
 
#include <string>
 
#include "oops/assimilation/BMatrix.h"
#include "oops/assimilation/ControlIncrement.h"
#include "oops/assimilation/CostFunction.h"
#include "oops/assimilation/HessianMatrix.h"
#include "oops/assimilation/PCG.h"
#include "oops/assimilation/PrimalMinimizer.h"
 
namespace oops {
 
/// PCG Minimizer
/*!
 * Implements the standard Preconditioned Conjugate Gradients algorithm.
 */
 
// -----------------------------------------------------------------------------
 
template<typename MODEL, typename OBS> class PCGMinimizer : public PrimalMinimizer<MODEL, OBS> {
  typedef BMatrix<MODEL, OBS>             Bmat_;
  typedef CostFunction<MODEL, OBS>        CostFct_;
  typedef ControlIncrement<MODEL, OBS>    CtrlInc_;
  typedef HessianMatrix<MODEL, OBS>       Hessian_;
 
 public:
  const std::string classname() const override {return "PCGMinimizer";}
  PCGMinimizer(const eckit::Configuration &, const CostFct_ & J): PrimalMinimizer<MODEL, OBS>(J) {}
  ~PCGMinimizer() {}
 
 private:
  double solve(CtrlInc_ &, const CtrlInc_ &,
               const Hessian_ &, const Bmat_ &,
               const int, const double) override;
};
 
// =============================================================================
 
template<typename MODEL, typename OBS>
double PCGMinimizer<MODEL, OBS>::solve(CtrlInc_ & dx, const CtrlInc_ & rhs,
                                  const Hessian_ & hessian, const Bmat_ & B,
                                  const int ninner, const double gnreduc) {
// Solve the linear system
  double reduc = PCG(dx, rhs, hessian, B, ninner, gnreduc);
  return reduc;
}
 
// -----------------------------------------------------------------------------
 
}  // namespace oops
 
#endif  // OOPS_ASSIMILATION_PCGMINIMIZER_H_