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

Names of FEInterfaceValues functions #13103

Closed
bangerth opened this issue Dec 20, 2021 · 4 comments · Fixed by #13197
Closed

Names of FEInterfaceValues functions #13103

bangerth opened this issue Dec 20, 2021 · 4 comments · Fixed by #13197
Milestone

Comments

@bangerth
Copy link
Member

Related to #8884. @jppelteret: FYI

#12411 renamed FEInterfaceValues::jump() into FEInterfaceValues::jump_in_shape_values() and similarly for related functions. But I find these names awkward since they have a plural values when they really only return a single value: the jump in the value of a single shape function. We also only have FEValues::shape_value() and FEValues::shape_gradient(), for example.

We should rename these functions a second time, I believe, and remove the plural.

@bangerth bangerth added this to the Release 10.0 milestone Dec 20, 2021
@tjhei
Copy link
Member

tjhei commented Dec 20, 2021

One can argue that it is a singular jump between two shape functions and as such accurate.

What do you propose for FEValuesViews::Scalar::average_of_values?

@bangerth
Copy link
Member Author

Ah, I see. One could read it that way. jump_in_values() still sounds plural-y to me because I would write that as "the jump in the value of the function at a point x" -- the function does not have multiple values at a point. But I agree that one could interpret it the way you say.

What do others think?

@tjhei
Copy link
Member

tjhei commented Dec 21, 2021

What do others think?

We could always go back to jump, which is what I prefer. ;-)

@jppelteret
Copy link
Member

One can argue that it is a singular jump between two shape functions and as such accurate.

This was how I understood it as well, and why I chose that naming scheme.

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 a pull request may close this issue.

3 participants