ModelMPAS.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 MPASJEDI_MODELMPAS_H_
#define MPASJEDI_MODELMPAS_H_
 
#include <ostream>
#include <string>
 
#include "oops/interface/ModelBase.h"
#include "oops/util/Duration.h"
#include "oops/util/ObjectCounter.h"
 
#include "mpasjedi/GeometryMPAS.h"
#include "mpasjedi/MPASTraits.h"
 
// Forward declarations
namespace eckit {
  class Configuration;
}
 
namespace oops {
  class Variables;
}
 
namespace mpas {
  class ModelBiasMPAS;
  class StateMPAS;
 
// -----------------------------------------------------------------------------
/// MPAS model definition.
/*!
 *  MPAS nonlinear model definition and configuration parameters.
 */
 
class ModelMPAS: public oops::interface::ModelBase<MPASTraits>,
                 private util::ObjectCounter<ModelMPAS> {
 public:
  static const std::string classname() {return "mpas::ModelMPAS";}
 
  ModelMPAS(const GeometryMPAS &, const eckit::Configuration &);
  ~ModelMPAS();
 
/// Prepare model integration
  void initialize(StateMPAS &) const;
 
/// Model integration
  void step(StateMPAS &, const ModelBiasMPAS &) const;
  int saveTrajectory(StateMPAS &, const ModelBiasMPAS &) const;
 
/// Finish model integration
  void finalize(StateMPAS &) const;
 
/// Utilities
  const util::Duration & timeResolution() const {return tstep_;}
  const oops::Variables & variables() const {return vars_;}
 
 private:
  void print(std::ostream &) const;
  F90model keyModel_;
  util::Duration tstep_;
  const GeometryMPAS geom_;
  const oops::Variables vars_;
};
// -----------------------------------------------------------------------------
 
}  // namespace mpas
#endif  // MPASJEDI_MODELMPAS_H_