Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

The Design Document page provides a description of the algorithms, implementation and planned testing including unit, verification, validation and performance testing. Please read  Step 1.3 Performance Expectations that explains feature documentation requirements from the performance group point of view. 

Design Document

 Click here for instructions to fill up the table below ......

The first table in Design Document gives overview of this document, from this info the Design Documents Overview page is automatically created.

In the overview table below 4.Equ means Equations and Algorithms, 5.Ver means Verification, 6.Perf - Performance, 7. Val - Validation

  • Equations: Document the equations that are being solved and describe algorithms
  • Verification Plans: Define tests that will be run to show that implementation is correct and robust. Involve unit tests to cover range of inputs as well as benchmarks.
  • Performance expectations: Explain the expected performance impact from this development
  • Validation Plans: Document what process-based, stand-alone component, and coupled model runs will be performed, and with what metrics will be used to assess validity

Use the symbols below (copy and paste) to indicate if the section is in progress or done or not started.

In the table below 4.Equ means Equations and Algorithms, 5.Ver means Verification, 6.Perf - Performance, 7. Val - Validation,   (tick) - competed, (warning) - in progress, (error) - not done

 

Overview table for the owner and an approver of this feature

1.Description

Land-Ice Land GLC Coupling Via CIME
2.OwnerMatt Hoffman
3.Created2015/9/21
4.Equ(error)
5.Ver(error)
6.Perf(error)
7.Val(error)
8.Approver 
9.Approved Date 
 Click here for Table of Contents ...

Table of Contents

 

 

 

Title: O_25_LI Land GLC Coupling Via CIME

Requirements and Design

ACME Ice-Ocean  Group

Date: //date  

Summary

The GLC model receives surface temperature and surface mass balance from the LND model.  This coupling was implemented in CESM for CISM and is available to ACME via CIME. The CISM-CESM coupling also included liquid and solid runoff from the ice sheet model, which while not ... SOMETHING MISSING HERE? GLC-LND coupling is also considered here. 

This functionality needs to be reproduced for MPASLI in ACME.

Requirements

The implementation of what CISM's GLC requires to work with the GLC-LND coupling in CIME can largely be seen in the GLAD modules created by Bill Sacks (Unlicensed) in CISM: https://github.com/ACME-Climate/cism-piscees/pull/35


Requirement: Fields from coupler to GLC

Date last modified: 2015/09/21
Contributors: Matt Hoffman, Bill Sacks (Unlicensed), Jeremy Fyke (Unlicensed), William Lipscomb (Unlicensed)


The GLC component receives fields from the LND model via the coupler:
  1. qsmb - surface mass balance of glacier ice (kg/m^2/s)
  2. tsfc - surface ground temperature (deg C)

Starting with CIME, the coupler does downscaling so these fields are on the GLC grid. 

In order for the coupler to return correct values of these fields, GLC must pass to the coupler gtopo and ice_coveredMJH: I'm guessing about this - is this correct?


Requirement: Fields from GLC to coupler

Date last modified: 2015/09/21
Contributors: Matt Hoffman, Bill Sacks (Unlicensed), Jeremy Fyke (Unlicensed), William Lipscomb (Unlicensed)

The GLC component needs to pass fields to the coupler:

  1. gtopo - surface elevation of each GLC grid cell (m) (state: current snapshot)
  2. ice_covered - whether each grid cell is ice-covered [0,1] (state: current snapshot?) SFP: Clarify if 0,1 are the only options or if a fractional value allowed?
  3. hflx - output heat flux (W/m^2, positive down) (flux: time-average) MJH: Is this at the ice sheet-atmosphere boundary? SFP: This is computed in the coupler? It's not computed in the ice sheet model.
  4. rofi - output ice runoff (kg/m^2/s = mm H2O/s) (flux: time-average) (This is not a LND coupling, but including it here as it also needs hooking-up.)  MJH: This is sent to OCN model, correct?
  5. rofl - output liquid runoff (kg/m^2/s = mm H2O/s) (flux: time-average) (This is not a LND coupling, but including it here as it also needs hooking-up.) MJH: Is this sent to the ROF or the OCN model?
  6. ice_sheet_grid_mask - mask of ice sheet grid coverage (state: current snapshot?)  MJH: how does this differ from "ice_covered"?
  7. icemask_coupled_fluxes - mask of ice sheet grid coverage where we are potentially sending non-zero fluxes (state: current snapshot? or consistent with the flux fields?) MJH: is there a more complete description of what this means?

These fields need to be accumulated/averaged properly over the coupling interval by GLC.  MJH: Which ones should be averaged vs. using a snapshot of the final time in the coupling interval?

Note that gtopo and ice_covered need to be updated in a TG run for qsmb, tsfc from the coupler to be correct (i.e., updated in time as the ice sheet evolves SFP: does this require dynamic land units then?).  However, those fields are not actually passed on to the LND model in an IG/BG run.  In contrast, ice_covered is sent back to the LND model to determine where SMB calculations occur.  MJH: I'm guessing about this - is this correct?

Algorithmic Formulations

Design solution: short-description-of-proposed-solution-here

Date last modified:// date
Contributors: (add your name to this list if it does not appear)

 

(Not sure this section is necessary for this as this should be a relatively straightforward software engineering problem.)

Design and Implementation

Implementation: short-desciption-of-implementation-here

Date last modified: // date
Contributors: (add your name to this list if it does not appear)

 

(Leaving this partially blank for now until requirements are more fully understood.  My intent is to get a TG case working first, than move to IG.)

 

Planned Verification and Unit Testing 

Verification and Unit Testing: short-desciption-of-testing-here

Date last modified:  
Contributors: (add your name to this list if it does not appear)

 

How will XXX be tested? i.e. how will be we know when we have met requirement XXX. Will these unit tests be included in the ongoing going forward?

SFP: not sure what a unit or verification test would look like for coupling. Anyone?



Planned Validation Testing

Validation Testing: GLC-LND coupling

Date last modified:2015/09/21
Contributors: Matt Hoffman, Jeremy Fyke (Unlicensed), William Lipscomb (Unlicensed)


Testing will be a sanity check of the MPASLI field sfcMassBal as output from a TG and an IG run.  MJH: Do we want something more substantial than this??
 

SFP: I suggest that the validation test here is, at least for now, an eyeball norm against some previously accepted solution (E.g. RACMO or some prev. version of CESM calc. SMB over Greenland). We could make this more quantitative by suggested a total integrated SMB we want to match (e.g. in Gt / yr) +/- some error range.


Planned Performance Testing 

Performance Testing: short-desciption-of-testing-here

Date last modified:
Contributors: (add your name to this list if it does not appear)

 

How will XXX be tested? i.e. how will be we know when we have met requirement XXX. Will these unit tests be included in the ongoing going forward?

 

 

  • No labels