From: Wolfgang Bangerth Date: Wed, 29 Nov 2017 01:39:39 +0000 (-0700) Subject: Grammar update. X-Git-Tag: v9.0.0-rc1~711^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=dfcedf888be7ac0efe76bb949fd829173992a683;p=dealii.git Grammar update. --- diff --git a/include/deal.II/distributed/solution_transfer.h b/include/deal.II/distributed/solution_transfer.h index 21763a78be..17f18729dc 100644 --- a/include/deal.II/distributed/solution_transfer.h +++ b/include/deal.II/distributed/solution_transfer.h @@ -31,7 +31,7 @@ namespace parallel namespace distributed { /** - * Transfers a discrete FE function (like a solution vector) by + * Transfer a discrete FE function (like a solution vector) by * interpolation while refining and/or coarsening a distributed grid and * handles the necessary communication. * @@ -134,7 +134,7 @@ namespace parallel ~SolutionTransfer() = default; /** - * Prepares the @p SolutionTransfer for coarsening and refinement. It + * Prepare the current object for coarsening and refinement. It * stores the dof indices of each cell and stores the dof values of the * vectors in @p all_in in each cell that'll be coarsened. @p all_in * includes all vectors that are to be interpolated onto the new @@ -143,7 +143,7 @@ namespace parallel void prepare_for_coarsening_and_refinement (const std::vector &all_in); /** - * Same as previous function but for only one discrete function to be + * Same as the previous function but for only one discrete function to be * interpolated. */ void prepare_for_coarsening_and_refinement (const VectorType &in); diff --git a/include/deal.II/particles/particle_handler.h b/include/deal.II/particles/particle_handler.h index b5a8320c28..4a30326bcd 100644 --- a/include/deal.II/particles/particle_handler.h +++ b/include/deal.II/particles/particle_handler.h @@ -106,7 +106,7 @@ namespace Particles void clear_particles(); /** - * Updates all internally cached numbers. Note that all functions that + * Update all internally cached numbers. Note that all functions that * modify internal data structures and act on multiple particles will * call this function automatically (e.g. insert_particles), while * functions that act on single particles will not call this function @@ -292,7 +292,7 @@ namespace Particles n_particles_in_cell(const typename Triangulation::active_cell_iterator &cell) const; /** - * Finds the cells containing each particle for all locally owned + * Find and update the cells containing each particle for all locally owned * particles. If particles moved out of the local subdomain * they will be sent to their new process and inserted there. * After this function call every particle is either on its current @@ -303,7 +303,7 @@ namespace Particles sort_particles_into_subdomains_and_cells(); /** - * Exchanges all particles that live in cells that are ghost cells to + * Exchange all particles that live in cells that are ghost cells to * other processes. Clears and re-populates the ghost_neighbors * member variable. */ @@ -311,17 +311,17 @@ namespace Particles exchange_ghost_particles(); /** - * Callback function that should be called before every - * refinement and when writing checkpoints. - * Allows registering store_particles() in the triangulation. + * Callback function that should be called before every refinement + * and when writing checkpoints. This function is used to + * register store_particles() with the triangulation. */ void register_store_callback_function(const bool serialization); /** - * Callback function that should be called after every - * refinement and after resuming from a checkpoint. - * Allows registering load_particles() in the triangulation. + * Callback function that should be called after every refinement + * and after resuming from a checkpoint. This function is used to + * register load_particles() with the triangulation. */ void register_load_callback_function(const bool serialization); diff --git a/include/deal.II/particles/property_pool.h b/include/deal.II/particles/property_pool.h index e9747885fa..480189aa78 100644 --- a/include/deal.II/particles/property_pool.h +++ b/include/deal.II/particles/property_pool.h @@ -78,7 +78,7 @@ namespace Particles ArrayView get_properties (const Handle handle); /** - * Reserves the dynamic memory needed for storing the properties of + * Reserve the dynamic memory needed for storing the properties of * @p size particles. */ void reserve(const std::size_t size);