# CFD Case Notes and Mini Report Template

## Purpose
This template is designed to help CFD and CAE engineers systematically document their simulation setup, assumptions, convergence behavior, and results for a specific case. It serves as a practical asset for internal reviews, quality assurance, and historical record-keeping.

## How to use this template
- **Copy and rename**: Create a copy of this file for each simulation case (e.g., `case-001-baseline.md`).
- **Fill in the blanks**: Replace the placeholder text under each section with case-specific details. If a section is not applicable (e.g., heat transfer in an isothermal case), mark it as "N/A".
- **Attach to reports/issues**: Include this document alongside your raw solver files or attach it to your simulation tracking system.

---

## 1. Project and Case Metadata
- **Project Name:** [e.g., Aero Package 2024]
- **Case ID:** [e.g., RUN-045-yaw-5deg]
- **Analyst:** [Name]
- **Reviewer:** [Name]
- **Date:** [YYYY-MM-DD]
- **Template Version:** 1.0.0
- **Solver / Software / Version:** [e.g., open-source CFD software v2312, commercial CFD software 2024R1]
- **Hardware / Environment:** [e.g., Local Workstation, 32 Cores / HPC Cluster, 128 Cores]

## 2. Executive Summary
- **Objective:** [What is the purpose of this specific run? e.g., Evaluate drag reduction of the new rear wing design at 5 degrees yaw.]
- **Key Result:** [What was the main finding? e.g., Drag reduced by 2.4%, but flow separation observed near the endplate.]
- **Decision Supported:** [What engineering decision does this case inform? e.g., Proceed to wind tunnel testing with this design.]
- **Confidence Level:** [High / Medium / Low] - [Brief justification]
- **Main Limitations:** [e.g., Assumes perfectly smooth walls; does not model wheel rotation.]

## 3. Objective and Quantities of Interest
- **Design Question:** [e.g., Does the pressure drop across the valve exceed 50 kPa at maximum flow rate?]
- **Target Outputs (QoIs):** [List the specific metrics you are extracting, e.g., Pressure Drop, Mass Flow Rate, Max Temperature.]
- **Success / Acceptance Criteria:** [e.g., Mass balance < 0.1%, Drag coefficient stabilized within 1%.]
- **Comparison / Reference Data:** [e.g., Experimental data from Test Report TR-102, or baseline CFD run RUN-001.]

## 4. Geometry and Domain Assumptions
- **Geometry Source / Version:** [e.g., CAD v4 from PLM system]
- **Simplifications:** [e.g., Removed small fillets < 2mm, simplified bolt heads.]
- **Excluded Features:** [e.g., Thermal shielding not modeled.]
- **Symmetry / Periodicity:** [e.g., Half-car model using symmetry plane at Y=0.]
- **Domain Extents:** [e.g., Upstream 5L, Downstream 15L, Top/Sides 5L.]
- **Interfaces / Moving Parts:** [e.g., MRF zone used for the fan rotor.]

## 5. Physics and Model Assumptions
- **Time Dependency:** [Steady-state / Transient]
- **Compressibility:** [Incompressible / Compressible (Ideal Gas)]
- **Turbulence Model:** [e.g., k-omega SST]
- **Wall Treatment & y+ Strategy:** [e.g., Wall functions utilized, target y+ between 30 and 100.]
- **Heat Transfer / Multiphase / Species:** [e.g., Conjugate heat transfer enabled, radiation disabled.]
- **Material / Fluid Property Assumptions:** [e.g., Air at standard sea level conditions, constant density.]

## 6. Boundary Conditions
- **Inlet:** [e.g., Velocity Inlet, 25 m/s normal to boundary.]
- **Outlet:** [e.g., Pressure Outlet, 0 Pa gauge.]
- **Walls:** [e.g., No-slip, adiabatic.]
- **Symmetry / Periodic / Interfaces:** [e.g., Symmetry plane at mid-span.]
- **Turbulence Quantities:** [e.g., Turbulence Intensity = 5%, Viscosity Ratio = 10.]
- **Temperature / Heat Flux:** [e.g., N/A]
- **BC Source / Rationale:** [e.g., Inlet velocity derived from wind tunnel test conditions.]

## 7. Mesh Summary
- **Mesh Type:** [e.g., Polyhedral with boundary layer prisms.]
- **Cell Count:** [e.g., 12.5 Million]
- **Local Refinement Regions:** [e.g., Wake region refined to 5mm maximum edge size.]
- **Inflation / Prism Layers:** [e.g., 12 layers, growth rate 1.2, first layer thickness 0.1mm.]
- **y+ Summary:** [e.g., Area-averaged y+ = 45, max y+ = 120 on the leading edge.]
- **Quality Metrics:** [e.g., Max Skewness = 0.85, Min Orthogonal Quality = 0.15.]
- **Mesh Independence Plan / Status:** [e.g., This is the "Medium" mesh of a 3-grid study.]

## 8. Solver Setup
- **Discretization Schemes:** [e.g., Second-order upwind for momentum, first-order for turbulence kinetic energy.]
- **Time Step / Pseudo Time Step:** [e.g., Local time stepping (CFL=5) for steady state.]
- **Convergence Criteria:** [e.g., Residuals < 1e-4, monitors stable for 500 iterations.]
- **Monitors:** [e.g., Drag coefficient, lift coefficient, area-averaged total pressure at outlet.]
- **Initialization:** [e.g., Hybrid initialization computed from the inlet.]
- **Relaxation / Stabilization Notes:** [e.g., Under-relaxation factors for momentum reduced to 0.5 for the first 100 iterations.]

## 9. Convergence Summary
- **Residual Behavior:** [e.g., All residuals dropped below 1e-4 by iteration 800.]
- **Monitor Stability:** [e.g., Drag coefficient stabilized at 0.315 with a variation of +/- 0.001 over the last 300 iterations.]
- **Mass / Energy Imbalance:** [e.g., Global mass imbalance = 0.005%.]
- **Transient Averaging Window:** [e.g., N/A]
- **False-Convergence Checks:** [e.g., Verified that flow field is not changing significantly between iteration 1000 and 1500.]

## 10. Validation and Sanity Checks
- **Reference Data:** [e.g., Matches wind tunnel drag coefficient within 3%.]
- **Hand Calculation:** [e.g., Pressure drop roughly matches Moody friction factor estimate.]
- **Nondimensional Checks:** [e.g., Reynolds number confirmed to be 1.5e6 based on characteristic length.]
- **Benchmark Comparison:** [e.g., Consistent with previous validation case VAL-002.]
- **Uncertainty Notes:** [e.g., High sensitivity to inlet turbulence boundary conditions observed.]

## 11. Results Summary
- **Primary Plots / Tables:** [List key visuals generated, e.g., Velocity contours on center plane, surface pressure plots.]
- **Key Numerical Values:**
  - Drag Coefficient: [Value]
  - Lift Coefficient: [Value]
  - Pressure Drop: [Value]
- **Observed Flow Features:** [e.g., Large recirculation zone identified directly behind the bluff body.]
- **Sensitivity Observations:** [e.g., Results are sensitive to the location of the wake refinement region.]

## 12. Limitations and Risk Notes
- **Model Limitations:** [e.g., Steady-state assumption may suppress transient vortex shedding effects.]
- **Mesh Limitations:** [e.g., Wake refinement may not extend far enough downstream to capture full recovery.]
- **BC Limitations:** [e.g., Uniform inlet velocity profile ignores actual wind tunnel boundary layer.]
- **Validation Limitations:** [e.g., Experimental data used for comparison has a +/- 5% uncertainty.]
- **What NOT to infer:** [e.g., Do not use this case to predict high-frequency acoustic noise.]

## 13. Review Checklist
- [ ] Setup Reviewed (Geometry, BCs, Physics)
- [ ] Mesh Reviewed (Quality, y+, Refinement)
- [ ] Convergence Reviewed (Residuals, Monitors, Imbalances)
- [ ] Validation/Sanity Checks Performed
- [ ] Limitations Documented

## 14. Reviewer Notes and Signoff
- **Reviewer Comments:** [e.g., The setup looks solid. Consider running a transient case next to verify the vortex shedding frequency.]
- **Signoff / Approval:** [Name / Date]

---

**Disclaimer:** This document is an educational workflow aid and template provided by the konio project. It does not replace official solver documentation, formal validation procedures, project-specific QA protocols, or professional engineering judgment. No specific simulation results, safety, or certification claims are guaranteed by the use of this template.