Skip to content

Species transport theory + tutorials #64

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

Merged
merged 10 commits into from
Dec 10, 2021
Merged

Species transport theory + tutorials #64

merged 10 commits into from
Dec 10, 2021

Conversation

TobiKattmann
Copy link
Contributor

@TobiKattmann TobiKattmann commented Dec 4, 2021

Adds theory section, a primal tutorial explaining the added cfg options and a somewhat etensive optimization tutorial (including also some developer focused steps: restart validation, Setting up FFD box, testing mesh deformation, gradient validation with FADO, optimization with FADO)

This follows the code contributions su2code/SU2/pull/1388 and su2code/SU2/pull/1461

I host the website locally so that I hope to get everything right

@pr-triage pr-triage bot added the PR: draft label Dec 4, 2021
@TobiKattmann TobiKattmann changed the title [WIP] Species transport theory + tutorials Species transport theory + tutorials Dec 6, 2021
@TobiKattmann TobiKattmann marked this pull request as ready for review December 6, 2021 13:04
@TobiKattmann
Copy link
Contributor Author

So I added both tutorials which are described above. Note that the links to files are pointing to the master tree of the Tutorials repo, i.e. if you host the website locally it wont work but if the new master version comes and every repository is updated, then the links will work.

@TobiKattmann
Copy link
Contributor Author

TobiKattmann commented Dec 9, 2021

TODO: Change to FFD_CONTROL_POINT_2D and also update the set_ffd_design_var.py by --dimension 2 in the resources and Tutorial. That means also changing some files in the Tutorial PR and some pictures here.

Also put the new create_sym_links in here and explain


This Tutorial builds directly on the case given as Prerequisite on the top of the site [link](tutorials/Inc_Species_Transport/). Therefore details to the problem setup, mesh, etc. are not repeated here. However the process outlined in this tutorial is directly applicable to many other cases using SU2.

Instead of the python tools for finite differences or shape optimization that are part of SU2 directly, the standalone python tool [FADO](https://github.com/su2code/FADO) is used. Please follow the information on the given github repo in order to use FADO.
Copy link
Member

Choose a reason for hiding this comment

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

❤️

Comment on lines +59 to +61
## 2. FFD-Box Setup

The setup is fairly simple when following some simple rules. The additional block of code necessary to write the FFD box is given below. Essentially, there are only 3 options (`FFD_DEFINITION`, `FFD_DEGREE` and `DV_MARKER`) where user input is necessary. `DV_KIND= FFD_SETTING` and `DV_PARAM= ( 1.0 )` are fixed and not to be changed.
Copy link
Member

Choose a reason for hiding this comment

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

Great stuff, what do you think of giving this info some more visibility? For example linking to it somewhere at the top of "Summary of tutorials"?

Copy link
Contributor Author

@TobiKattmann TobiKattmann Dec 9, 2021

Choose a reason for hiding this comment

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

Or mention this section (and link it) in the 3 Design Tutorials that use FFD-boxes. The OneraM6, inv_wedge and unsteady shape opt. Like so everyone who does one of these tutorials as a preparation for their own stuff will stumble over this

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The order is important, and you can use the example above to match the convention. ... Thanks for nothing OneraM6 Tutorial :D

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ca27520 Now anyone who comes across a tutorial that uses an FFD-box will be pointed to this.

@TobiKattmann TobiKattmann merged commit 389c26f into develop Dec 10, 2021
@TobiKattmann TobiKattmann deleted the feature_species branch December 10, 2021 09:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants