Skip to content

Add applySystemOperator(result, x) to Residual class for PCG support#186

Merged
julianlitz merged 1 commit intomainfrom
litz_applyA
Feb 27, 2026
Merged

Add applySystemOperator(result, x) to Residual class for PCG support#186
julianlitz merged 1 commit intomainfrom
litz_applyA

Conversation

@julianlitz
Copy link
Collaborator

This PR introduces the applySystemOperator(result, x) method to the Residual class, enabling computation of the system operator applied to a vector (A * x). Previously, the class only supported computing the residual, but PCG also requires direct application of the system operator.

Merge Request - GuideLine Checklist

Guideline to check code before resolve WIP and approval, respectively.
As many checkboxes as possible should be ticked.

Checks by code author:

Always to be checked:

  • There is at least one issue associated with the pull request.
  • New code adheres with the coding guidelines
  • No large data files have been added to the repository. Maximum size for files should be of the order of KB not MB. In particular avoid adding of pdf, word, or other files that cannot be change-tracked correctly by git.

If functions were changed or functionality was added:

  • Tests for new functionality has been added
  • A local test was succesful

If new functionality was added:

  • There is appropriate documentation of your work. (use doxygen style comments)

If new third party software is used:

  • Did you pay attention to its license? Please remember to add it to the wiki after successful merging.

If new mathematical methods or epidemiological terms are used:

  • Are new methods referenced? Did you provide further documentation?

Checks by code reviewer(s):

  • Is the code clean of development artifacts e.g., unnecessary comments, prints, ...
  • The ticket goals for each associated issue are reached or problems are clearly addressed (i.e., a new issue was introduced).
  • There are appropriate unit tests and they pass.
  • The git history is clean and linearized for the merge request. All reviewers should squash commits and write a simple and meaningful commit message.
  • Coverage report for new code is acceptable.
  • No large data files have been added to the repository. Maximum size for files should be of the order of KB not MB. In particular avoid adding of pdf, word, or other files that cannot be change-tracked correctly by git.

@codecov
Copy link

codecov bot commented Feb 27, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.18%. Comparing base (39ce1dd) to head (4551577).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #186   +/-   ##
=======================================
  Coverage   95.18%   95.18%           
=======================================
  Files          94       94           
  Lines        9345     9355   +10     
=======================================
+ Hits         8895     8905   +10     
  Misses        450      450           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@EmilyBourne
Copy link
Collaborator

I don't understand what is done in this PR. The description talks about new calculations but the existing calculations seem to have been changed in a non-trivial way (e.g. += -> -=)

@julianlitz
Copy link
Collaborator Author

julianlitz commented Feb 27, 2026

@EmilyBourne

In ResidualGive what we did before was

RESIDUAL
result = f
result -= A *x

Now we do:

APPLYA
result = 0
result += A*x

RESIDUAL
result = ApplyA(x)
result = f - result

Thats why the sign changed.

@julianlitz julianlitz merged commit 35f113e into main Feb 27, 2026
8 checks passed
@julianlitz julianlitz deleted the litz_applyA branch February 27, 2026 15:47
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.

2 participants