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

renaming #685

Merged
merged 1 commit into from
Jul 2, 2024
Merged

renaming #685

merged 1 commit into from
Jul 2, 2024

Conversation

kmdeck
Copy link
Member

@kmdeck kmdeck commented Jul 2, 2024

Purpose

Close #660

We have the function imp_tendency!, which calls update_aux!, update_boundary_fluxes!, and compute_imp_tendency! (where the actual tendency computation is done). We also have the explicit analogs.

Similarly, we have tendency_jacobian!, which calls update_aux!, update_boundary_fluxes!, and update_jacobian! (where the actual tendency computation is done).

To-do

Content

Renames two functions
update_jacobian -> compute_jacobian (analog is compute_imp_tendency)
tendency_jacobian -> jacobian (analog is imp_tendency)


  • I have read and checked the items on the review checklist.

@kmdeck kmdeck self-assigned this Jul 2, 2024
@kmdeck kmdeck requested a review from AlexisRenchon July 2, 2024 17:24
Copy link
Member

@AlexisRenchon AlexisRenchon left a comment

Choose a reason for hiding this comment

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

Thank you for tagging me, so I know this needs a major release!
Can you add this to NEWS.md? with the breaking change tag

@kmdeck
Copy link
Member Author

kmdeck commented Jul 2, 2024

Thank you for tagging me, so I know this needs a major release! Can you add this to NEWS.md? with the breaking change tag

yes! Ill add that. thanks for the quick review!

@kmdeck kmdeck force-pushed the kd/clarify_jacobian_function_names branch from 6017ad1 to 80f8aab Compare July 2, 2024 17:43
@kmdeck kmdeck added the software clarity PRs that maintain functionality but increase clarity of code label Jul 2, 2024
@kmdeck kmdeck force-pushed the kd/clarify_jacobian_function_names branch from 80f8aab to 6d9da28 Compare July 2, 2024 20:07
@kmdeck kmdeck enabled auto-merge July 2, 2024 20:07
@kmdeck kmdeck force-pushed the kd/clarify_jacobian_function_names branch from 43e4a6b to 332a73b Compare July 2, 2024 20:17
@kmdeck kmdeck merged commit 9ce1985 into main Jul 2, 2024
10 checks passed
@kmdeck kmdeck deleted the kd/clarify_jacobian_function_names branch July 2, 2024 20:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API breaking change software clarity PRs that maintain functionality but increase clarity of code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unify jacobian/tendency naming convention
2 participants