Coupling of SU2 and CoolProp by PENGYAN777 · Pull Request #1782 · su2code/SU2

PENGYAN777 · 2022-10-05T19:25:20Z

Proposed Changes

This project aims to couple the free and open-source thermodynamics library CoolProp with SU2.

There are two advantages:

More accurate numerical results.
CoolProp can provide accurate thermodynamics properties (P, T, rho, ect) of commone fluids by either extracting experiment data from published papers, or computing based on the state-of-the-art Helmholtz energy formulations.
So, thermodynamics properties obtained from CoolProp should be more accurate than those obtained from Van der Waals or peng robinson gas model embedded in SU2. Also, the numerical results should be more accurate.
More user-friendly
To use CoolProp feature, the ony input from the user is the name of fluid. Then all other thermodynamics can be provided by CoolProp.
%FLUID_MODEL = COOLPROP
%FLUID_NAME = nitrogen

Related Work

This project references the following work:
1.the work of coupling 'Mutationpp' with SU2.
4. the pull request of 'Feature nppr gas #1718'

PR Checklist

I am submitting my contribution to the develop branch.
My contribution generates no new compiler warnings.
My contribution is commented and consistent with SU2 style (https://su2code.github.io/docs_v7/Style-Guide/).
Simulations with the following test fluids succeed: nitrogen, oxygen, carbon dioxide, MM.
Currently, this new feature is applied for only Euler flow. For viscous flow, further work need to be done, including viscosity, conductivity from CoolProp.
CoolProp does not support non-dimension.

bigfooted · 2022-10-05T19:30:56Z

could you clean up unnecessary files first, please?

PENGYAN777 · 2022-10-05T19:37:43Z

Hi, thank you for your help. Could you please give more details about unnecessary files? If you mean files related to cmake, I think they are generated automatically when CoolProp is compiled by cmake submodule in meson. I will try to compile without these files. If I succeed, I will remove them. PENG YAN, PhD student Department of Aerospace Science & Technology Politecnico di Milano

…

________________________________ From: Nijso ***@***.***> Sent: Wednesday, October 5, 2022 21:31 To: su2code/SU2 ***@***.***> Cc: Peng Yan ***@***.***>; Author ***@***.***> Subject: Re: [su2code/SU2] [WIP]Coupling of SU2 and CoolProp (PR #1782) could you clean up unnecessary files first, please? — Reply to this email directly, view it on GitHub<#1782 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ATJ4GKEET6UOH5CLSYXW5RLWBXJPVANCNFSM6AAAAAAQ53HAJY>. You are receiving this because you authored the thread.Message ID: ***@***.***>

bigfooted · 2022-10-05T19:47:01Z

Yes, all those automatically generated files should be removed, so everything in the folder .idea (including the folder), and the entire cmake-build-debug folder. If they come from coolprop, tell it to install into another directory outside of SU2.

PENGYAN777 · 2022-10-05T20:02:16Z

Thank you for your advice. I will do that as soon. PENG YAN, PhD student Department of Aerospace Science & Technology Politecnico di Milano

…

________________________________ From: Nijso ***@***.***> Sent: Wednesday, October 5, 2022 21:47 To: su2code/SU2 ***@***.***> Cc: Peng Yan ***@***.***>; Author ***@***.***> Subject: Re: [su2code/SU2] [WIP]Coupling of SU2 and CoolProp (PR #1782) Yes, all those automatically generated files should be removed, so everything in the folder .idea (including the folder), and the entire cmake-build-debug folder. If they come from coolprop, tell it to install into another directory outside of SU2. — Reply to this email directly, view it on GitHub<#1782 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ATJ4GKA5U3DU3MBG5LNUQC3WBXLMBANCNFSM6AAAAAAQ53HAJY>. You are receiving this because you authored the thread.Message ID: ***@***.***>

lgtm-com · 2022-10-05T21:08:36Z

This pull request introduces 293 alerts when merging a6ce86a into 4f3e0af - view on LGTM.com

new alerts:

131 for FIXME comment
43 for Comparison result is always the same
38 for Multiplication result converted to larger type
34 for Constant return type on member
24 for Inconsistent definition of copy constructor and assignment ('Rule of Two')
10 for Empty branch of conditional
4 for Declaration hides parameter
2 for Expression has no effect
2 for Catching by value
1 for Overloaded assignment does not return 'this'
1 for Virtual call from constructor or destructor
1 for Unclear comparison precedence
1 for Local variable hides global variable
1 for Short global name

pcarruscag

Welcome to SU2
Run clang-format on new files and please format your changes to existing files according to SU2 style.

Common/include/CConfig.hpp

Common/src/CConfig.cpp

WallyMaier · 2022-10-06T01:17:29Z

Common/src/CConfig.cpp

-  addEnumOption("FLUID_MODEL", Kind_FluidModel, FluidModel_Map, STANDARD_AIR);
+  addEnumOption("FLUID_MODEL", Kind_FluidModel, FluidModel_Map, COOLPROP);
+  /*!\brief FLUID_NAME \n DESCRIPTION: Fluid name \n OPTIONS: see coolprop homepage \n DEFAULT: nitrogen \ingroup Config*/
+  addStringOption("FLUID_NAME", FLUID_NAME, string("nitrogen"));


I wonder if there is a way to combine this with the Mutation++ options.

That is a good idea.
I will try to finish this new feature as soon, and then if it is possible, I am happy to work with others on this combination.

TestCases/coolprop/pr.cfg

WallyMaier

Thanks for your contribution!
Be sure to run remove the unnecessary files and run clang_format to clean up new files.

I wonder with the new additions of the NEMO, Species and now CoolProp fluids, there would be a smart way to consolidate

PENGYAN777 · 2022-10-22T16:35:57Z

Do that in a different order please, add the regression now, we merge the PR, and then you continue the work. We want short PRs.

ok, I will add the regression recently.

PENGYAN777 · 2022-10-24T16:28:28Z

Do that in a different order please, add the regression now, we merge the PR, and then you continue the work. We want short PRs.

Hi, I meet a problem when I change /.github/workflows/regression.yaml to enable compilation with CoolProp for one of the config sets (BaseMPI).

To compile CoolProp, I import cmake submodule of meson. However, when github workflow builds BaseMPI, the error message is 'can not find cmake.'

I think this is because github does not have cmake.

Do you have any advice? Thank you.

(the other subproject Mutationpp also import cmake submodule, do you know how that new feature is built on github?)

pcarruscag · 2022-10-24T17:37:54Z

Mutation++ is currently not built on github

pcarruscag · 2022-10-24T17:38:41Z

I will try to update the docker images to make cmake available

PENGYAN777 · 2022-10-25T05:50:16Z

I will try to update the docker images to make cmake available

Thank you. Once cmake is avalible on github, then I will continue to enable BaseMPI to compile CoolProp.

.github/workflows/regression.yml

pcarruscag · 2022-11-05T21:24:24Z

You should be able to create the new PR from this link https://github.com/su2code/SU2/compare/develop...feature_coolprop?expand=1
Please copy the description from this PR

pcarruscag · 2022-11-06T23:55:12Z

@PENGYAN777 the issues with the GitHub actions are fixed now. Please open the new PR so that we can merge this work into develop.

PENGYAN777 · 2022-11-07T07:39:02Z

@PENGYAN777 the issues with the GitHub actions are fixed now. Please open the new PR so that we can merge this work into develop.

Thank you for your help.

I created the new PR request with title ' Feature coolprop #1806 '.

Next, I will work to introduce viscosity and conductivity from CoolProp, then this new feature should be done.

PENGYAN777 and others added 12 commits August 4, 2022 17:30

CoolProp link failed

2f87fc3

fmt.h not found

a84244f

Merge branch 'su2code:develop' into develop

430ebed

immitate mutation++

0ab0e1b

immitate mutationpp

416678a

Merge branch 'su2code:develop' into develop

6dd71a2

configuration succeed

7752ec7

Merge branch 'su2code:develop' into develop

c8f2a47

Merge branch 'su2code:develop' into develop

32ebb3c

build succedd, but FLUID_MODEL=CoolProp failed

ea23e57

can not read FLUID_NAME

4e9897c

Merge branch 'su2code:develop' into develop

e72bba8

pr-triage bot added the PR: unreviewed label Oct 5, 2022

PENGYAN777 changed the title ~~Develop~~ Coupling of SU2 and CoolProp Oct 5, 2022

PENGYAN777 changed the title ~~Coupling of SU2 and CoolProp~~ [WIP]Coupling of SU2 and CoolProp Oct 5, 2022

pr-triage bot removed the PR: unreviewed label Oct 5, 2022

Merge branch 'develop' into develop

a6ce86a

pcarruscag reviewed Oct 5, 2022

View reviewed changes

Common/include/CConfig.hpp Outdated Show resolved Hide resolved

WallyMaier reviewed Oct 6, 2022

View reviewed changes

Common/src/CConfig.cpp Outdated Show resolved Hide resolved

WallyMaier reviewed Oct 6, 2022

View reviewed changes

TestCases/coolprop/pr.cfg Outdated Show resolved Hide resolved

WallyMaier reviewed Oct 6, 2022

View reviewed changes

TestCases/coolprop/pr.cfg Outdated Show resolved Hide resolved

WallyMaier reviewed Oct 6, 2022

View reviewed changes

PENGYAN777 added 2 commits October 8, 2022 15:08

update fmtlib

6b13b55

remove unnecessary files

82614e7

PENGYAN777 added 5 commits October 24, 2022 11:56

add regression test

8956d8e

delete unnecessary files

9c881ab

add cmake for github

bbae14f

import cmake for github

1cf9e54

import cmake for github

2eac113

PENGYAN777 added 3 commits October 25, 2022 17:17

avoid two-phase flow

1bb0f44

update soundspeed for two-phase low

8738b64

aviod two phase state

501224d

pcarruscag reviewed Oct 27, 2022

View reviewed changes

.github/workflows/regression.yml Show resolved Hide resolved

PENGYAN777 added 4 commits October 27, 2022 17:19

compile coolprop with cmake

6a5aa3a

load cmake for coolprop

38a591f

let cmake find ninja

238a108

retrive: find ninja

b28c6e0

pcarruscag added changelog:none and removed changelog:feature labels Nov 5, 2022

pcarruscag changed the title ~~[WIP]Coupling of SU2 and CoolProp~~ Coupling of SU2 and CoolProp Nov 5, 2022

pr-triage bot added the PR: unreviewed label Nov 5, 2022

pcarruscag changed the base branch from develop to feature_coolprop November 5, 2022 21:22

pcarruscag merged commit ee3a389 into su2code:feature_coolprop Nov 5, 2022

pr-triage bot added PR: merged and removed PR: unreviewed labels Nov 5, 2022

PENGYAN777 deleted the develop branch November 7, 2022 07:39

Conversation

PENGYAN777 commented Oct 5, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed Changes

Related Work

PR Checklist

Uh oh!

bigfooted commented Oct 5, 2022

Uh oh!

PENGYAN777 commented Oct 5, 2022 via email

Uh oh!

bigfooted commented Oct 5, 2022

Uh oh!

PENGYAN777 commented Oct 5, 2022 via email

Uh oh!

lgtm-com bot commented Oct 5, 2022

Uh oh!

pcarruscag left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

WallyMaier Oct 6, 2022

Choose a reason for hiding this comment

Uh oh!

PENGYAN777 Oct 8, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

WallyMaier left a comment

Choose a reason for hiding this comment

Uh oh!

PENGYAN777 commented Oct 22, 2022

Uh oh!

PENGYAN777 commented Oct 24, 2022

Uh oh!

pcarruscag commented Oct 24, 2022

Uh oh!

pcarruscag commented Oct 24, 2022

Uh oh!

PENGYAN777 commented Oct 25, 2022

Uh oh!

Uh oh!

pcarruscag commented Nov 5, 2022

Uh oh!

pcarruscag commented Nov 6, 2022

Uh oh!

PENGYAN777 commented Nov 7, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

PENGYAN777 commented Oct 5, 2022 •

edited

Loading