Skip to content
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

Add info about adaptivity tuning parameters #131

Merged
merged 6 commits into from
Oct 10, 2024
Merged

Conversation

IshaanDesai
Copy link
Member

@IshaanDesai IshaanDesai commented Sep 16, 2024

In the configuration documentation, information about the adaptivity tuning parameters was missing. This PR adds information, which is taken from this paper.

Checklist:

  • I made sure that the CI passed before I ask for a review.
  • I added a summary of the changes (compared to the last release) in the CHANGELOG.md.
  • If necessary, I made changes to the documentation and/or added new content.
  • I will remember to squash-and-merge, providing a useful summary of the changes of this PR.

@IshaanDesai IshaanDesai self-assigned this Sep 16, 2024
@IshaanDesai IshaanDesai added the documentation Improvements or additions to documentation label Sep 16, 2024
@IshaanDesai IshaanDesai marked this pull request as ready for review September 16, 2024 14:41
Copy link
Collaborator

@mathiskelm mathiskelm left a comment

Choose a reason for hiding this comment

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

In the parameter table above, I would specify both constants C_r and C_c as 0 <= C < 1.

docs/configuration.md Outdated Show resolved Hide resolved
docs/configuration.md Outdated Show resolved Hide resolved
docs/configuration.md Show resolved Hide resolved
@IshaanDesai IshaanDesai merged commit 861ef20 into develop Oct 10, 2024
10 checks passed
@IshaanDesai IshaanDesai deleted the add_adaptivity_docu branch October 10, 2024 13:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants