Linear Solver Documentation Improvements Suggestions
Open
Nobody has claimed this yet.
type: documentation
type: new
- Dominant language
- C++
- Stars
- 287
- Forks
- 109
- Avg merge
- 4d 41m
- Merged PRs (30d)
- 5
Description
What needs to be documented?
When trying to setup a simulation from scratch, I found that linear solver settings were not that easy to choose.
- Would it be possible to have some presets for some standard scenarios ?
- The options of the
solverTypeare not documented in either the linear solver documentation or theenumcode. What are each one pro and cons ? - All the
preconditionercompatibilities are not documented in the linear solver documentation. What are each one pro and cons ? - Some key settings in relation with the
preconditionerand thesolverTypeoptions are not documented. - There are some preset that are available in tutorials, are they up to date with what is available in GEOS ?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linear solver documentation linked in the issue, then inspect the solverType enum, preconditioner compatibility information, and the presets used in tutorials. Document the available options, compatibility and key settings, and verify whether tutorial presets match current GEOS capabilities.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation, hpc
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100