Add an interface for Poisson-like solvers #425
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
EmilyBourne
commented
Sep 5, 2025
Comment on lines
+69
to
+99
| /** | ||
| * @brief Update the coefficients @f$ alpha @f$ and @f$ beta @f$ that define the equation. | ||
| * @param[in] alpha The values of alpha at the grid points. | ||
| * @param[in] beta The values of beta at the grid points. | ||
| */ | ||
| virtual void update_coefficients(const_field_type alpha, const_field_type beta) = 0; | ||
|
|
||
| /** | ||
| * @brief An operator which calculates the solution @f$\phi@f$ to Poisson's equation: | ||
| * @f$ -\Delta \phi = \rho @f$ | ||
| * | ||
| * @param[out] phi The solution to Poisson's equation. | ||
| * @param[in] rho The right-hand side of Poisson's equation. | ||
| * | ||
| * @return A reference to the solution to Poisson's equation. | ||
| */ | ||
| virtual field_type operator()(field_type phi, field_type rho) const = 0; | ||
|
|
||
| /** | ||
| * @brief An operator which calculates the solution @f$\phi@f$ to Poisson's equation and | ||
| * its derivative: | ||
| * @f$ - \Delta \phi = \rho @f$ | ||
| * @f$ E = - \nabla \phi @f$ | ||
| * | ||
| * @param[out] phi The solution to Poisson's equation. | ||
| * @param[out] E The derivative of the solution to Poisson's equation. | ||
| * @param[in] rho The right-hand side of Poisson's equation. | ||
| * | ||
| * @return A reference to the solution to Poisson's equation. | ||
| */ | ||
| virtual field_type operator()(field_type phi, vector_field_type E, field_type rho) const = 0; |
There was a problem hiding this comment.
@gdgirard Would this interface match what you would like to have in Gysela?
There was a problem hiding this comment.
We definitively need virtual field_type operator()(field_type phi, field_type rho) const = 0;
But I realize that not sure that the second one where the derivative are computed would be useful for us because what we will need is not the gradient of Phi but the gradient of J_\mu.Phi which corresponds to the gyroaverage values of Phi.
There was a problem hiding this comment.
And we also need the update_coefficients routine
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
<Describe your PR here. This will form the basis of the squashed commit message in the devel branch.>
Please complete the checklist to ensure that all tasks are completed before marking your pull request as ready for review.
All Submissions
New Feature Submissions
Changes to Existing Features
Changes to the CI