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

Refactor Output classes method names #1987

Merged
merged 3 commits into from
Mar 27, 2023
Merged

Conversation

kursatyurt
Copy link
Contributor

@kursatyurt kursatyurt commented Mar 25, 2023

Proposed Changes

To satisfy the code standard in SU2. Refactorization of method names in Output family class methods to CamelCase.

Will follow up with other class families.

Depends on #1985, can be merged after

PR Checklist

Put an X by all that apply. You can fill this out after submitting the PR. If you have any questions, don't hesitate to ask! We want to help. These are a guide for you to know what the reviewers will be looking for in your contribution.

  • I am submitting my contribution to the develop branch.
  • My contribution generates no new compiler warnings (try with --warnlevel=3 when using meson).
  • My contribution is commented and consistent with SU2 style (https://su2code.github.io/docs_v7/Style-Guide/).
  • I have added a test case that demonstrates my contribution, if necessary.
  • I have updated appropriate documentation (Tutorials, Docs Page, config_template.cpp), if necessary.

@@ -6349,7 +6349,7 @@

}

void COutputLegacy::SpecialOutput_Turbo(CSolver *****solver, CGeometry ****geometry, CConfig **config,
void COutputLegacy::SpecialOutputTurbo(CSolver *****solver, CGeometry ****geometry, CConfig **config,

Check warning

Code scanning / CodeQL

Poorly documented large function

Poorly documented function: fewer than 2% comments for a function of 252 lines.
@@ -2424,7 +2424,7 @@
}
}

void COutputLegacy::SpecialOutput_ForcesBreakdown(CSolver *****solver, CGeometry ****geometry, CConfig **config, unsigned short val_iZone, bool output) const {
void COutputLegacy::SpecialOutputForcesBreakdown(CSolver *****solver, CGeometry ****geometry, CConfig **config, unsigned short val_iZone, bool output) const {

Check warning

Code scanning / CodeQL

Poorly documented large function

Poorly documented function: fewer than 2% comments for a function of 1853 lines.
Copy link
Member

@pcarruscag pcarruscag left a comment

Choose a reason for hiding this comment

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

Nice work

@kursatyurt kursatyurt merged commit 4ed142f into develop Mar 27, 2023
@kursatyurt kursatyurt deleted the refactor_output_methods branch March 27, 2023 17:44
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