Merge pull request #6098 from tjhei/maintenance_oct2024

update parameters

doc/sphinx/parameters/Material_20model.md

@@ -2332,7 +2332,7 @@ Also note that the melting time scale has to be larger than or equal to the reac
 
 **Pattern:** [Double 0...MAX_DOUBLE (inclusive)]
 
-**Documentation:** $\alpha_F$: exponential dependency of viscosity on the depletion field $F$ (called peridotite). Dimensionless factor. With a value of 0.0 (the default) the viscosity does not depend on the depletion. The effective viscosity increasedue to depletion is defined as $exp( \alpha_F * F)$. Rationale: melting dehydrates the source rock by removing most of the volatiles,and makes it stronger. Hirth and Kohlstedt (1996) report typical values around a factor 100 to 1000 viscosity contrast between wet and dry rocks, although some experimental studies report a smaller (factor 10) contrast (e.g. Fei et al., 2013).
+**Documentation:** $\alpha_F$: exponential dependency of viscosity on the depletion field $F$ (called peridotite). Dimensionless factor. With a value of 0.0 (the default) the viscosity does not depend on the depletion. The effective viscosity increasedue to depletion is defined as $std::exp( \alpha_F * F)$. Rationale: melting dehydrates the source rock by removing most of the volatiles,and makes it stronger. Hirth and Kohlstedt (1996) report typical values around a factor 100 to 1000 viscosity contrast between wet and dry rocks, although some experimental studies report a smaller (factor 10) contrast (e.g. Fei et al., 2013).
 
 (parameters:Material_20model/Melt_20global/Exponential_20melt_20weakening_20factor)=
 ### __Parameter name:__ Exponential melt weakening factor

doc/sphinx/parameters/Particles.md

@@ -125,6 +125,14 @@ The following properties are available:
 
 **Documentation:** Lower limit for particle number per cell. This limit is useful for adaptive meshes to prevent fine cells from being empty of particles. It will be checked and enforced after mesh refinement and after particle movement. If there are `n\_number\_of\_particles` $<$ `min\_particles\_per\_cell` particles in one cell then `min\_particles\_per\_cell` - `n\_number\_of\_particles` particles are generated and randomly placed in this cell. If the particles carry properties the individual property plugins control how the properties of the new particles are initialized.
 
+(parameters:Particles/Number_20of_20particle_20systems)=
+### __Parameter name:__ Number of particle systems
+**Default value:** 1
+
+**Pattern:** [Integer range 0...2 (inclusive)]
+
+**Documentation:** The number of particle systems to be created. The maximum number of particle systems is set by the CMake variable &lsquo;ASPECT_MAX_NUM_PARTICLE_SYSTEMS&lsquo; and is by default 2.
+
 (parameters:Particles/Particle_20generator_20name)=
 ### __Parameter name:__ Particle generator name
 **Default value:** random uniform
@@ -419,6 +427,32 @@ If the function you are describing represents a vector-valued function with mult
 
 **Documentation:** The names of the variables as they will be used in the function, separated by commas. By default, the names of variables at which the function will be evaluated are &lsquo;x&rsquo; (in 1d), &lsquo;x,y&rsquo; (in 2d) or &lsquo;x,y,z&rsquo; (in 3d) for spatial coordinates and &lsquo;t&rsquo; for time. You can then use these variable names in your function expression and they will be replaced by the values of these variables at which the function is currently evaluated. However, you can also choose a different set of names for the independent variables at which to evaluate your function expression. For example, if you work in spherical coordinates, you may wish to set this input parameter to &lsquo;r,phi,theta,t&rsquo; and then use these variable names in your function expression.
 
+(parameters:Particles/Generator/Random_20uniform)=
+## **Subsection:** Particles / Generator / Random uniform
+(parameters:Particles/Generator/Random_20uniform/Number_20of_20particles)=
+### __Parameter name:__ Number of particles
+**Default value:** 1000
+
+**Pattern:** [Double 0...MAX_DOUBLE (inclusive)]
+
+**Documentation:** Total number of particles to create (not per processor or per element). The number is parsed as a floating point number (so that one can specify, for example, &rsquo;1e4&rsquo; particles) but it is interpreted as an integer, of course.
+
+(parameters:Particles/Generator/Random_20uniform/Random_20cell_20selection)=
+### __Parameter name:__ Random cell selection
+**Default value:** true
+
+**Pattern:** [Bool]
+
+**Documentation:** If true, particle numbers per cell are calculated randomly according to their respective probability density. This means particle numbers per cell can deviate statistically from the integral of the probability density. If false, first determine how many particles each cell should have based on the integral of the density over each of the cells, and then once we know how many particles we want on each cell, choose their locations randomly within each cell.
+
+(parameters:Particles/Generator/Random_20uniform/Random_20number_20seed)=
+### __Parameter name:__ Random number seed
+**Default value:** 5432
+
+**Pattern:** [Integer range 0...2147483647 (inclusive)]
+
+**Documentation:** The seed for the random number generator that controls the particle generation. Keep constant to generate identical particle distributions in subsequent model runs. Change to get a different distribution. In parallel computations the seed is further modified on each process to ensure different particle patterns on different processes. Note that the number of particles per processor is not affected by the seed.
+
 (parameters:Particles/Generator/Reference_20cell)=
 ## **Subsection:** Particles / Generator / Reference cell
 (parameters:Particles/Generator/Reference_20cell/Number_20of_20particles_20per_20cell_20per_20direction)=