-
Notifications
You must be signed in to change notification settings - Fork 166
ISSUE 3763: Fix default solver options in documentation #4254
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
ISSUE 3763: Fix default solver options in documentation #4254
Conversation
clean.rst is the solving-interface.rst
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for taking this on. There are quite a few things that need addressing before this can get merged.
Could you also rename the PR to something that makes it clearer what is going on? Something like "Fix default solver options in documentation".
docs/source/solving-interface.rst
Outdated
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Co-authored-by: Connor Ward <[email protected]>
…e/firedrake into tcalderon-space/issue3763 updating solving-interface.rst after feedback
* ``ksp_atol``: ``1e-50`` | ||
* ``ksp_divtol``: ``1e4`` | ||
* ``ksp_max_it``: ``10000`` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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'}
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks this is looking much better.
clean.rst
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please remove this file from the PR.
docs/source/solving-interface.rst
Outdated
* 'pc_factor_mat_solver_type': 'mumps' | ||
* 'pc_factor_mat_mumps_icntl_14': 200 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* '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
modified: solving-interface.rst
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We just need to drop the change to CITATION (which I will do now then get this merged). Thanks for the contribution!
@tcalderon-space this is good to go but is hitting some git snags. Can you:
|
Description
Fixes Issue #3763 Transfered the file from clean.rst to solving-interfaces.rst