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 3 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

Add a harvest of crop grain and residue
2.OwnerBeth Drewniak
3.Created
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: Add harvest of crop grain and residue

Requirements and Design

ACME Land Group

Date:   

Summary

Crops in ALM are harvested at maturity, however, the grain component is handled as litter and placed in the corresponding litter pools. This alters the biogeochemistry cycle by depositing carbon and nitrogen in the soil that would otherwise be consumed. A crop harvest subroutine is added to put crop grain into an external product pool that is respired to the atmosphere rather than into a litter pool. This also allows the optional harvest of residue (leaves and stems), which will also go into the product pool with the grain. The product pool is respired to the atmosphere over a 1-year period. This subroutine also calculates the yield in bu/acre and t/ha.

 

Requirements

Requirement: Add harvest subroutine and product pool

Date last modified:   
Contributors: Beth Drewniak


This subroutine requires three components: 1) yield calculator, 2) creation of a product pool with 1-yr turnover, treatment of grain carbon and nitrogen at harvest by diverting to product pool. In addition to the code modifications, three additional parameters are added to the parameter file including: proportion of residue harvested with grain, fraction of grain that is harvested, and a conversion factor from gC/m2 to bu/acre. 

 

Algorithmic Formulations

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

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

 

For each requirement, there is a design solution that is intended to meet that requirement. Design solutions can include detailed technical discussions of PDEs, algorithms, solvers and similar, as well as technical discussion of performance issues. In general, this section should steer away from a detailed discussion of low-level software issues such as variable declarations, interfaces and sequencing.

 

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)

 

This section should detail the plan for implementing the design solution for requirement XXX. In general, this section is software-centric with a focus on software implementation. Pseudo code is appropriate in this section. Links to actual source code are appropriate. Project management items, such as svn branches, timelines and staffing are also appropriate. How do we typeset pseudo code?

 

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?

Planned Validation Testing 

Validation 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? What observational or other dataset will be used?  i.e. how will be we know when we have met requirement XXX. Will these unit tests be included in the ongoing going forward?

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