ISSUE 3763: Fix default solver options in documentation #4254
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
clean.rst is the solving-interface.rst
connorjward
requested changes
Apr 28, 2025
docs/source/solving-interface.rst
Outdated
Comment on lines
739
to
747
| solver_parameters: { | ||
| * ``mat_type``: "aij" | ||
| * ``ksp_type``: "preonly" | ||
| * ``ksp_rtol``: 1e-7 | ||
| * ``pc_type``: "lu" | ||
| * ``pc_factor``: _DEFAULT_DIRECT_SOLVER_PARAMETERS | ||
| } | ||
|
|
||
| `LinearVariationalSolver defaults <https://github.com/firedrakeproject/firedrake/blob/master/firedrake/variational_solver.py#L134-L143>`_ |
There was a problem hiding this comment.
This is just supposed to be a bulleted list. Please run make -C docs html and check the rendered HTML to make sure things look right.
tcalderon-space
changed the title
Co-authored-by: Connor Ward <[email protected]>
…e/firedrake into tcalderon-space/issue3763 updating solving-interface.rst after feedback
pbrubeck
reviewed
Apr 29, 2025
Comment on lines
+745
to
+747
| * ``ksp_atol``: ``1e-50`` | ||
| * ``ksp_divtol``: ``1e4`` | ||
| * ``ksp_max_it``: ``10000`` |
There was a problem hiding this comment.
Also, please make sure the rest of the file is up to date. The options in 753-763 should have:
{'mat_type': 'aij',
'ksp_type': 'preonly',
'ksp_rtol': 1e-05,
'pc_type': 'lu',
'pc_factor_mat_solver_type': 'mumps',
'pc_factor_mat_mumps_icntl_14': 200,
'snes_type': 'newtonls',
'snes_linesearch_type': 'basic'}
connorjward
reviewed
May 6, 2025
clean.rst
Outdated
There was a problem hiding this comment.
Please remove this file from the PR.
docs/source/solving-interface.rst
Outdated
Comment on lines
767
to
768
| * 'pc_factor_mat_solver_type': 'mumps' | ||
| * 'pc_factor_mat_mumps_icntl_14': 200 |
There was a problem hiding this comment.
Suggested change
| * 'pc_factor_mat_solver_type': 'mumps' | |
| * 'pc_factor_mat_mumps_icntl_14': 200 | |
| * ``pc_factor_mat_solver_type``: ``mumps`` | |
| * ``pc_factor_mat_mumps_icntl_14``: 200 |
…e/firedrake into tcalderon-space/issue3763
pbrubeck
reviewed
May 7, 2025
modified: solving-interface.rst
pbrubeck
previously approved these changes
May 21, 2025
connorjward
requested changes
May 23, 2025
connorjward
approved these changes
May 23, 2025
|
@tcalderon-space this is good to go but is hitting some git snags. Can you:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fixes Issue #3763 Transfered the file from clean.rst to solving-interfaces.rst