Tutorials icon indicating copy to clipboard operation
Tutorials copied to clipboard

Error in 'Unconstrained shape design of a two way mixing channel' tutorial, with bad error message

Open max-gains opened this issue 1 year ago • 4 comments

The aforementioned tutorial seems to have an error regarding correct definition of the 'DV_PARAM' variable, which also results in an incorrect error message when run. The tutorial defines DV_PARAM with a trailing semicolon, as below:

DV_PARAM= (BOX, 2, 0, 0, 0.0, 1.0, 0.0 ); (BOX, 3, 0, 0, 0.0, 1.0, 0.0 ); (BOX, 4, 0, 0, 0.0, 1.0, 0.0 ); (BOX, 5, 0, 0, 0.0, 1.0, 0.0 ); (BOX, 6, 0, 0, 0.0, 1.0, 0.0 ); (BOX, 2, 1, 0, 0.0, 1.0, 0.0 ); (BOX, 3, 1, 0, 0.0, 1.0, 0.0 ); (BOX, 4, 1, 0, 0.0, 1.0, 0.0 ); (BOX, 5, 1, 0, 0.0, 1.0, 0.0 ); (BOX, 6, 1, 0, 0.0, % Excluded FFD points that are fixed to keep a nice geometry and mesh %DV_PARAM= (BOX, 0, 0, 0, 0.0, 1.0, 0.0 ); (BOX, 1, 0, 0, 0.0, 1.0, 0.0 ); (BOX, 0, 1, 0, 0.0, 1.0, 0.0 ); (BOX, 1, 1, 0, 0.0, 1.0, 0.0 );

Running SU2_DEF with the trailing semicolon results in the error message

DV_PARAM: may not have ending semicolon

which is the opposite of what it should say.

max-gains avatar Jul 10 '24 06:07 max-gains

Are you referring to the text in the tutorial or the config files associated with the tutorial?

pcarruscag avatar Jul 10 '24 15:07 pcarruscag

The text in the tutorial is incorrect. The config files run because how the erroneous lines are commented, but this could confuse many users.

Specifically, in Tutorials/incompressible_flow/Inc_Species_Transport/2__mesh-deform-test/species3_primitiveVenturi_deform.cfg, I would remove the semicolon at the end of line 193.

More importantly though, I think the error message provided by SU2_DEF should be corrected. The error message is DV_PARAM: may not have ending semicolon but instead it should say DV_PARAM: has ending semicolon, no trailing semicolon is required for the last entry

Thanks!

max-gains avatar Jul 11 '24 02:07 max-gains

  1. Yes, the tutorial contains an error, this:
DV_PARAM= (BOX, 2, 0, 0, 0.0, 1.0, 0.0 ); (BOX, 3, 0, 0, 0.0, 1.0, 0.0 ); (BOX, 4, 0, 0, 0.0, 1.0, 0.0 ); (BOX, 5, 0, 0, 0.0, 1.0, 0.0 ); (BOX, 6, 0, 0, 0.0, 1.0, 0.0 ); (BOX, 2, 1, 0, 0.0, 1.0, 0.0 ); (BOX, 3, 1, 0, 0.0, 1.0, 0.0 ); (BOX, 4, 1, 0, 0.0, 1.0, 0.0 ); (BOX, 5, 1, 0, 0.0, 1.0, 0.0 ); (BOX, 6, 1, 0, 0.0,
% Excluded FFD points that are fixed to keep a nice geometry and mesh
%DV_PARAM= (BOX, 0, 0, 0, 0.0, 1.0, 0.0 ); (BOX, 1, 0, 0, 0.0, 1.0, 0.0 ); (BOX, 0, 1, 0, 0.0, 1.0, 0.0 ); (BOX, 1, 1, 0, 0.0, 1.0, 0.0 );

should be:

DV_PARAM= (BOX, 2, 0, 0, 0.0, 1.0, 0.0 ); (BOX, 3, 0, 0, 0.0, 1.0, 0.0 ); (BOX, 4, 0, 0, 0.0, 1.0, 0.0 ); (BOX, 5, 0, 0, 0.0, 1.0, 0.0 ); (BOX, 6, 0, 0, 0.0, 1.0, 0.0 ); (BOX, 2, 1, 0, 0.0, 1.0, 0.0 ); (BOX, 3, 1, 0, 0.0, 1.0, 0.0 ); (BOX, 4, 1, 0, 0.0, 1.0, 0.0 ); (BOX, 5, 1, 0, 0.0, 1.0, 0.0 ); (BOX, 6, 1, 0, 0.0, 1.0, 0.0)
% Excluded FFD points that are fixed to keep a nice geometry and mesh
%DV_PARAM= (BOX, 0, 0, 0, 0.0, 1.0, 0.0 ); (BOX, 1, 0, 0, 0.0, 1.0, 0.0 ); (BOX, 0, 1, 0, 0.0, 1.0, 0.0 ); (BOX, 1, 1, 0, 0.0, 1.0, 0.0 %);

Actually, in the accompanying files it is correct. Also, in the accompanying files FFD_CONTROL_POINT_2D is used instead of FFD_CONTROL_POINT. 2. yes, the error message can be interpreted both ways, that either the semicolon is missing, or that a semicolon is not allowed.

bigfooted avatar Jul 11 '24 05:07 bigfooted

I created a pull request for the tutorial website.

bigfooted avatar Jul 11 '24 05:07 bigfooted