ccpp-framework icon indicating copy to clipboard operation
ccpp-framework copied to clipboard

Add diagnostic_name metadata field

Open peverwhee opened this issue 10 months ago • 2 comments

Description

Add new diagnostics name metadata field to be used by the constituents object*

*Note: for now, the new metadata field will only be used by the constituents object, but can be extended to be used by the amorphous future diagnostics object (#579)

Related to #461

Solution

  1. Add new optional metadata field - diagnostic_name - to the metadata.
  2. Add new diagnostics name attribute to the constituents object that is set to the diagnostic name field in the metadata (or through the instantiate call)

peverwhee avatar Feb 03 '25 17:02 peverwhee

How is this diagnostic_name used? For a single constituent, there may be many places where the value of a constituent may want to be sampled. Is this name just for host model use? Is it a base name for other uses (e.g., <diagnostic_name>_after_dynamics, <diagnostic_name>_before_microphysics)?

gold2718 avatar Feb 04 '25 21:02 gold2718

For now at least, it will just be host model use. It'll be up to the host model to add _after_dynamics if necessary (so, I guess just a base name as you say).

peverwhee avatar Feb 05 '25 05:02 peverwhee