ModelNUOPC.h

Go to the documentation of this file.

/*
 * (C) Copyright 2017 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 FV3JEDI_MODEL_NUOPC_MODELNUOPC_H_
#define FV3JEDI_MODEL_NUOPC_MODELNUOPC_H_
 
#include <ostream>
#include <string>
 
#include "oops/base/ModelBase.h"
#include "oops/base/Variables.h"
#include "oops/util/Duration.h"
#include "oops/util/ObjectCounter.h"
#include "oops/util/Printable.h"
 
#include "fv3jedi/Geometry/Geometry.h"
#include "fv3jedi/Utilities/Traits.h"
#include "ModelNUOPC.interface.h"
 
// Forward declarations
namespace eckit {
  class Configuration;
}
 
namespace fv3jedi {
  class ModelBias;
  class Increment;
  class State;
 
// -----------------------------------------------------------------------------
/// FV3JEDI model definition.
/*!
 *  FV3JEDI nonlinear model definition and configuration parameters.
 */
 
class ModelNUOPC: public oops::ModelBase<Traits>,
                        private util::ObjectCounter<ModelNUOPC> {
 public:
  static const std::string classname() {return "fv3jedi::ModelNUOPC";}
 
  ModelNUOPC(const Geometry &, const eckit::Configuration &);
  ~ModelNUOPC();
 
/// Prepare model integration
  void initialize(State &) const;
 
/// Model integration
  void step(State &, const ModelBias &) const;
 
/// Finish model integration
  void finalize(State &) const;
 
/// Utilities
  const util::Duration & timeResolution() const {return tstep_;}
  const oops::Variables & variables() const {return vars_;}
 
 private:
  void print(std::ostream &) const;
  F90model keyConfig_;
  util::Duration tstep_;
  const Geometry geom_;
  const oops::Variables vars_;
};
// -----------------------------------------------------------------------------
 
}  // namespace fv3jedi
#endif  // FV3JEDI_MODEL_NUOPC_MODELNUOPC_H_