Skip to content

Conversation

@aryab08
Copy link

@aryab08 aryab08 commented Jan 5, 2026

Proposed Changes

This PR documents tutorial result discrepancies reported by users in issue #1604. Based on forum thread analysis, two tutorials produce results that don't match the website documentation:

  1. Unsteady NACA0012 - Time step configuration mismatch prevents unsteady behavior from developing
  2. Laminar Cylinder - Viscosity and pressure field values differ from tutorial images

This documentation serves as a basis for updating the affected tutorials or their documentation pages.

Related Work

PR Checklist

  • I am submitting my contribution to the develop branch.
  • My contribution generates no new compiler warnings (documentation only).
  • My contribution is consistent with SU2 style.
  • I used the pre-commit hook to prevent dirty commits and used pre-commit run --all to format old commits.
  • I have added a test case that demonstrates my contribution, if necessary. (N/A - documentation only)
  • I have updated appropriate documentation (added tutorial_report.md documenting discrepancies).

@pcarruscag pcarruscag changed the base branch from master to develop January 5, 2026 04:35
Copy link
Member

@pcarruscag pcarruscag left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As I mentioned, what is needed is a fix for the discrepancy, not a note on its existence.

@aryab08
Copy link
Author

aryab08 commented Jan 5, 2026

Thanks for the feedback @pcarruscag! I understand now - you want the actual fix, not just documentation.I have two questions before proceeding:

  1. For NACA0012: Should I update the config file in TestCases/ with the working parameters (CFL_NUMBER=1e12, etc.), or update the website documentation?

  2. For Laminar Cylinder: Should I re-generate the tutorial images with current SU2, or document the correct non-dimensionalization settings?

Which approach would you prefer for each case?

@bigfooted
Copy link
Contributor

1. **For NACA0012:** Should I update the config file in TestCases/ with the working parameters (CFL_NUMBER=1e12, >  etc.), or update the website documentation?

2. **For Laminar Cylinder:** Should I re-generate the tutorial images with current SU2, or document the correct non-

dimensionalization settings?

You should update the config file, then rerun the testcase to verify that it works correctly, then update the webpages, files and figures and regression test results.
To make this procedure easier for the future, you can create a small python script to recreate all the images that are shown on the website using pyvista and matplotlib on the paraview output.

@aryab08
Copy link
Author

aryab08 commented Jan 6, 2026

@pcarruscag I've done a comprehensive search and found a critical issue:

The "Unsteady Pitching NACA0012" test case from the website tutorial does not exist in the repository.

My search:

# Search for unsteady NACA0012 configs
find . -type f -name "*.cfg" | xargs grep -l "NACA.*0012" | grep -i unsteady

# Found only:
- plunging_naca0012 (PLUNGING, not pitching)
- disc_adj_euler/naca0012_pitching (ADJOINT, not forward)

Available in TestCases/unsteady/:

  • pitching_naca0015_rans_inc (different airfoil)
  • pitching_naca64a010_euler (different airfoil)
  • pitching_naca64a010_rans (different airfoil)
  • plunging_naca0012 (wrong motion type)

The Problem:
The website tutorial (https://su2code.github.io/tutorials/Unsteady_NACA0012/) references a test case that doesn't exist in the current repository.

  1. Should I create the missing test case based on the website documentation?
  2. Should I update the website tutorial to use plunging_naca0012 instead?
  3. Was the pitching NACA0012 case removed at some point?

Please advise on the correct approach.

@bigfooted
Copy link
Contributor

1. Should I create the missing test case based on the website documentation?

2. Should I update the website tutorial to use `plunging_naca0012` instead?

3. Was the pitching NACA0012 case removed at some point?
  1. think for yourself.

- Created TestCases/unsteady/pitching_naca0012/ directory
- Added config with corrected parameters (CFL, LINEAR_SOLVER_*)
- Documented fixes based on forum feedback
- Resolves test case availability for tutorial

Addresses su2code#1604
- Updated non-dimensionalization settings
- Ensures tutorial reproducibility

Addresses su2code#1604
@aryab08 aryab08 force-pushed the docs/tutorial-results-documentation branch from 7852568 to c1540a3 Compare January 7, 2026 04:41
- TIME_STEP = 0.005
- CFL_NUMBER = 1e12
- LINEAR_SOLVER_ERROR = 0.1
- LINEAR_SOLVER_ITER = 10
- Updated mesh filename and description
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants