Skip to content

Commit

Permalink
Further modifications to README.
Browse files Browse the repository at this point in the history
  • Loading branch information
phlndrwd committed Oct 13, 2023
1 parent de71a6d commit 10f1ae9
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ After satisfying the dependencies outlined above, MONIO was built and tested usi

MONIO has been written to address the known use cases defined within the MO-JEDI context. These are captured in the public functons defined in the `Monio` singleton class. Once `Monio.h` is included in a source file it can be used directly.

In the following scenarios, the only common parameter is an `atlas::FieldSet` that uses an `atlas::CubedSphereGrid` and an `atlas::Mesh` configured as a `"cubedsphere_dual"`. Passing a `atlas::FieldSet` of a different configuration may cause issues that prevent MONIO from functioning correctly.
In the following scenarios, the only common parameter is an `atlas::FieldSet` that uses an `atlas::CubedSphereGrid` and an `atlas::Mesh` configured as a `"cubedsphere_dual"`. Passing a `atlas::FieldSet` of a different configuration can prevent MONIO from functioning correctly.

Most of the functions in `monio::Monio` also take a reference to a `std::vector<consts::FieldMetadata>`. This is a standard C++ `std::vector` of `consts::FieldMetadata` structs defined in MONIO's `Constants.h` file. The struct instances in this vector must correspond to a `atlas::Field` in the `atlas::FieldSet`. They are accessed by the value of `FieldMetadata.jediName`. If a `atlas::Field` in the `atlas::FieldSet` has no corresponding instance of `consts::FieldMetadata`, they will not be processed. If an instance of `consts::FieldMetadata` does not correspond to a `atlas::Field` in the `atlas::FieldSet`, an exeption will be generated and program execution will cease.

Expand Down

0 comments on commit 10f1ae9

Please sign in to comment.