Merge pull request #6148 from tjhei/doxy-warn

make argument const and document
geodynamics · Nov 13, 2024 · e9cd1c8 · e9cd1c8
2 parents 5333cc9 + 4505bd2
commit e9cd1c8
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/include/aspect/particle/manager.h b/include/aspect/particle/manager.h
@@ -418,12 +418,13 @@ namespace aspect
          * function will fill this structure with the necessary data.
          * @param positions The reference positions of the particles in the cell.
          * This function will update these positions for the current cell.
+         * @param evaluation_flags The required evaluation flags for each component.
          * @param evaluator The solution evaluator that is used to update the particles.
          */
         void
         local_update_particles(Property::ParticleUpdateInputs<dim> &inputs,
                                small_vector<Point<dim>> &positions,
-                               std::vector<EvaluationFlags::EvaluationFlags> &evaluation_flags,
+                               const std::vector<EvaluationFlags::EvaluationFlags> &evaluation_flags,
                                SolutionEvaluator<dim> &evaluator);
 
         /**

diff --git a/source/particle/manager.cc b/source/particle/manager.cc
@@ -445,7 +445,7 @@ namespace aspect
     void
     Manager<dim>::local_update_particles(Property::ParticleUpdateInputs<dim> &inputs,
                                          small_vector<Point<dim>> &positions,
-                                         std::vector<EvaluationFlags::EvaluationFlags> &evaluation_flags,
+                                         const std::vector<EvaluationFlags::EvaluationFlags> &evaluation_flags,
                                          SolutionEvaluator<dim> &evaluator)
     {
       const unsigned int n_particles = particle_handler->n_particles_in_cell(inputs.current_cell);