From 0122d29aea8a6fd94722e5655ac7ddff27b9de9e Mon Sep 17 00:00:00 2001 From: hansje Date: Mon, 11 Nov 2024 09:44:02 -0600 Subject: [PATCH] Fixed Augmented Lagrangian convergence doc Refs #24128 --- .../AugmentedLagrangianContactConvergence.md | 26 +++++++++++++++++++ ...edLagrangianContactFEProblemConvergence.md | 13 ---------- .../AugmentedLagrangianContactProblem.md | 2 +- 3 files changed, 27 insertions(+), 14 deletions(-) create mode 100644 modules/contact/doc/content/source/convergence/AugmentedLagrangianContactConvergence.md delete mode 100644 modules/contact/doc/content/source/convergence/AugmentedLagrangianContactFEProblemConvergence.md diff --git a/modules/contact/doc/content/source/convergence/AugmentedLagrangianContactConvergence.md b/modules/contact/doc/content/source/convergence/AugmentedLagrangianContactConvergence.md new file mode 100644 index 000000000000..f64252c3ade1 --- /dev/null +++ b/modules/contact/doc/content/source/convergence/AugmentedLagrangianContactConvergence.md @@ -0,0 +1,26 @@ +# AugmentedLagrangianContactConvergence + +The augmented Lagrangian contact algorithm involves a nested solution strategy; see [AugmentedLagrangianContactProblem.md]. + +`AugmentedLagrangianContactFEProblemConvergence` and `AugmentedLagrangianContactReferenceConvergence` +track the convergence of the nested solution procedure described above, allow interaction with the solver at each iteration until the tolerance criteria are met, and allow for updating the Lagrangian multipliers as prescribed by [AugmentedLagrangianContactProblem.md]. + +## AugmentedLagrangianContactFEProblemConvergence + +!syntax description /Convergence/AugmentedLagrangianContactFEProblemConvergence + +!syntax parameters /Convergence/AugmentedLagrangianContactFEProblemConvergence + +!syntax inputs /Convergence/AugmentedLagrangianContactFEProblemConvergence + +!syntax children /Convergence/AugmentedLagrangianContactFEProblemConvergence + +## AugmentedLagrangianContactReferenceConvergence + +!syntax description /Convergence/AugmentedLagrangianContactReferenceConvergence + +!syntax parameters /Convergence/AugmentedLagrangianContactReferenceConvergence + +!syntax inputs /Convergence/AugmentedLagrangianContactReferenceConvergence + +!syntax children /Convergence/AugmentedLagrangianContactReferenceConvergence diff --git a/modules/contact/doc/content/source/convergence/AugmentedLagrangianContactFEProblemConvergence.md b/modules/contact/doc/content/source/convergence/AugmentedLagrangianContactFEProblemConvergence.md deleted file mode 100644 index 7be2a3482406..000000000000 --- a/modules/contact/doc/content/source/convergence/AugmentedLagrangianContactFEProblemConvergence.md +++ /dev/null @@ -1,13 +0,0 @@ -# AugmentedLagrangianContactFEProblemConvergence - -!syntax description /Convergence/AugmentedLagrangianContactFEProblemConvergence - -The augmented Lagrangian contact algorithm involves a nested solution strategy; see [AugmentedLagrangianContactProblem.md]. - -The `AugmentedLagrangianContactFEProblemConvergence` object tracks the convergence of the nested solution procedure described above, allows interaction with the solver at each iteration until the tolerance criteria are met, and allows for updating the Lagrangian multipliers as prescribed by [AugmentedLagrangianContactProblem.md] - -!syntax parameters /Convergence/AugmentedLagrangianContactFEProblemConvergence - -!syntax inputs /Convergence/AugmentedLagrangianContactFEProblemConvergence - -!syntax children /Convergence/AugmentedLagrangianContactFEProblemConvergence diff --git a/modules/contact/doc/content/source/problems/AugmentedLagrangianContactProblem.md b/modules/contact/doc/content/source/problems/AugmentedLagrangianContactProblem.md index b4eec50913f1..6a88eb0df6b7 100644 --- a/modules/contact/doc/content/source/problems/AugmentedLagrangianContactProblem.md +++ b/modules/contact/doc/content/source/problems/AugmentedLagrangianContactProblem.md @@ -2,7 +2,7 @@ The augmented Lagrangian contact algorithm involves a nested solution strategy. In the inner solve, the Lagrangian multipliers are kept fixed and the contact problem is solved. Once the problem is solved, the algorithm checks to see whether the constraints are satisfied and decides if convergence has been reached. If the model has not yet converged, the Lagrangian multipliers are updated, and the inner solve is repeated. -The AugmentedLagrangianContactProblem manages the nested solution procedure described above, repeating the solution until convergence has been achieved, which is controlled by [AugmentedLagrangianContactFEProblemConvergence.md], and updating the Lagrangian multipliers. +The AugmentedLagrangianContactProblem manages the nested solution procedure described above, repeating the solution until convergence has been achieved, which is controlled by [AugmentedLagrangianContactConvergence.md], and updating the Lagrangian multipliers. # AugmentedLagrangianContactProblem