From 003629ab674149dc9d00c1231dcdbe6e392c9021 Mon Sep 17 00:00:00 2001 From: ddundo Date: Fri, 20 Dec 2024 20:31:28 +0100 Subject: [PATCH] #73: Update comments --- goalie/adjoint.py | 6 +++--- test/adjoint/test_adjoint_mesh_seq.py | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/goalie/adjoint.py b/goalie/adjoint.py index 758aa00..b8d6d72 100644 --- a/goalie/adjoint.py +++ b/goalie/adjoint.py @@ -403,9 +403,9 @@ def _solve_adjoint( :type get_adj_values: :class:`bool` :kwarg test_checkpoint_qoi: solve over the final subinterval when checkpointing so that the QoI value can be checked across runs - :kwarg: track_coefficients: if ``True``, the adjoint solver will track the - coefficients in the variational form to detect changes between export times. - Only relevant for goal-oriented error estimation on unsteady problems. + :kwarg: track_coefficients: if ``True``, coefficients in the variational form + will be stored whenever they change between export times. Only relevant for + goal-oriented error estimation on unsteady problems. :type track_coefficients: :class:`bool` :yields: the solution data of the forward and adjoint solves :ytype: :class:`~.AdjointSolutionData` diff --git a/test/adjoint/test_adjoint_mesh_seq.py b/test/adjoint/test_adjoint_mesh_seq.py index 3f5c889..dbeb0cf 100644 --- a/test/adjoint/test_adjoint_mesh_seq.py +++ b/test/adjoint/test_adjoint_mesh_seq.py @@ -605,7 +605,7 @@ def test_constant_coefficients(self): self.assertEqual(mesh_seq._changed_form_coeffs, {self.field: {}}) def test_changed_coefficients(self): - # Change coefficient f by f_diff every timestep + # Change coefficient f by coeff_diff every timestep coeff_diff = 1.1 mesh_seq = self.go_mesh_seq(coeff_diff=coeff_diff) adj_gen = mesh_seq._solve_adjoint(track_coefficients=True)