Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MAJOR ISSUES / DEVELOPMENT AREAS #1487

Open
pcarruscag opened this issue Jan 12, 2022 · 1 comment
Open

MAJOR ISSUES / DEVELOPMENT AREAS #1487

pcarruscag opened this issue Jan 12, 2022 · 1 comment

Comments

@pcarruscag
Copy link
Member

pcarruscag commented Jan 12, 2022

[WIP]

Because we can only pin up to 3 issues in GitHub, I'm creating this one to track major aspects we need to fix or implement in SU2.
This issue shall only contain the list and a brief description, with links to associated issues and pull requests.
To propose major issues / development areas please use discussion #1486

The purpose of this list is two fold:

  • Direct the efforts of the SU2 Foundation towards addressing these issues, by efforts I mean funds (as they become available).
  • Try to enlist help from the community to start addressing these issues, as much as possible we will try to break these down into "bite sized" chunks.

To be clear, all contributions are welcome, even if they do not fit in one of the categories below.
The main objective here is consolidation, making SU2 do more things well (v&v'd, unit-tested, documented, etc.)

Documentation

Turbulence models

Validation and Verification

  • V&V of features that lack coverage (i.e. a particular fluid model, design variable, etc.), followed by regression test and ideally tutorial Validation Suite for SU2 #581
  • Put the V&V cases under regression to ensure they are up to date (similar to what is done with tutorials).

Testing and test cases

  • More unit tests Add Unit Testing to SU2 #698
  • Cleanup of TestCases to make them "Minimum working examples" (no redundant options, no duplication of descriptions from the config template, etc.).
  • "Obscure" features ("things that SU2 does" to some extent but are: incomplete, not validated / regression-tested, not documented) cleanup obsolete examples in TestCases, and identify features lacking test coverage, decide what to do with those features.

Code maintenance

Robust convergence

Customization

Optimization

Completely new development areas

@pcarruscag
Copy link
Member Author

pcarruscag commented Feb 8, 2022

V&V

Now we have a regression script dedicated to the V&V examples see #1538
I have added a high-lift case to the website (here, and here).
I think that to avoid the issue of outdated files in V&V repo, the best strategy is to add only meshes and documentation to the V&V repo (without duplicating the website). Then anything needed to run the case should be put under regression (via the TestCases and SU2 repos as usual).
If the meshes are too large for GitHub, and are not publicly available elsewhere, we can use the SU2 Foundation Google drive. The config files can be forced to remain updated by running them in --dry_run mode in the V&V regressions.

So I think the next steps would be:

  • Revive the configs of the other V&V cases and put them under regression.
  • Add V&V for other areas.

So if you have ever done any V&V of an SU2 feature not covered yet please consider adding the data to the V&V repo, the results to the website, and creating a minimal regression test for it. If you have never done any V&V, please consider reviving one of the existing ones.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant