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

Consistency in Parthenon Hook Function Arguments #1002

Open
pdmullen opened this issue Jan 30, 2024 · 0 comments
Open

Consistency in Parthenon Hook Function Arguments #1002

pdmullen opened this issue Jan 30, 2024 · 0 comments
Assignees

Comments

@pdmullen
Copy link
Collaborator

PR #999 argued in favor of using MeshBlockData<Real> *mbd function arguments for a newly added PostInitializaiton hook. This inspired some discussion regarding consistency between hook function arguments.

For example, many hooks take MeshData<Real> or MeshBlockData<Real> arguments (which comes with the nicety that downstream users can template on typename to interface with both). However, the MeshBlock variation of ProblemGenerator is somewhat unique in that it takes *pmb (the Mesh variation takes as argument MeshData<Real>).

Here, I propose that we try to enforce some form of consistency between hook function arguments. In the example above, I'd advocate for requiring the MeshBlock variation of ProblemGenerators take MeshBlockData<Real> as function argument. Of course, this would be a breaking change... requiring downstream users to update all their pgen.

@pdmullen pdmullen self-assigned this Jan 30, 2024
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

No branches or pull requests

1 participant