Merge pull request #6088 from gassmoeller/wrap_comments

Indent doxygen comments

cookbooks/kinematically_driven_subduction_2d/composition_trms_statistics.h

@@ -42,7 +42,7 @@ namespace aspect
       public:
         /**
          * Evaluate the solution to compute the root-mean-square temperature per compositional field.
-         **/
+         */
         std::pair<std::string,std::string>
         execute (TableHandler &statistics) override;
 

cookbooks/kinematically_driven_subduction_2d/isotherm_depth.h

@@ -41,7 +41,7 @@ namespace aspect
       public:
         /**
          * Evaluate the solution to find the deepest point of a user-specified isotherm.
-         **/
+         */
         std::pair<std::string,std::string>
         execute (TableHandler &statistics) override;
 

cookbooks/kinematically_driven_subduction_2d/trench_location.h

@@ -42,7 +42,7 @@ namespace aspect
         /**
          * Evaluate the solution for the most left coordinate of the user-specified compositional field
          * along the surface of the domain.
-         **/
+         */
         std::pair<std::string,std::string>
         execute (TableHandler &statistics) override;
 

cookbooks/tomography_based_plate_motions/plugins/tomography_based_plate_motions.h

@@ -69,7 +69,7 @@ namespace aspect
      * "High-resolution mantle flow models reveal importance of plate boundary geometry and slab pull
      * forces on generating tectonic plate motions", J. Geophys. Research.:Solid Earth,
      * 128, e2022JB025877.
-
+     *
      * @ingroup MaterialModels
      */
     template <int dim>
@@ -400,25 +400,25 @@ namespace aspect
         /**
          * Parameter value that determines whether to read the viscosity with depth
          * from an ascii data file.
-        */
+         */
         bool use_depth_dependent_viscosity;
 
         /**
          * Parameter value that determines whether to read the density scaling with depth
          * from an ascii data file.
-        */
+         */
         bool use_depth_dependent_rho_vs;
 
         /**
          * Parameter value that determines whether to read the thermal expansivity
          * from an ascii data file.
-        */
+         */
         bool use_depth_dependent_thermal_expansivity;
 
         /**
          * Parameter value that determines whether to read the temperature scaling with depth
          * from an ascii data file.
-        */
+         */
         bool use_depth_dependent_dT_vs;
 
         /**
@@ -473,7 +473,7 @@ namespace aspect
          * Approximate lithosphere thickness used to separate the regions of
          * temperature derived from seismic tomography and linear temperature
          * gradient.
-        */
+         */
         double lithosphere_thickness;
 
         /**
@@ -499,11 +499,11 @@ namespace aspect
         std::vector<std::shared_ptr<MaterialModel::MaterialUtilities::Lookup::MaterialLookup>> material_lookup;
 
         /**
-        * A shared pointer to the initial temperature object
-        * that ensures that the current object can continue
-        * to access the initial composition object beyond the
-        * first time step.
-        */
+         * A shared pointer to the initial temperature object
+         * that ensures that the current object can continue
+         * to access the initial composition object beyond the
+         * first time step.
+         */
         std::shared_ptr<const aspect::InitialTemperature::Manager<dim>> initial_temperature_manager;
     };
 

include/aspect/boundary_composition/spherical_constant.h

@@ -47,7 +47,7 @@ namespace aspect
       public:
         /**
          * Initialize some variables.
-        */
+         */
         void
         initialize() override;
 

include/aspect/boundary_temperature/spherical_constant.h

@@ -43,8 +43,8 @@ namespace aspect
     {
       public:
         /**
-        * Initialize some variables.
-        */
+         * Initialize some variables.
+         */
         void
         initialize() override;
 

include/aspect/boundary_traction/interface.h

@@ -104,17 +104,17 @@ namespace aspect
                            const Tensor<1,dim> &normal_vector) const;
 
         /**
-           * Return the names of all prescribed boundary traction models currently
-           * used in the computation as specified in the input file. The function
-           * returns a map between a boundary identifier and a pair. The
-           * first part of the pair is a string that represents the prescribed
-           * traction components on this boundary (e.g. y, xz, or xyz) and the
-           * second part is a vector of strings that represent the names of
-           * boundary traction plugins for this boundary.
-           * If there are no prescribed boundary traction plugins
-           * for a particular boundary, this boundary identifier will not appear
-           * in the map.
-           */
+         * Return the names of all prescribed boundary traction models currently
+         * used in the computation as specified in the input file. The function
+         * returns a map between a boundary identifier and a pair. The
+         * first part of the pair is a string that represents the prescribed
+         * traction components on this boundary (e.g. y, xz, or xyz) and the
+         * second part is a vector of strings that represent the names of
+         * boundary traction plugins for this boundary.
+         * If there are no prescribed boundary traction plugins
+         * for a particular boundary, this boundary identifier will not appear
+         * in the map.
+         */
         const std::map<types::boundary_id, std::pair<std::string,std::vector<std::string>>> &
         get_active_boundary_traction_names () const;
 
@@ -170,21 +170,21 @@ namespace aspect
                         << "> among the names of registered boundary traction objects.");
 
         /**
-        * Register a traction boundary conditions model so that it can be
-        * selected from the parameter file.
-        *
-        * @param name A string that identifies the traction boundary conditions
-        * model
-        * @param description A text description of what this model does and that
-        * will be listed in the documentation of the parameter file.
-        * @param declare_parameters_function A pointer to a function that can be
-        * used to declare the parameters that this traction boundary conditions
-        * model wants to read from input files.
-        * @param factory_function A pointer to a function that can create an
-        * object of this traction boundary conditions model.
-        *
-        * @ingroup BoundaryTractions
-        */
+         * Register a traction boundary conditions model so that it can be
+         * selected from the parameter file.
+         *
+         * @param name A string that identifies the traction boundary conditions
+         * model
+         * @param description A text description of what this model does and that
+         * will be listed in the documentation of the parameter file.
+         * @param declare_parameters_function A pointer to a function that can be
+         * used to declare the parameters that this traction boundary conditions
+         * model wants to read from input files.
+         * @param factory_function A pointer to a function that can create an
+         * object of this traction boundary conditions model.
+         *
+         * @ingroup BoundaryTractions
+         */
         static
         void
         register_boundary_traction (const std::string &name,

include/aspect/initial_composition/slab_model.h

@@ -79,9 +79,9 @@ namespace aspect
         parse_parameters (ParameterHandler &prm) override;
 
         /**
-        * A function that returns the slab_boundary object to allow access
-        * in other places.
-        */
+         * A function that returns the slab_boundary object to allow access
+         * in other places.
+         */
         const Utilities::AsciiDataBoundary<dim> &get_slab_boundary() const;
 
       private:

include/aspect/introspection.h

@@ -71,7 +71,7 @@ namespace aspect
 
     /**
      * The number of different types defined in Type.
-    */
+     */
     constexpr static unsigned int n_types = 9;
 
     /**

include/aspect/material_model/reaction_model/grain_size_evolution.h

@@ -33,21 +33,21 @@ namespace aspect
     namespace ReactionModel
     {
       /**
-      * A model to calculate the change of the average grain size according to
-      * different published grain size evolution models. We use the grain
-      * size evolution laws described in Behn et al., 2009. Implications of grain
-      * size evolution on the seismic structure of the oceanic upper mantle, Earth
-      * Planet. Sci. Letters, 282, 178–189. Other material parameters are either
-      * prescribed similar to the 'simple' material model, or read from data files
-      * that were generated by the Perplex or Hefesto software. The material model
-      * is described in more detail in Dannberg, J., Z. Eilon, U. Faul,
-      * R. Gassmöller, P. Moulik, and R. Myhill (2017), The importance of
-      * grain size to mantle dynamics and seismological observations,
-      * Geochem. Geophys. Geosyst., 18, 3034–3061, doi:10.1002/2017GC006944.,
-      * which is the canonical reference for this reaction model.
-      *
-      * @ingroup ReactionModel
-      */
+       * A model to calculate the change of the average grain size according to
+       * different published grain size evolution models. We use the grain
+       * size evolution laws described in Behn et al., 2009. Implications of grain
+       * size evolution on the seismic structure of the oceanic upper mantle, Earth
+       * Planet. Sci. Letters, 282, 178–189. Other material parameters are either
+       * prescribed similar to the 'simple' material model, or read from data files
+       * that were generated by the Perplex or Hefesto software. The material model
+       * is described in more detail in Dannberg, J., Z. Eilon, U. Faul,
+       * R. Gassmöller, P. Moulik, and R. Myhill (2017), The importance of
+       * grain size to mantle dynamics and seismological observations,
+       * Geochem. Geophys. Geosyst., 18, 3034–3061, doi:10.1002/2017GC006944.,
+       * which is the canonical reference for this reaction model.
+       *
+       * @ingroup ReactionModel
+       */
       template <int dim>
       class GrainSizeEvolution : public ::aspect::SimulatorAccess<dim>
       {
@@ -113,8 +113,8 @@ namespace aspect
                                    std::vector<std::unique_ptr<MaterialModel::AdditionalMaterialOutputs<dim>>> &additional_outputs) const;
 
           /**
-          * Declare the parameters this function takes through input files.
-          */
+           * Declare the parameters this function takes through input files.
+           */
           static
           void
           declare_parameters (ParameterHandler &prm);
@@ -145,9 +145,9 @@ namespace aspect
           std::vector<double> geometric_constant;
 
           /**
-            * A struct that contains information about which
-            * formulation of grain size evolution should be used.
-            */
+           * A struct that contains information about which
+           * formulation of grain size evolution should be used.
+           */
           struct Formulation
           {
             /**
@@ -201,15 +201,15 @@ namespace aspect
           /**
            * A variable that records the formulation of how to evolve grain size.
            * See the type of this variable for a description of available options.
-          */
+           */
           typename Formulation::Kind grain_size_evolution_formulation;
 
           /**
-          * This function returns the fraction of shear heating energy partitioned
-          * into grain damage using the implementation by Mulyukova and Bercovici (2018)
-          * Collapse of passive margins by lithospheric damage
-          * and plunging grain size. Earth and Planetary Science Letters, 484, 341-352.
-          */
+           * This function returns the fraction of shear heating energy partitioned
+           * into grain damage using the implementation by Mulyukova and Bercovici (2018)
+           * Collapse of passive margins by lithospheric damage
+           * and plunging grain size. Earth and Planetary Science Letters, 484, 341-352.
+           */
           double compute_partitioning_fraction (const double temperature) const;
 
           /**
@@ -241,7 +241,7 @@ namespace aspect
            * interface area is present in a collection of mineral grains and therefore
            * dependent on the average grain size. For a discussion see
            * Bercovici and Ricard (2012), Appendix H.1.
-          */
+           */
           double roughness_to_grain_size;
 
           /**

include/aspect/material_model/reaction_model/katz2003_mantle_melting.h

@@ -36,16 +36,16 @@ namespace aspect
     {
 
       /**
-      * A melt model that calculates melt fraction and entropy change
-      * according to the melting model for dry peridotite of Katz, 2003.
-      * This also includes a computation of the latent heat of melting (if the latent heat
-      * heating model is active).
-      *
-      * These functions can be used in the calculation of melting and melt transport
-      * in the melt_simple material model and can be extended to other material models
-      *
-      * @ingroup ReactionModel
-      */
+       * A melt model that calculates melt fraction and entropy change
+       * according to the melting model for dry peridotite of Katz, 2003.
+       * This also includes a computation of the latent heat of melting (if the latent heat
+       * heating model is active).
+       *
+       * These functions can be used in the calculation of melting and melt transport
+       * in the melt_simple material model and can be extended to other material models
+       *
+       * @ingroup ReactionModel
+       */
       template <int dim>
       class Katz2003MantleMelting : public ::aspect::SimulatorAccess<dim>
       {
@@ -54,8 +54,8 @@ namespace aspect
           Katz2003MantleMelting();
 
           /**
-          * Declare the parameters this function takes through input files.
-          */
+           * Declare the parameters this function takes through input files.
+           */
           static
           void
           declare_parameters (ParameterHandler &prm);
@@ -77,13 +77,13 @@ namespace aspect
                          const double pressure) const;
 
           /**
-          * Compute the change in entropy due to melting for a given @p temperature
-          * and @p pressure, and under the assumption that a fraction
-          * @p maximum_melt_fraction of the material has already been molten
-          * previously. The entropy change is computed with respect to temperature
-          * or pressure, depending on @p dependence.
-          * This is needed to calculate the latent heat of melt.
-          */
+           * Compute the change in entropy due to melting for a given @p temperature
+           * and @p pressure, and under the assumption that a fraction
+           * @p maximum_melt_fraction of the material has already been molten
+           * previously. The entropy change is computed with respect to temperature
+           * or pressure, depending on @p dependence.
+           * This is needed to calculate the latent heat of melt.
+           */
           double
           entropy_change (const double temperature,
                           const double pressure,
@@ -96,7 +96,7 @@ namespace aspect
            * Katz 2003 formulation. Takes the material model inputs @p in to compute the material model outputs @p out.
            * This function mainly fills the reaction_rate_out object but populates out.reaction_terms,
            * out.entropy_derivative_pressure and entropy_derivative_temperature
-          */
+           */
           void calculate_reaction_rate_outputs(const typename Interface<dim>::MaterialModelInputs &in,
                                                typename Interface<dim>::MaterialModelOutputs &out) const;
 
@@ -107,7 +107,7 @@ namespace aspect
            * to fill MeltOutputs. Solid outputs such as out.Thermal_expansion_coefficients are expected
            * to have already been computed when this function is called. Solid viscosities are also modified
            * in the out object here because the presence of melt weakens the material.
-          */
+           */
           void calculate_fluid_outputs(const typename Interface<dim>::MaterialModelInputs &in,
                                        typename Interface<dim>::MaterialModelOutputs &out,
                                        const double reference_T) const;
@@ -117,8 +117,8 @@ namespace aspect
 
         private:
           /**
-          * Parameters for anhydrous melting of peridotite after Katz, 2003
-          */
+           * Parameters for anhydrous melting of peridotite after Katz, 2003
+           */
 
           double reference_rho_fluid;
           double xi_0;

include/aspect/material_model/rheology/peierls_creep.h

@@ -269,7 +269,7 @@ namespace aspect
           /**
            * A parameter determines whether a strict cutoff
            * on the stress is applied to the Peierls creep
-          */
+           */
           bool apply_strict_cutoff;
 
           /**