FieldsMetadata.cc

Go to the documentation of this file.

/*
 * (C) Copyright 2020 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.
 */
 
// -------------------------------------------------------------------------------------------------
 
/*!
  Configuration files should be formatted as e.g.:
 
  Fields:
    - FieldName: ud
      FieldIONames: [u, ud, U]
      Kind: double
      Levels: full
      LongName: u_component_of_native_D_grid_wind
      Space: vector
      StaggerLoc: northsouth
      Tracer: false
      Units: ms-1
      IOFile: core
 
    - FieldName: t
      FieldIONames: [t, T, air_temperature]
      Kind: double
      Levels: full
      LongName: air_temperature
      Space: magnitude
      StaggerLoc: center
      Tracer: false
      Units: K
      IOFile: core
 
  FieldName:    The name that the interface recognizes a field as. E.g. if a field needs to be
                accessed in a variable change this is the name that is used to do so.
  FieldIONames: Name used by the model and in the files. There can be multiple options per
                FieldName.
  Kind:         What kind of data, 'double', 'integer' (default: double)
  Levels:       Can be 'full' (nz), 'half' (nz+1) or a number. (Default: full)
  LongName:     Long name written to output files (default: FieldName)
  Space:        Where the field represents a 'vector', a 'magnitude' or a 'direction'
                (default: magnitude)
  StaggerLoc:   Horizontal staggering location, options are 'center', 'northsouth', 'eastwest' or
                'corner' (default: center)
  Tracer:       Boolean of whether or nor the field is a tracer (default: false)
  Units:        Units of the field, can be 1 for dimensionless
  IOFile:       Optional; can be core, tracer, sfcd, sfcw; determines which restart file to
                read the field from. Default will be defined in IO/fv3jedi_io_<gfs|geos>_mod.f90
 
  If no default the metadata must be provided below.
*/
 
// -------------------------------------------------------------------------------------------------
 
#include <iostream>
#include <map>
#include <utility>
 
#include "fv3jedi/FieldMetadata/FieldsMetadata.h"
 
// -------------------------------------------------------------------------------------------------
 
namespace fv3jedi {
 
  // -----------------------------------------------------------------------------------------------
 
  FieldsMetadata::FieldsMetadata(const eckit::Configuration & confFull) {
    // Local versions
    std::string fieldIOName;
    std::string fieldName;
    std::string kind;
    std::string levels_str;
    std::string longName;
    std::string space;
    std::string staggerLoc;
    bool tracer;
    std::string units;
    std::string io_file;
 
    //  List of field sets
    std::vector<eckit::LocalConfiguration> confFieldSets;
    confFull.get("fieldsets", confFieldSets);
    int confFieldSetsSize = confFieldSets.size();
 
    // Get number of vertical levels
    const int nlev = confFull.getInt("npz");
 
    //  Loop over sets of fields, i.e. each yaml file
    for (int km = 0; km < confFieldSetsSize; ++km) {
      // Create new config for each field set
      eckit::PathName pathNameFieldSet(confFieldSets[km].getString("fieldset"));
      const eckit::YAMLConfiguration confFieldSet(pathNameFieldSet);
 
      //  List of fields
      std::vector<eckit::LocalConfiguration> confFields;
      confFieldSet.get("Fields", confFields);
      int confFieldsSize = confFields.size();
 
      // Loop over fields
      for (int jm = 0; jm < confFieldsSize; ++jm) {
        //  List of potential names, default is FieldName
        fieldName = confFields[jm].getString("FieldName");
 
        std::vector<std::string> fieldIONames;
        fieldIONames.push_back(fieldName);
        fieldIONames = confFields[jm].getStringVector("FieldIONames", fieldIONames);
 
        int confFieldIONamesSize = fieldIONames.size();
 
        // Loop over potential field names
        for (int im = 0; im < confFieldIONamesSize; ++im) {
          // Insert new field
          fieldIOName = fieldIONames[im];
 
          // Assertion that field not already in the map
          if ( fields_.find(fieldIOName) != fields_.end() ) {
            ABORT("FieldMetadata::FieldMetadata Field "+fieldIOName+" already in the map");
          }
 
          fields_.insert(std::pair<std::string, FieldMetadata>(fieldIOName,
                                                               FieldMetadata(fieldIOName)));
 
          // Pointer to current
          FieldMetadata& fieldmetadata = fields_.find(fieldIOName)->second;
 
          // Push other metadata
          // -------------------
 
          kind = confFields[jm].getString("Kind", "double");
          levels_str = confFields[jm].getString("Levels", "full");
          longName = confFields[jm].getString("LongName", fieldName);
          space = confFields[jm].getString("Space", "magnitude");
          staggerLoc = confFields[jm].getString("StaggerLoc", "center");
          tracer = confFields[jm].getBool("Tracer", false);
          units = confFields[jm].getString("Units");
          io_file = confFields[jm].getString("IOFile", "default");
 
          // Check for valid choices
          fieldmetadata.checkKindValid(fieldIOName, kind);
          fieldmetadata.checkSpaceValid(fieldIOName, space);
          fieldmetadata.checkStaggerLocValid(fieldIOName, staggerLoc);
          fieldmetadata.checkLevelValid(fieldIOName, levels_str);
 
          // Convert string levels to integer levels
          int levels;
 
          if (levels_str == "full") {
            levels = nlev;
          } else if (levels_str == "half") {
            levels = nlev + 1;
          } else {
            levels = std::stoi(levels_str);
          }
 
          fieldmetadata.setFieldName(fieldName);
          fieldmetadata.setKind(kind);
          fieldmetadata.setLevels(levels);
          fieldmetadata.setLongName(longName);
          fieldmetadata.setSpace(space);
          fieldmetadata.setStaggerLoc(staggerLoc);
          fieldmetadata.setTracer(tracer);
          fieldmetadata.setUnits(units);
          fieldmetadata.setIOFile(io_file);
        }  // End loop over potential field names
      }  // End loop over fields
    }  // End loop over field sets
 
 
    // Prints for debugging
    // --------------------
    std::map<std::string, FieldMetadata>::iterator itr;
 
    for (itr = fields_.begin(); itr != fields_.end(); ++itr) {
      oops::Log::debug() << "Key: " << itr->first << "\nData: \n" << itr->second << std::endl;
    }
  }
 
  // -----------------------------------------------------------------------------------------------
 
  FieldMetadata FieldsMetadata::getField(const std::string & fieldIOName) const {
    if ( fields_.find(fieldIOName) == fields_.end() ) {
      ABORT("FieldMetadata::getField: Field "+fieldIOName+" not found in FieldsMetadata");
    }
    return fields_.find(fieldIOName)->second;
  }
 
  // -----------------------------------------------------------------------------------------------
 
}  // namespace fv3jedi
 
// -------------------------------------------------------------------------------------------------