ObsAtmVertInterp.interface.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 UFO_ATMVERTINTERP_OBSATMVERTINTERP_INTERFACE_H_
#define UFO_ATMVERTINTERP_OBSATMVERTINTERP_INTERFACE_H_
 
#include "ioda/ObsSpace.h"
#include "oops/base/Variables.h"
#include "ufo/Fortran.h"
 
namespace ufo {
 
/// Interface to Fortran UFO routines
/*!
 * The core of the UFO is coded in Fortran.
 * Here we define the interfaces to the Fortran code.
 */
 
extern "C" {
 
// -----------------------------------------------------------------------------
//  AtmVertInterp observation operator
// -----------------------------------------------------------------------------
 
  /// \param operatorVars
  ///   Variables to be simulated by this operator.
  /// \param operatorVarIndices
  ///   Indices of the variables from \p operatorVar in the list of all simulated
  ///   variables in the ObsSpace.
  /// \param numOperatorVarIndices
  ///   Size of the \p operatorVarIndices array (must be the same as the number of variables in
  ///   \p operatorVars).
  /// \param[out] requiredVars
  ///   GeoVaLs required for the simulation of the variables \p operatorVars.
  ///
  /// Example: if the list of simulated variables in the ObsSpace is
  /// [air_temperature, northward_wind, eastward_wind] and \p operatorVars is
  /// [northward_wind, eastward_wind], then \p operatorVarIndices should be set to [1, 2].
  void ufo_atmvertinterp_setup_f90(F90hop &, const eckit::Configuration &,
                                   const oops::Variables &operatorVars,
                                   const int *operatorVarIndices, const int numOperatorVarIndices,
                                   oops::Variables &requiredVars);
  void ufo_atmvertinterp_delete_f90(F90hop &);
  void ufo_atmvertinterp_simobs_f90(const F90hop &, const F90goms &, const ioda::ObsSpace &,
                                 const int &, const int &, double &);
// -----------------------------------------------------------------------------
 
}  // extern C
 
}  // namespace ufo
#endif  // UFO_ATMVERTINTERP_OBSATMVERTINTERP_INTERFACE_H_