[GeoMechanicsApplication] Add coupling calculator components #14162

rfaasse · 2026-01-28T08:53:45Z

📝 Description
This PR adds two calculators, the UPCouplingCalculator and the PUCouplingCalculator to calculate left and right hand side contributions regarding water $\leftrightarrow$ displacement coupling. Due to overlap in the two calculations, the PUCouplingCalculator re-uses the UPCouplingCalculator.

Note that no connection is made yet to an existing element (e.g. the interface element).

🆕 Changelog

Added two calculator classes, UPCouplingCalculator and PUCouplingCalculator
Added unit tests for both
Added documentation for calculators in general, as well as a more detailed description of these coupling calculators

…lator

…ing with clang-format

…upling matrix calculation in the equation of motion utils

…he coupling calculators)

…ore specific info

…ing-calculator

rfaasse · 2026-01-28T13:28:52Z

.../GeoMechanicsApplication/custom_elements/contribution_calculators/pu_coupling_calculator.hpp

+        InputProvider(std::function<const Matrix&()>       GetNpContainer,
+                      Geo::BMatricesGetter                 GetBMatrices,
+                      std::function<Vector()>              GetVoigtVector,
+                      Geo::IntegrationCoefficientsGetter   GetIntegrationCoefficients,
+                      std::function<std::vector<double>()> GetBiotCoefficients,
+                      std::function<std::vector<double>()> GetDegreesOfSaturation,
+                      std::function<Vector()>              GetNodalVelocities,
+                      std::function<double()>              GetVelocityCoefficient)


I'd like to add the aliases for this provider later (but let me know if you think differently). I think we should also discuss if we'd like a new alias for every type of getter, or if we'd like more generic aliases (e.g. MatrixGetter instead of having different ones for BMatricesGetter and NpContainerGetter)

I have been struggling with the same. For std::function<std::vector> we have Geo::IntegrationCoefficientsGetter. Using that for other coefficients ( here Biot, DegreeOfSaturation, Bishop ) looks unnatural. We could change its name to CoefficientsGetter and use it throughout the providers.

Also looking at Annes comment, I think it's a good idea to leave it as is for this PR, and discuss it offline first

WPK4FEM

Dear Richard,
Thank you for making these coupling calculators available. A good step towards having a complete set of calculators for elements.
Please have an in depth look at the remarks about the velocity coefficient. It's use does not align with my expectation, I think it does not belong in the calculator and causes an incorrect RHS the way it's used. Try to prove that I'm wrong off course.
Regards, Wijtze Pieter

WPK4FEM · 2026-01-28T15:04:24Z

.../GeoMechanicsApplication/custom_elements/contribution_calculators/pu_coupling_calculator.hpp

+        InputProvider(std::function<const Matrix&()>       GetNpContainer,
+                      Geo::BMatricesGetter                 GetBMatrices,
+                      std::function<Vector()>              GetVoigtVector,
+                      Geo::IntegrationCoefficientsGetter   GetIntegrationCoefficients,
+                      std::function<std::vector<double>()> GetBiotCoefficients,
+                      std::function<std::vector<double>()> GetDegreesOfSaturation,
+                      std::function<Vector()>              GetNodalVelocities,
+                      std::function<double()>              GetVelocityCoefficient)


I have been struggling with the same. For std::function<std::vector> we have Geo::IntegrationCoefficientsGetter. Using that for other coefficients ( here Biot, DegreeOfSaturation, Bishop ) looks unnatural. We could change its name to CoefficientsGetter and use it throughout the providers.

.../GeoMechanicsApplication/custom_elements/contribution_calculators/pu_coupling_calculator.hpp

.../GeoMechanicsApplication/custom_elements/contribution_calculators/up_coupling_calculator.hpp

WPK4FEM · 2026-01-28T15:28:19Z

.../GeoMechanicsApplication/custom_elements/contribution_calculators/up_coupling_calculator.hpp

+            typename BaseType::LHSMatrixType coupling_contribution;
+            GeoTransportEquationUtilities::CalculateCouplingMatrix(


Is it impossible to use the version where the return value is the coupling matrix contribution?

Not out of the box because the template arguments there are the dimension and number of nodes i.s.o number of UDof and number of PwDof.

avdg81

Hi Richard,
I've mostly focused on the programming aspects of this PR rather than the actual calculation of the matrices and vectors. I feel that Wijtze Pieter has way more knowledge about that than me, and I've seen he has shared some ideas on how to more cleanly separate certain concepts. My suggestions and questions are all very minor, so please focus on the feedback given by Wijtze Pieter. Thanks.

...ation/tests/cpp_tests/custom_elements/contribution_calculators/test_coupling_calculators.cpp

.../GeoMechanicsApplication/custom_elements/contribution_calculators/pu_coupling_calculator.hpp

rfaasse

Processed the first batch of comments!

.../GeoMechanicsApplication/custom_elements/contribution_calculators/pu_coupling_calculator.hpp

rfaasse · 2026-01-29T12:24:02Z

.../GeoMechanicsApplication/custom_elements/contribution_calculators/pu_coupling_calculator.hpp

+        InputProvider(std::function<const Matrix&()>       GetNpContainer,
+                      Geo::BMatricesGetter                 GetBMatrices,
+                      std::function<Vector()>              GetVoigtVector,
+                      Geo::IntegrationCoefficientsGetter   GetIntegrationCoefficients,
+                      std::function<std::vector<double>()> GetBiotCoefficients,
+                      std::function<std::vector<double>()> GetDegreesOfSaturation,
+                      std::function<Vector()>              GetNodalVelocities,
+                      std::function<double()>              GetVelocityCoefficient)


Also looking at Annes comment, I think it's a good idea to leave it as is for this PR, and discuss it offline first

.../GeoMechanicsApplication/custom_elements/contribution_calculators/pu_coupling_calculator.hpp

.../GeoMechanicsApplication/custom_elements/contribution_calculators/up_coupling_calculator.hpp

rfaasse · 2026-01-29T12:31:13Z

.../GeoMechanicsApplication/custom_elements/contribution_calculators/up_coupling_calculator.hpp

+            typename BaseType::LHSMatrixType coupling_contribution;
+            GeoTransportEquationUtilities::CalculateCouplingMatrix(


Not out of the box because the template arguments there are the dimension and number of nodes i.s.o number of UDof and number of PwDof.

...ation/tests/cpp_tests/custom_elements/contribution_calculators/test_coupling_calculators.cpp

.../GeoMechanicsApplication/custom_elements/contribution_calculators/pu_coupling_calculator.hpp

markelov208

Hi Richard, thank you for implementing the calculators. I have a number of minor comments. Hope it is easy to comment them.

.../GeoMechanicsApplication/custom_elements/contribution_calculators/pu_coupling_calculator.hpp

applications/GeoMechanicsApplication/custom_elements/contribution_calculators/README.md

markelov208 · 2026-01-29T14:14:58Z

applications/GeoMechanicsApplication/custom_elements/contribution_calculators/README.md

+- The Voigt-vector
+- The nodal water pressures
+
+This data is provided via the `InputProvider` and enables the calculator to compute left-hand side contribution ($Q$ as defined before) and right-hand side contributions ($Q p$, in which $p$ is the vector of nodal water pressures).


Should $Q p$ be $Q_p$?

$Qp$ should depict the matrix-vector product between the $Q$ matrix and the $p$ vector (the latter containing the nodal water pressures). Let me know if it's clear enough like this, or if you'd like me to add some clarification to the doc!

thank you for the clarification. I think adding something like '(matrix-vector product $Qp$, where $p$ is the vector of ,,,)' would be perfect,

applications/GeoMechanicsApplication/custom_elements/contribution_calculators/README.md

...ation/tests/cpp_tests/custom_elements/contribution_calculators/test_coupling_calculators.cpp

.../GeoMechanicsApplication/custom_elements/contribution_calculators/pu_coupling_calculator.hpp

.../GeoMechanicsApplication/custom_elements/contribution_calculators/up_coupling_calculator.hpp

WPK4FEM

Dear Richard,
Thank you for adding the coupling calculators, lets use them in our elements.
For me it's good to go.
Wijtze Pieter

rfaasse

Thank you all for the reviews, processed the comments 👍

.../GeoMechanicsApplication/custom_elements/contribution_calculators/up_coupling_calculator.hpp

applications/GeoMechanicsApplication/custom_elements/contribution_calculators/README.md

...ation/tests/cpp_tests/custom_elements/contribution_calculators/test_coupling_calculators.cpp

.../GeoMechanicsApplication/custom_elements/contribution_calculators/pu_coupling_calculator.hpp

.../GeoMechanicsApplication/custom_elements/contribution_calculators/up_coupling_calculator.hpp

avdg81

Thanks for processing the review suggestions. For me this PR is good to go.

markelov208

Richard, thank you for clarifications and changes. There is still comment on Qp but it is not blocking.

rfaasse added 20 commits January 27, 2026 09:40

Added test for construction of the new UPCouplingCalculator

8bd48ce

Added empty input provider

0d2503c

Renamed test file

b4b0d1e

Added relevant getters to the input provider of the up coupling calcu…

5620366

…lator

Added input provider to the constructor of the calculator + reformatt…

3260de5

…ing with clang-format

Added unit test + functionality for the LHS

817cf82

Removed redundant include

3c7c143

Added a test case with a matrix that's checked by hand

430bed7

Added test for the RHS that's checked by hand

00dee86

Removed some redundant statements

458616e

Renamed getter for the nodal water pressures

2aae293

Added unit test for multiple integration points

1c7890d

Removed test which was essentially a duplicate of the test for the co…

d9f5aea

…upling matrix calculation in the equation of motion utils

Added functionality + test for LHS of PU coupling

c07f2b0

Added functionality + test for RHS calculation

c893e30

Added test for multiple integration points UP coupling

096dc0d

Added README.md for the calculators (with specific details only for t…

9ec09ce

…he coupling calculators)

Fixed mistake in the docs + added a reference to the unit tests for m…

e0afbb7

…ore specific info

Formatting

06b6b5e

Merge remote-tracking branch 'origin/master' into geo/14020-add-coupl…

7ff75ed

…ing-calculator

rfaasse linked an issue Jan 28, 2026 that may be closed by this pull request

[GeoMechanicsApplication] Calculator for the U Pw coupling term contributions #14020

Open

rfaasse added 6 commits January 28, 2026 11:54

Re-used the UPCoupling calculator in the PU one

bc5c3cb

Re-used the UPCoupling calculator in the PU one and fix the pipeline

8139526

Renamed test

8819d0e

Refactored the UP coupling tests

388c2dd

Refactored the PU coupling unit tests

dbc883b

Renaming variables to align with style guide + formatting

09cbc7b

rfaasse changed the title ~~[GeoMechanicsApplication] Add coupling calculator component~~ [GeoMechanicsApplication] Add coupling calculator components Jan 28, 2026

rfaasse commented Jan 28, 2026

View reviewed changes

rfaasse marked this pull request as ready for review January 28, 2026 13:32

rfaasse requested a review from a team as a code owner January 28, 2026 13:32

rfaasse requested review from WPK4FEM and avdg81 January 28, 2026 13:33

rfaasse self-assigned this Jan 28, 2026

WPK4FEM reviewed Jan 28, 2026

View reviewed changes

rfaasse requested a review from markelov208 January 29, 2026 09:15

avdg81 reviewed Jan 29, 2026

View reviewed changes

rfaasse added 3 commits January 29, 2026 13:21

Removed velocity coefficient from the pu coupling calculator

fdebeb0

Processed review comments

cbebcb1

Adjusted the read me

e1faa25

rfaasse commented Jan 29, 2026

View reviewed changes

Formatting

5a4620c

rfaasse requested review from WPK4FEM and avdg81 January 29, 2026 13:38

markelov208 reviewed Jan 29, 2026

View reviewed changes

WPK4FEM previously approved these changes Jan 29, 2026

View reviewed changes

Processed review comments

3dac09b

rfaasse dismissed WPK4FEM’s stale review via 3dac09b January 29, 2026 15:35

rfaasse commented Jan 29, 2026

View reviewed changes

rfaasse requested a review from markelov208 January 29, 2026 15:36

avdg81 approved these changes Jan 29, 2026

View reviewed changes

rfaasse enabled auto-merge (squash) January 29, 2026 16:12

markelov208 approved these changes Jan 29, 2026

View reviewed changes

rfaasse merged commit b2cb83f into master Jan 29, 2026
10 checks passed

rfaasse deleted the geo/14020-add-coupling-calculator branch January 29, 2026 18:06

		typename BaseType::LHSMatrixType coupling_contribution;
		GeoTransportEquationUtilities::CalculateCouplingMatrix(

[GeoMechanicsApplication] Add coupling calculator components #14162

[GeoMechanicsApplication] Add coupling calculator components #14162

Conversation

rfaasse commented Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rfaasse Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

WPK4FEM left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

avdg81 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rfaasse left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

markelov208 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

WPK4FEM left a comment

Choose a reason for hiding this comment

Uh oh!

rfaasse left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rfaasse commented Jan 28, 2026 •

edited

Loading

rfaasse Jan 28, 2026 •

edited

Loading