Automatic Code Generator Sample Code (0 diff)

[JulesKouatchou]

Description

• We provide a sample code that shows how to use the Automatic Code Generator tool.
• The code reflects the example presented in the documentation.
• The code comes with a spec file and a CMakeLists.txt file needed for the tool to work properly.

Related Issue

Motivation and Context

The sample code is meant to provide an example on the necessary changes users need to introduce in their application if they want to use the automatic code generator tool.

How Has This Been Tested?

Our main task was to only make sure that the code could compile by generating the necessary __.h files (four of them). The code is not used to create any executable.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Trivial change (affects only documentation or cleanup)

Checklist:

• I have tested this change with a run of GEOSgcm (if non-trivial)
• I have added one of the required labels (0 diff, 0 diff trivial, 0 diff structural, non 0-diff)
• I have updated the CHANGELOG.md accordingly following the style of Keep a Changelog

[tclune]

Minor change requested.

[mathomp4]

@JulesKouatchou Can you also include a CHANGELOG entry about this as well (along with @tclune 's suggestion?)

[tclune]

Not strongly opposed, but ... the directory is not the acg. It is stuff that uses the acg. Maybe obvious(ish) from context, but I'd prefer something that indicated that it does not in fact contain the ACG.

[tclune]

Our usual convention is that gridcomps have the same name as the directory that they are in.

Long story, but the convention got botched during early deployment so we have dirs like: GEOSgcm_GridComp that are supposed to be GEOS_GcmGridComp. Going to Git was supposed to let us do that, but we've been afraid to pull the trigger.

[JulesKouatchou]

• Changed the directory name (automatic_code_generator) and file names (ACG_GridComp.F90 and ACG_StateSpecs.rc).
• Edited the CHANGELOG.md file
• Verified that the new sample code still compiles.

[mathomp4]

I pushed a conflict fix up. I couldn't do it on the web.