Skip to content

Commit

Permalink
a note about (the 'old') fixer at iteration zero (#416)
Browse files Browse the repository at this point in the history
  • Loading branch information
DLWoodruff authored Aug 22, 2024
1 parent 3021793 commit 6130d0d
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions doc/src/extensions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,14 @@ in ``examples.sizes.uc_ama.py``. The ``uc_ama`` example illustrates
that when ``amgalgamator`` is used ``"id_fix_list_fct"`` needs
to be on the ``Config`` object so the amalgamator can find it.

.. note::

For the iteration zero fixer tuples, the iteration counts are just
compared with None. If you provide a count for iteration zero, the
variable will be fixed if it is within the tolerance of being converged.
So if you don't want to fix a variable at iteration zero, provide a
tolerance, but set all count values to ``None``.

xhat
^^^^

Expand Down

0 comments on commit 6130d0d

Please sign in to comment.