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

Add text about how to set default value in the code by passing name #1260

Merged
merged 1 commit into from
Aug 13, 2020

Conversation

asalmgren
Copy link
Member

@asalmgren asalmgren commented Aug 13, 2020

of routine to amrex::Initialize(...)

Summary

Additional background

Checklist

The proposed changes:

  • fix a bug or incorrect behavior in AMReX
  • add new capabilities to AMReX
  • changes answers in the test suite to more than roundoff level
  • are likely to significantly affect the results of downstream AMReX users
  • are described in the proposed changes to the AMReX documentation, if appropriate

@drummerdoc
Copy link
Member

If code within AMReX requires a specific setting of values ParmParse'd within library code to function "correctly" or as expected, (whether that happens to be the default set in the library, or set by an application using this mechanism), it would be helpful to add an AMREX_ALWAYS_ASSERT to the affected library code to ensure that it is set correctly for that usage.

@asalmgren
Copy link
Member Author

asalmgren commented Aug 13, 2020 via email

@drummerdoc
Copy link
Member

drummerdoc commented Aug 13, 2020

Let's say that the boundary conditions on the tensor solve are implemented in such a way as to assume that extend_domain_face was true, and let's say that the associated code was buried in the MLMG folder somewhere. Then the assert would go in the tensor solve library code that had that requirement. An application code using the tensor solve could use the mechanism described here to set convenient defaults that are not required by applications not using that tensor solve code.

@WeiqunZhang WeiqunZhang merged commit 4c6040c into AMReX-Codes:development Aug 13, 2020
@asalmgren asalmgren deleted the update_amrex_docs branch August 13, 2020 16:44
dwillcox pushed a commit to dwillcox/amrex that referenced this pull request Oct 3, 2020
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.

3 participants