Removed return codes and other cleanup for Field and Dimension

Continued cleanup of omega focused on Field and Dimension, including:

    - removing return codes in favor of abort for most routines
    - use of Error code and Error infrastructure where needed
    - updated docs
    - cleanup of unit tests to reduce output

Author: philipwjones

components/omega/doc/devGuide/Field.md

@@ -6,7 +6,7 @@ Omega includes a Field class that registers available fields and associated
 metadata for use in IO (or any other part of Omega that may require the field
 metadata). The module owning the field will define the Field together
 with some required metadata for compliance with the Climate and Forecast
-[(CF) metadata conventios.](http://cfconventions.org/). Groups of Fields
+[(CF) metadata conventions.](http://cfconventions.org/). Groups of Fields
 can also be defined to provide a short cut to groups that are commonly used
 together, like the model state and tracer groups. Two special Fields, CodeMeta
 and SimMeta (with default names "code" and "simulation", respectively), are
@@ -20,7 +20,7 @@ To use the Field class, the Field header file must be included and as part of
 the application initialization, there should be a call to the init method:
 Fields initialized with the init method:
 ```c++
-int Err = Field::init();
+Field::init();
 ```
 which primarily defines the CodeMeta and SimMeta fields for later use.
 For array fields, the appropriate Dimensions must be defined. The default
@@ -79,15 +79,14 @@ purpose.
 
 Additional metadata in the form of a name-value pair can be added using:
 ```c++
-   int Err = MyField->addMetadata(
-                         MetaName, // [in] Name of new metadata (string)
-                         Value     // [in] Value of new metadata
+   MyField->addMetadata(MetaName, // [in] Name of new metadata (string)
+                        Value     // [in] Value of new metadata
    );
 ```
 where Value can be any supported data type (I4, I8, R4, R8, bool, string).
 Multiple pairs can be added in a single call using:
 ``` c++
-   Err = SimField->addMetadata(
+   SimField->addMetadata(
          {std::make_pair("Name1", Val1),
           std::make_pair("Name2", Val2),
           std::make_pair("Name3", Val3),
@@ -100,16 +99,16 @@ As mentioned above, the actual data array is attached in a separate call
 using a templated form. If the pointer to the Field is available, use the
 member function:
 ```c++
-   int Err = MyField->attachData<ArrayType>(InDataArray);
+   MyField->attachData<ArrayType>(InDataArray);
    // for example:
-   int Err = MyField->attachData<HostArray1DI4>(CellID);
-   int Err = MyField->attachData<Array2DR8>(NormalVelocity);
+   MyField->attachData<HostArray1DI4>(CellID);
+   MyField->attachData<Array2DR8>(NormalVelocity);
 ```
 where ArrayType is one of the supported array types (Array1DI4, etc. or
 HostArray1DI4, etc.). If the Field pointer has not been retrieved, an interface
 is provided using the field name:
 ```c++
-   int Err = Field::attachFieldData<ArrayType>(
+   Field::attachFieldData<ArrayType>(
                     FieldName,   // [in] Name of Field (string)
                     InDataArray  // [in] Array with data to attach
                     );
@@ -170,7 +169,7 @@ The dimension information can be retrieved using:
 ```c++
    int NDims = MyField->getNumDims();
    std::vector<std::string> MyDimNames(NDims);
-   int Err = MyField->getDimNames(MyDimNames);
+   MyField->getDimNames(MyDimNames);
 ```
 Once the dimension names have been retrieved, the Dimension class API can be
 used to extract further dimension information. Two other field quantities
@@ -191,13 +190,13 @@ functions.  To retrieve a pointer to the full Field, use:
 With this pointer all the member functions above can be used.
 The Metadata associated with a field can be retrieved individually using:
 ```c++
-   int Err = MyField->getMetadata(MetadataName, MetaValue);
+   Error Err = MyField->getMetadata(MetadataName, MetaValue);
 ```
 where the MetaValue can be a scalar of any supported data type (I4, I8, R4, R8,
 bool, std::string). If the value of a metadata entry needs to be changed,
 an update function is provided:
 ```c++
-   int Err = MyField->updateMetadata(MetadataName, NewMetaValue);
+   MyField->updateMetadata(MetadataName, NewMetaValue);
 ```
 The existence of a metadata entry can be determined with:
 ```c++
@@ -229,13 +228,13 @@ location as described previously.
 
 Metadata can be removed from a Field using:
 ```c++
-   int Err = MyField->removeMetadata(MetaName);
+   MyField->removeMetadata(MetaName);
    MyField->removeAllMetadata();
 ```
 depending on whether a single metadata entry or all metadata entries need to
 be deleted. Entire fields can be removed using:
 ```c++
-   int Err = Field::destroy(FieldName);
+   Field::destroy(FieldName);
 ```
 and before exiting, all fields should be removed using:
 ```c++
@@ -253,8 +252,8 @@ is created by first creating an empty group with the desired name:
 Fields can then be added either through a member function if the group
 pointer is available, or by group name:
 ```c++
-   int Err = MyGroup->addField(FieldName);
-   int Err = FieldGroup::addFieldToGroup(FieldName, GroupName);
+   MyGroup->addField(FieldName);
+   FieldGroup::addFieldToGroup(FieldName, GroupName);
 ```
 The latter is useful especially if the group was created elsewhere. If the
 field has already been added to the group, no additional entries are created.
@@ -289,15 +288,15 @@ The FieldGroup pointer can also be retrieved:
 
 A field can be removed from a field group using:
 ```c++
-   int Err = FieldGroup::removeField(FieldName);
+   MyGroup->removeField(FieldName);
    // or
-   int Err = removeFieldFromGroup(FieldName, GroupName);
+   FieldGroup::removeFieldFromGroup(FieldName, GroupName);
 ```
 The removal of a field from a group does not remove the field itself, it only
 removes the field name from the list of fields assigned to the group.
 The entire group can be removed with:
 ```c++
-   int Err = FieldGroup::destroy(GroupName);
+   FieldGroup::destroy(GroupName);
 ```
 and the usual ``FieldGroup::clear();`` should be used to remove all field
 groups before exiting.

components/omega/src/base/Decomp.cpp

@@ -450,9 +450,7 @@ Decomp::Decomp(
     const std::string &MeshFileName_ //< [in] name of file with mesh info
 ) {
 
-   Error IOErr;
    bool TimerFlag = Pacer::start("Decomp construct");
-   int Err        = 0; // internal error code
 
    // Retrieve some info on the MPI layout
    MPI_Comm Comm = InEnv->getComm();
@@ -1123,8 +1121,6 @@ void Decomp::partCellsParMetisKWay(
     const std::vector<I4> &CellsOnCellInit // [in] cell nbrs in linear distrb
 ) {
 
-   int Err = 0; // internal error code for MPI and Metis/ParMetis
-
    // Retrieve some info on the MPI layout
    MPI_Comm Comm = InEnv->getComm();
    I4 NumTasks   = InEnv->getNumTasks();
@@ -1533,6 +1529,8 @@ void Decomp::partEdges(
       // Broadcast this buffer
       Err       = Broadcast(EdgeBuf, InEnv, ITask);
       TimerFlag = Pacer::stop("partEdgesOwnerBcast") && TimerFlag;
+      if (Err != 0)
+         ABORT_ERROR("Decomp partEdges: Error broadcasting Edge owner info");
 
       // For each edge in the buffer, check to see if the task owns
       // the cell. If so, add the edge ID to the owned edges list.
@@ -1666,6 +1664,8 @@ void Decomp::partEdges(
       // Broadcast the list of edges owned by this task
       Err       = Broadcast(EdgeBuf, InEnv, ITask);
       TimerFlag = Pacer::stop("partEdgesFinalBcast") && TimerFlag;
+      if (Err != 0)
+         ABORT_ERROR("Decomp partEdges: Error in final broadcast");
 
       // Extract the buffer into a local search vector
       TimerFlag   = Pacer::start("partEdgesFinalSearch") && TimerFlag;
@@ -1801,6 +1801,8 @@ void Decomp::partVertices(
       // Broadcast this buffer
       Err       = Broadcast(VrtxBuf, InEnv, ITask);
       TimerFlag = Pacer::stop("partVerticesOwnedBcast") && TimerFlag;
+      if (Err != 0)
+         ABORT_ERROR("Decomp partVertices: error broadcasting owned vertices");
 
       // For each vertex in the buffer, check to see if the task owns
       // the cell. If so, add the vertex ID to the owned vertices list.
@@ -1935,6 +1937,8 @@ void Decomp::partVertices(
       // Broadcast the list of vertices owned by this task
       Err       = Broadcast(VrtxBuf, InEnv, ITask);
       TimerFlag = Pacer::stop("partVerticesFinalBcast") && TimerFlag;
+      if (Err != 0)
+         ABORT_ERROR("Decomp partVertices: error in final broadcast");
 
       // Extract the buffer into a local search vector
       TimerFlag   = Pacer::start("partVerticesFinalSearch") && TimerFlag;

components/omega/src/infra/Dimension.cpp

@@ -1,5 +1,4 @@
-//===-- infra/Dimension.cpp - OMEGA dimension implementation -----*- C++
-//-*-===//
+//===-- infra/Dimension.cpp - OMEGA dimension implementation ----*- C++ -*-===//
 //
 // Implementation of the field dimension class used by the multi-dimensional
 // Field class
@@ -48,13 +47,13 @@ std::shared_ptr<Dimension> Dimension::create(
       // Retrieve the previously defined dim and use that unless...
       Dim = get(Name);
 
-      // The already-defined dim has different properties, so the dimensions
-      // are not the same and we have a conflict
+      // If the already-defined dim has different properties, the dimensions
+      // are not the same and we have a conflict and should abort
       if ((Dim->GlobalLength != GlobalLength) or
           (Dim->LocalLength != LocalLength) or !Dim->Distributed) {
-         LOG_ERROR("Attempt to create dimension {} but a dimension with"
-                   " that name already exists with different properties",
-                   Name);
+         ABORT_ERROR("Attempt to create dimension {} but a dimension with"
+                     " that name already exists with different properties",
+                     Name);
          Dim = nullptr;
       }
 
@@ -85,13 +84,13 @@ Dimension::create(const std::string &Name, // [in] name of dimension
       // Retrieve the previously defined dim and use that unless...
       Dim = get(Name);
 
-      // The already-defined dim has different properties, so the dimensions
-      // are not the same and we have a conflict
+      // If the already-defined dim has different properties, the dimensions
+      // are not the same and we have a conflict and must abort
       if ((Dim->GlobalLength != GlobalLength) or
           (Dim->LocalLength != GlobalLength) or Dim->Distributed) {
-         LOG_ERROR("Attempt to create dimension {} but a dimension with"
-                   " that name already exists with different properties",
-                   Name);
+         ABORT_ERROR("Attempt to create dimension {} but a dimension with"
+                     " that name already exists with different properties",
+                     Name);
          Dim = nullptr;
       }
 
@@ -130,9 +129,8 @@ void Dimension::destroy(
    if (exists(Name)) {
       AllDims.erase(Name);
    } else {
-      LOG_ERROR("Attempt to destroy the dimension {} failed: "
-                "dimension does not exist or has not been defined.",
-                Name);
+      LOG_WARN("Ignoring attempt to destroy the non-existent dimension {}.",
+               Name);
    }
 
 } // end destroy
@@ -146,14 +144,11 @@ void Dimension::clear() { AllDims.clear(); }
 std::shared_ptr<Dimension>
 Dimension::get(const std::string &Name // [in] Name of dimension
 ) {
-   if (exists(Name)) {
-      return AllDims[Name];
-   } else {
-      LOG_ERROR("Cannot retrieve dimension {}: dimension does not exist"
-                " or has not net been defined",
-                Name);
-      return nullptr;
-   }
+   if (!exists(Name))
+      ABORT_ERROR("Cannot retrieve dimension {}: dimension does not exist.",
+                  Name);
+
+   return AllDims[Name];
 
 } // end get full dimension instance
 
@@ -176,9 +171,9 @@ bool Dimension::isDistributedDim(
       return ThisDim->Distributed;
 
    } else {
-      LOG_ERROR("Cannot check distribution of dimension {}: "
-                "dimension does not exist or has not been defined",
-                Name);
+      LOG_WARN("Cannot check distribution of dimension {}: "
+               "dimension does not exist or has not been defined",
+               Name);
       return false;
    }
 }
@@ -192,18 +187,16 @@ I4 Dimension::getLengthGlobal() const { return GlobalLength; }
 I4 Dimension::getDimLengthGlobal(
     const std::string &Name // [in] name of dimension
 ) {
-   I4 Length;
+   I4 Length = -1;
 
-   // Make sure dimension exists
+   // If dimension exists, return global length. Otherwise abort.
    if (exists(Name)) {
       std::shared_ptr<Dimension> ThisDim = AllDims[Name];
       Length                             = ThisDim->GlobalLength;
 
    } else {
-      LOG_ERROR("Cannot get global length of dimension {}: "
-                "dimension does not exist or has not been defined",
-                Name);
-      Length = -1;
+      ABORT_ERROR("Cannot get global length of non-existent dimension {}.",
+                  Name);
    }
 
    return Length;
@@ -219,18 +212,16 @@ I4 Dimension::getLengthLocal() const { return LocalLength; }
 I4 Dimension::getDimLengthLocal(
     const std::string &Name // [in] name of dimension
 ) {
-   I4 Length;
+   I4 Length = -1;
 
-   // Make sure dimension exists
+   // If dimension exists, return local length. Otherwise, abort.
    if (exists(Name)) {
       std::shared_ptr<Dimension> ThisDim = AllDims[Name];
       Length                             = ThisDim->LocalLength;
 
    } else {
-      LOG_ERROR("Cannot get local length of dimension {}: "
-                "dimension does not exist or has not been defined",
-                Name);
-      Length = -1;
+      ABORT_ERROR("Cannot get local length of non-existent dimension {}.",
+                  Name);
    }
 
    return Length;
@@ -249,8 +240,7 @@ Dimension::getDimOffset(const std::string &Name // [in] name of dimension
 
    // Abort if the dimension does not exist
    if (!exists(Name))
-      ABORT_ERROR("Cannot get offset array for dimension {}: "
-                  "dimension does not exist or has not been defined",
+      ABORT_ERROR("Cannot get offset array for non-existent dimension {}.",
                   Name);
 
    // Retrieve offset