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

Draft: Naming convention class #149

Merged
merged 16 commits into from
Apr 15, 2024

Conversation

kejacobson
Copy link
Collaborator

The idea is to form a class that component developers can use instead of explicitly using the name strings. This way if we need to change the name of a variable down the road, everyone's components update automatically

@timryanb
Copy link
Collaborator

Should we use capital casing for the variable names to emphasize that these are Python "const"'s? i.e. MPhysVariables.Aerodynamics.COORDINATES_DEFORMED

@friedenhe
Copy link
Collaborator

I suggest we avoid using all-caps for variable names. We may need to use these variables in many places in a component, and it is a pain to type them if they are all-caps....

@kejacobson
Copy link
Collaborator Author

All caps would be consistent with the PEP-8 style guide for constants.

@timryanb
Copy link
Collaborator

Users could always use a more convenient alias locally, like what was done here:
https://github.com/kejacobson/mphys/blob/naming_convention_class/examples/aerostructural/supersonic_panel/aerodynamics_mphys.py#L13

@friedenhe
Copy link
Collaborator

@kejacobson Using all caps makes sense to me if it is consistent with the PEP-8 naming convention. I guess we need to use a local short alias anyway, as @timryanb mentioned.

Split aero into surface anticipating volume coupling at some point down the road
@timryanb timryanb linked an issue Nov 27, 2023 that may be closed by this pull request
@kejacobson kejacobson changed the base branch from main to v2.0.0_beta April 15, 2024 16:42
@kejacobson kejacobson merged commit c295677 into OpenMDAO:v2.0.0_beta Apr 15, 2024
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Structural solver with multiple load sources
3 participants