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

Minor doc updates. #16116

Merged
merged 1 commit into from
Oct 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 14 additions & 0 deletions include/deal.II/base/function_lib.h
Original file line number Diff line number Diff line change
Expand Up @@ -1482,6 +1482,13 @@ namespace Functions
* separately. In other words, there is no need to keep the original object
* from which this object could copy its information, but it might as well
* take over ("move") the data.
*
* Moving data also enables using tables that are located in shared memory
* between multiple MPI processes, rather than copying the data from
* shared memory into local memory whenever one creates an
* InterpolatedTensorProductGridData object. See the
* TableBase::replicate_across_communicator() function on how to share a
* data set between multiple processes.
*/
InterpolatedTensorProductGridData(
std::array<std::vector<double>, dim> &&coordinate_values,
Expand Down Expand Up @@ -1620,6 +1627,13 @@ namespace Functions
* separately. In other words, there is no need to keep the original object
* from which this object could copy its information, but it might as well
* take over ("move") the data.
*
* Moving data also enables using tables that are located in shared memory
* between multiple MPI processes, rather than copying the data from
* shared memory into local memory whenever one creates an
* InterpolatedUniformGridData object. See the
* TableBase::replicate_across_communicator() function on how to share a
* data set between multiple processes.
*/
InterpolatedUniformGridData(
std::array<std::pair<double, double>, dim> &&interval_endpoints,
Expand Down
2 changes: 1 addition & 1 deletion include/deal.II/base/table.h
Original file line number Diff line number Diff line change
Expand Up @@ -671,7 +671,7 @@ class TableBase : public Subscriptor
* process and possibly ghost elements that are mirrored from its owning
* process to other processes. Rather, the elements of the current object are
* simply copied to the other processes, and it is useful to think of this
* operation as creating a set of `const` AlignedVector objects on all
* operation as creating a set of `const` TableBase objects on all
* processes that should not be changed any more after the replication
* operation, as this is the only way to ensure that the vectors remain the
* same on all processes. This is particularly true because of the use of
Expand Down