History

ignis 2998e94432 docs: implement literal programming docs builder and compile reference manual		2026-05-31 16:03:21 +00:00
..
code_gen.md	docs: implement literal programming docs builder and compile reference manual	2026-05-31 16:03:21 +00:00
Compact.md	docs: implement literal programming docs builder and compile reference manual	2026-05-31 16:03:21 +00:00
m_arrays.md	docs: implement literal programming docs builder and compile reference manual	2026-05-31 16:03:21 +00:00
m_calculate.md	docs: implement literal programming docs builder and compile reference manual	2026-05-31 16:03:21 +00:00
m_openmpi.md	docs: implement literal programming docs builder and compile reference manual	2026-05-31 16:03:21 +00:00
m_parameters.md	docs: implement literal programming docs builder and compile reference manual	2026-05-31 16:03:21 +00:00
post.md	docs: implement literal programming docs builder and compile reference manual	2026-05-31 16:03:21 +00:00
post_dns.md	docs: implement literal programming docs builder and compile reference manual	2026-05-31 16:03:21 +00:00
pycompact.md	docs: implement literal programming docs builder and compile reference manual	2026-05-31 16:03:21 +00:00
README.md	docs: implement literal programming docs builder and compile reference manual	2026-05-31 16:03:21 +00:00

README.md

HPC DNS Post-Processing Reference Manual

Note

This reference documentation is automatically generated from codebase comments and AST analysis using the literal programming compiler.

Project Architecture Overview

This suite compiles algebraic DSL budget equations, performs high-order compact finite difference calculus, and exports physical terms via MPI-IO. Below is the primary software module pipeline:

graph TD
    A[code_gen.py / DSL Input] -->|AST Compiler Pipeline| B[post.py / Code Gen]
    B -->|Generates budget kernels| C[m_calculate.f90]
    C -->|LU Tridiagonal Solvers| D[Compact.f90]
    C -->|Array allocations| E[m_arrays.f90]
    F[post.f90 / Main Driver] -->|Orchestrates calculations| C
    F -->|Parallelizes domain| G[m_openmpi.f90]
    F -->|Loads run configuration| H[m_parameters.f90]
    I[pycompact.py / Bindings] -->|Wraps CPU calculations| C

Reference Files Index

Document / Code Module	Language	Description
Compact.f90	Fortran 90	This module handles the generation of tridiagonal/pentadiagonal matrices,
m_arrays.f90	Fortran 90	No overview description provided.
m_calculate.f90	Fortran 90	This module calculates spatial derivatives (first and second derivatives in X, Y, Z directions)
m_openmpi.f90	Fortran 90	No overview description provided.
m_parameters.f90	Fortran 90	No overview description provided.
post.f90	Fortran 90	No overview description provided.
post_dns.f90	Fortran 90	No overview description provided.
code_gen.py	Python	Convert the value of `tok` from string to bool, while maintaining line number & column.
post.py	Python	conversion from tree to python data
pycompact.py	Python	No overview description provided.

Generated dynamically by build_docs.py.