Developer Documentation

This section is meant for potential developers who are interested in modifying and extending the Kynema-SGF source code for their own use cases.

Kynema-SGF is built on top of AMReX library. Users are strongly recommended to read through the AMReX documentation and understand the basic AMReX concepts before jumping into the Kynema-SGF source code.

The Basics section provides a thorough overview of the basic data structures and ways to interact with these structures. The GPU section provides an overview of the AMReX GPU strategy and the higher-level functions (e.g., parallel-for abstractions) available to write GPU-ready code within Kynema-SGF. The Linear Solvers section provides an overview of the multi-level multigrid (MLMG) solvers used to solve the various linear systems within Kynema-SGF.

• Documentation
  • Manual
    • Writing documentation
  • Source code documentation
  • Building documentation
    • Dependencies
    • Build
• Kynema-SGF API
• Unit testing
  • Running unit tests
  • Basic unit test concepts
    • Assertions
    • Tests and Test Fixtures
  • Unit testing in Kynema-SGF
    • Unit test scaffolding
    • Example unit tests
• Regression testing
  • Enabling and running regression tests
  • Testing against gold files
    • Example output for a failed test
  • Test file organization
    • Creating new regression tests
    • Test outputs and troubleshooting
• Verification
  • Building and linking MASA
    • Building MASA from source
    • Building MASA using Spack
    • Linking MASA to Kynema-SGF
  • Performing the MMS verification
  • Convecting Taylor Vortex (CTV)
  • Ekman spiral
  • Channel flow (laminar, quasi-2D) with different BCs
  • Burggraf flow: lid-driven cavity with body force
  • Channel flow with Smagorinsky LES
    • Parameter values for testing
    • Test results
• Coding Guidelines
  • Style Guide/Recommendations
    • Sample C++ code