Addition of undocumented and soon-to-be-documented example files for the Cahn-Hilliard solver #1307

PierreLaurentinCS · 2024-10-03T22:36:30Z

Description

In order to keep a trace of the work done with the Cahn-Hilliard-Navier-Stokes solver, five undocumented examples were added to the main branch along with their post-processing python scripts.
Two of these examples (jurin's law and bubble detachment in a shear flow) will have their own documentation entry in a near future.

Testing

I made sure the example run without error on the main branch. I also made sure the results obtained were correct.
I tried making the python scripts as documented as possible, each of the folder has its own requirements.txt file that contains the python module necessary to run the post-processing tools.

Miscellaneous (will be removed when merged)

Checklist (will be removed when merged)

See this page for more information about the pull request process.

Code related list:

All in-code documentation related to this PR is up to date (Doxygen format)
Lethe documentation is up to date
New feature has unit test(s) (preferred) or application test(s), and restart files are in the generator folder
The branch is rebased onto master
Changelog (CHANGELOG.md) is up to date
Code is indented with indent-all and .prm files (examples and tests) with prm-indent

Pull request related list:

Labels are applied
There are at least 2 reviewers (or 1 if small feature) excluding the responsible for the merge
If this PR closes an issue or is related to a project, it is linked in the "Projects" or "Development" section
If the fix is temporary, an issue is opened
The PR description is cleaned and ready for merge

lpsaavedra

Very nice that you are adding all of these examples to Lethe. I have a few comments, mostly formatting and minor things, but overall I think the python scripts are well documented. I also really like that you added the requirements for the post-processing, never really thought about this for the examples.

CHANGELOG.md

examples/multiphysics/bubble-detachment-shear-flow/bubble-detachment-shear-flow.prm

...tiphysics/bubble-detachment-shear-flow/multiple_folders_bubble_detachment_post_processing.py

examples/multiphysics/jurins-law-2d/jurins-law-2d.prm

examples/multiphysics/jurins-law-2d/jurins_law_multiple_folders.py

examples/multiphysics/jurins-law-2d/postprocessing_jurins_law_dimensioned.py

examples/multiphysics/rising-bubble-chns/rising-bubble-chns.prm

examples/multiphysics/spinodal-decomposition/spinodal.prm

examples/multiphysics/static-bubble-chns/static-bubble-multiple-folders.py

blaisb

Some initial comments for this.
I would review more indepth the follow-up PR with the example RST file.

examples/multiphysics/bubble-detachment-shear-flow/bubble-detachment-shear-flow.prm

...les/multiphysics/bubble-detachment-shear-flow/functions_bubble_detachment_post_processing.py

examples/multiphysics/static-bubble-chns/outputs/R_0.35/static-bubble-chns.prm

examples/multiphysics/static-bubble-chns/outputs/R_0.40/static-bubble-chns.prm

examples/multiphysics/static-bubble-chns/postprocessing_static_bubble.py

examples/multiphysics/static-bubble-chns/static-bubble-chns.prm

examples/multiphysics/static-bubble-chns/static-bubble-multiple-folders.py

OresteMarquis

Nice work Pierre, nothing much to say! Only some clarifications and typos I think.

...les/multiphysics/bubble-detachment-shear-flow/functions_bubble_detachment_post_processing.py

...tiphysics/bubble-detachment-shear-flow/multiple_folders_bubble_detachment_post_processing.py

examples/multiphysics/jurins-law-2d/jurins_law_multiple_folders.py

examples/multiphysics/jurins-law-2d/postprocessing_jurins_law_dimensioned.py

examples/multiphysics/static-bubble-chns/static-bubble-multiple-folders.py

CHANGELOG.md

...les/multiphysics/bubble-detachment-shear-flow/functions_bubble_detachment_post_processing.py

examples/multiphysics/jurins-law-2d/jurins-law-2d.prm

examples/multiphysics/jurins-law-2d/jurins_law_multiple_folders.py

examples/multiphysics/jurins-law-2d/postprocessing_jurins_law_dimensioned.py

examples/multiphysics/static-bubble-chns/outputs/R_0.15/static-bubble-chns.prm

examples/multiphysics/static-bubble-chns/postprocessing_static_bubble.py

examples/multiphysics/static-bubble-chns/static-bubble-multiple-folders.py

oguevremont · 2024-10-10T15:47:31Z

Nice PR!

blaisb · 2024-10-15T19:34:01Z

@PierreLaurentinCS can you rebase? I can then merge afterwards :)

Co-authored-by: Laura Prieto Saavedra <[email protected]>

Description This is the first example of the Cahn-Hilliard-Navier-Stokes solver. It displays the use of angle of contact boundary conditions to solve a capillary rise problem in 2D. The numerical height difference is compared to that predicted by the Jurin's law and show excellent agreement . The pressure fields are qualitatively commented and show that the solver adequately describe pressure jumps due to an interface. A post processing python script is included with the example to reproduce the figures if needed. They were added in a previous PR (#1307) and already reviewed. EDIT There was a modification made to the implementation of the boundary conditions to make the example work with the new boundary conditions. An application test (cahn_hilliard_navier_stokes_jurins_law_2d) was added to ensure of the future stability of the solver Co-authored-by: Bruno Blais <[email protected]>

Description This is the second example of the Cahn-Hilliard-Navier-Stokes solver. The solver is used to simulate the detachment of bubbles in a shear flow in three dimensions. The quantities of interest (detachment time and volume) are compared to values from the literature. An excellent agreement is observed, which confirms that the CHNS solver is able to describe complex interface physics, involving break-up and jet formation. All the necessary files to run the parametric sweep are included (only on the shear rate) and python scripts are provided to reproduce the figures if needed (see the previous PR : #1307).

PierreLaurentinCS requested review from OresteMarquis and blaisb October 3, 2024 22:36

PierreLaurentinCS added Ready for review Example labels Oct 3, 2024

lpsaavedra requested changes Oct 9, 2024

View reviewed changes

PierreLaurentinCS removed the Ready for review label Oct 9, 2024

PierreLaurentinCS force-pushed the add_undocumented_chns_examples branch 2 times, most recently from bd28923 to b20d932 Compare October 9, 2024 17:59

PierreLaurentinCS added the Ready for review label Oct 9, 2024

blaisb added Reviewed and waiting for changes and removed Ready for review labels Oct 10, 2024

blaisb requested changes Oct 10, 2024

View reviewed changes

OresteMarquis approved these changes Oct 10, 2024

View reviewed changes

oguevremont reviewed Oct 10, 2024

View reviewed changes

PierreLaurentinCS force-pushed the add_undocumented_chns_examples branch from b20d932 to b859e6d Compare October 10, 2024 16:33

PierreLaurentinCS added Ready for review and removed Reviewed and waiting for changes labels Oct 10, 2024

blaisb requested review from blaisb, lpsaavedra and oguevremont October 15, 2024 16:00

lpsaavedra approved these changes Oct 15, 2024

View reviewed changes

oguevremont approved these changes Oct 15, 2024

View reviewed changes

blaisb added Reviewed and ready to merge and removed Ready for review labels Oct 15, 2024

PierreLaurentinCS added 4 commits October 15, 2024 16:34

add new undocumented chns examples to the code

ff59ab5

update post-processing scripts

51ba261

apply prm indent

5bd10cc

fix post-processing script for static-bubble-chns example

e901908

PierreLaurentinCS and others added 13 commits October 15, 2024 16:34

add requirements.txt file for python post-processing scripts

d2d48ac

clarify post-processing scripts

5824878

remove default entry form bubble detachment .prm

7d57f6f

Apply review comments

a15ca63

Co-authored-by: Laura Prieto Saavedra <[email protected]>

Indent prm files

267fafb

add license files

c6b19a6

Cleaned and re-wrote the .py script for better readability

39ef036

jurins-law prm fix

1764010

minor fixes

2b226e6

fix typos in jurins-law psot-processing

0a43c3d

add exceptions to post-processing file

9c2fb3f

fix typo in post-processing script

867ab0d

remove whitespace

1eb66d1

PierreLaurentinCS force-pushed the add_undocumented_chns_examples branch from b8c68b5 to 1eb66d1 Compare October 15, 2024 20:49

blaisb approved these changes Oct 16, 2024

View reviewed changes

blaisb merged commit c763e64 into master Oct 16, 2024
11 checks passed

blaisb deleted the add_undocumented_chns_examples branch October 16, 2024 12:35

PierreLaurentinCS mentioned this pull request Oct 21, 2024

CHNS example : capillary rise and Jurin's law #1328

Merged

9 tasks

PierreLaurentinCS mentioned this pull request Oct 29, 2024

CHNS example : bubble detachment in a shear flow #1334

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Addition of undocumented and soon-to-be-documented example files for the Cahn-Hilliard solver #1307

Addition of undocumented and soon-to-be-documented example files for the Cahn-Hilliard solver #1307

PierreLaurentinCS commented Oct 3, 2024 •

edited

Loading

lpsaavedra left a comment

blaisb left a comment

OresteMarquis left a comment •

edited

Loading

oguevremont commented Oct 10, 2024

blaisb commented Oct 15, 2024

Addition of undocumented and soon-to-be-documented example files for the Cahn-Hilliard solver #1307

Addition of undocumented and soon-to-be-documented example files for the Cahn-Hilliard solver #1307

Conversation

PierreLaurentinCS commented Oct 3, 2024 • edited Loading

Description

Testing

Miscellaneous (will be removed when merged)

Checklist (will be removed when merged)

lpsaavedra left a comment

Choose a reason for hiding this comment

blaisb left a comment

Choose a reason for hiding this comment

OresteMarquis left a comment • edited Loading

Choose a reason for hiding this comment

oguevremont commented Oct 10, 2024

blaisb commented Oct 15, 2024

PierreLaurentinCS commented Oct 3, 2024 •

edited

Loading

OresteMarquis left a comment •

edited

Loading