Comments: make AB linear solver convention match documentation #3640
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adjusts comments to conform to the A-B-alpha-beta linear solver convention stated in the documentation:
A
andB
are the scalar constants, whilealpha
andbeta
are the coefficient fields.Additional background
The convention is established throughout the Linear Solver chapter of the documentation.
From line 18 of
LinearSolvers_Chapers.rst
:From line 71 of `LinearSolvers.rst':
We can also see this convention in code comments such as line 62 in
AMReX_MLEBABecLap.H
:However, several code comments contradict this, with
A
andB
being the coefficient fields, andalpha
andbeta
as the scalar constants, including on line 10 of the same fileAMReX_MLEBABecLap.H
:I assume this is a hold-over when the opposite convention was used. From first hand experience, I can say this can be very confusing when reading the comments to understand how these linear operators work.
A forthcoming PR renames the Real variables
alpha
andbeta
toascalar
andbscalar
, where appropriate.Checklist
The proposed changes: