Newton-Krylov_OOC Documentation

Newton-Krylov_OOC is an Out-of-Core Newton-Krylov Solver.

The source code for the solver is available via github.

Documentation is comprised of three documents:

1. Description: This document describes the mathematics and implementation of the solver. The intended audience is those desiring to understand how the solver works.

2. User’s Guide: This document describes how to practically use the software. The intended audience is those using the solver.

3. Developer’s Guide: This document describes software practices and tools that are used in the development of the software. The intended audience is those developing the solver, including those adding support to the solver for new models or tracer modules.

Please note that the documentation is under development.

Contents:

• Newton-Krylov_OOC Solver Description
  • Background
  • Terminology
  • Model Independent Description
  • test_problem Model Description
  • cime_pop Model Description
• Newton-Krylov_OOC User’s Guide
  • Getting Setup
  • Model Independent Details
  • Tracer Module Definition File Description
  • test_problem Model Usage
  • cime_pop Model Usage
  • FAQs
• Newton-Krylov_OOC Developer’s Guide
  • Testing and Coding Practices
  • Documentation Practices
  • Adding a New Model to the Solver
  • Adding a New Tracer Module to the test_problem Model
  • Adding a New Tracer Module to the cime_pop Model

Indices and tables

• Index

• Module Index

• Search Page