Document/Example for the use of the convergence parameter "configurationTolerance"
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 287
- Forks
- 109
- Avg merge
- 4d 41m
- Merged PRs (30d)
- 5
Description
What needs to be documented?
The parameter configurationTolerance in the solver SolidMechanicsLagrangeContact defines the acceptable converged ratio between the contact area change and the total contact area as shown below:
// Assume converged if changed area is below certain fraction of total area
return changedArea <= m_nonlinearSolverParameters.m_configurationTolerance * totalArea;
First, the default value of parameter is actually set to 0, which makes the simulation always fail to converge in some senarios (for example a cased wellbore with initial stress condition).
Second, no document or xml example is available to show the importance of this parameter for the simulation convergence.
What sort of documentation would help?
- XML example using
configurationTolerance. - Change the default value to a more reasonable value, or simply change it to 1.0
What are the deficiencies of the existing documentation?
Additional notes or context
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 SolidMechanicsLagrangeContact solver and the shown convergence check for configurationTolerance. Review how the parameter is exposed in XML and how its default of 0 affects convergence, then add an XML example and explain the parameter's effect and appropriate default behavior. There are no files or tests named in the issue, so identify the relevant configuration and documentation locations first.
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