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

Better document consensus algorithms #11727

Closed
bangerth opened this issue Feb 11, 2021 · 2 comments
Closed

Better document consensus algorithms #11727

bangerth opened this issue Feb 11, 2021 · 2 comments
Assignees

Comments

@bangerth
Copy link
Member

#11725 reminds me of the fact that I still do not really understand what a "consensus algorithm" is and what the context is in which it is to be used. The problem is that the documentation doesn't actually say what the problem is this set of classes is trying to solve, and there is no worked example that would illustrate it either. That's a shame because I have the feeling that these classes can be central to a lot of work, but if I don't understand what they do (what, I don't need to know how), I can't use them :-(

It would be nice if we could adapt one of the two cases used in the test suite as a motivation, providing some documentation what each part of the code there is doing.

Separately, there are a number of implementations of the general interface, but it is unclear which implementation to use when. It might be nice to provide some basic guidance on this question.

@peterrum peterrum self-assigned this Feb 11, 2021
@bangerth
Copy link
Member Author

See also #9363.

@bangerth
Copy link
Member Author

I fixed some of this in #13082, and it turns out that I have noticed the same issue a second time in #13148 -- we can close this issue in favor of the latter.

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

No branches or pull requests

2 participants