Skip to content

Latest commit

 

History

History

readme.md

@mainpage MFC Documentation

Welcome to the Multi-component Flow Code (MFC) documentation.

Getting Started

  • @ref getting-started "Getting Started" - Installation and first steps
  • @ref running "Running" - How to run simulations (interactive, batch, GPU)
  • @ref case "Case Files" - Setting up input files
  • @ref testing "Testing" - Running the test suite

Reference

  • @ref equations "Equations" - Comprehensive equations reference
  • @ref parameters "Case Parameters" - All ~3,400 parameters
  • @ref cli-reference "CLI Reference" - Command line options
  • @ref case_constraints "Case Creator Guide" - Feature compatibility
  • @ref physics_constraints "Physics Constraints" - Mathematical basis for validation rules

Examples & Visualization

  • @ref examples "Example Cases" - Sample simulations
  • @ref visualization "Flow Visualization" - Post-processing

Advanced Topics

  • @ref architecture "Code Architecture" - How the source code is organized, data flow, and module map
  • @ref expectedPerformance "Performance" - Optimization and benchmarks
  • @ref gpuParallelization "GPU Parallelization" - GPU macro API (developer reference)
  • @ref docker "Containers" - Docker usage
  • @ref troubleshooting "Troubleshooting" - Debugging and common issues

Development

  • @ref contributing "Contributing" - Developer guide and coding standards
  • API Documentation - Source code reference for all three components

About

  • @ref papers "Papers" - Publications using MFC
  • \ref citelist "Bibliography" - Cited references
  • @ref authors "Authors" - Contributors
Page last updated: 2026-02-19