Skip to content

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

Open
wants to merge 13 commits into
base: master
Choose a base branch
from

Conversation

tcalderon-space
Copy link

@tcalderon-space tcalderon-space commented Apr 26, 2025

Description

Fixes Issue #3763 Transfered the file from clean.rst to solving-interfaces.rst

tcalderon-space and others added 2 commits April 18, 2025 16:16
clean.rst is the solving-interface.rst
Copy link
Contributor

@connorjward connorjward left a 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".

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>`_
Copy link
Contributor

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.

@tcalderon-space tcalderon-space changed the title ISSUE 3763: Update to Clean.rst ISSUE 3763: Fix default solver options in documentation Apr 28, 2025
Comment on lines +745 to +747
* ``ksp_atol``: ``1e-50``
* ``ksp_divtol``: ``1e4``
* ``ksp_max_it``: ``10000``
Copy link
Contributor

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'}

Copy link
Contributor

@connorjward connorjward left a 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
Copy link
Contributor

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.

Comment on lines 767 to 768
* 'pc_factor_mat_solver_type': 'mumps'
* 'pc_factor_mat_mumps_icntl_14': 200
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@connorjward connorjward requested a review from pbrubeck May 6, 2025 12:40
	modified:   solving-interface.rst
pbrubeck
pbrubeck previously approved these changes May 21, 2025
Copy link
Contributor

@connorjward connorjward left a 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!

@connorjward connorjward enabled auto-merge (squash) May 23, 2025 09:14
@connorjward
Copy link
Contributor

@tcalderon-space this is good to go but is hitting some git snags. Can you:

  1. Compress your commits into a single commit (I recommend using interactive rebase, git rebase -i)
  2. git fetch
  3. git rebase origin/release
  4. Change the target branch of this PR to release, not master

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants