[DOC] update chemistry model documentation

doc/CFDEMcoupling_models.txt

@@ -38,7 +38,7 @@ models used for chemical reaction calculations.
 "diffusionCoefficients"_chemistryModel_diffusionCoefficients.html,
 "massTransferCoeff"_chemistryModel_massTransferCoeff.html,
 "off"_chemistryModel_noChemistry.html,
-reactantPerParticle,
+"reactantPerParticle"_chemistryModel_reactantPerParticle.html,
 "species"_chemistryModel_species.html :tb(c=2,ea=c)
 
 

doc/chemistryModel_diffusionCoefficients.txt

@@ -23,7 +23,7 @@ diffusionCoefficientsProps
     diffusantGasNames   ( speciesNames );
 \} :pre
 
-{switch1} = (optional, normally off) flag to give information :ulb,l
+{switch1} = (optional, default false) flag to output verbose information :ulb,l
 {ChemistryFile} = path to file, where the reacting species are listed :l
 {diffusantGasNames} = list of gas field names that are the reactant gases :l
 :ule

doc/chemistryModel_massTransferCoeff.txt

@@ -21,7 +21,7 @@ massTransferCoeffProps
     verbose         switch1;
 \} :pre
 
-{switch1} = (optional, normally off) flag to give information :l
+{switch1} = (optional, default false) flag to output verbose information :l
 :ule
 
 [Examples:]

doc/chemistryModel_reactantPerParticle.txt

@@ -0,0 +1,54 @@
+"CFDEMproject Website"_lws - "Main Page"_main :c
+
+:link(lws,http://www.cfdem.com)
+:link(main,CFDEMcoupling_Manual.html)
+
+:line
+
+chemistryModel reactantPerParticle command :h3
+
+[Syntax:]
+
+Defined in "couplingProperties"_CFDEMcoupling_dicts.html#couplingProperties
+dictionary.
+
+chemistryModels
+(
+    reactantPerParticle
+);
+reactantPerParticleProps
+\{
+    voidfractionFieldName   "voidfraction";
+    Nevery                  number1;
+\} :pre
+
+{voidfraction} = (optional, default "voidfraction") name of the finite volume void fraction field :l
+{number1} = (optional, default 1) number to adjust execution interval :l
+:ule
+
+[Examples:]
+
+chemistryModels
+(
+    reactantPerParticle
+);
+reactantPerParticleProps
+\{
+    voidfractionFieldName   "voidfraction";
+    Nevery                  1;
+\} :pre
+
+[Description:]
+
+The chemistry model performs the calculation of chemical reactional effects
+acting on each DEM particle. The reactantPerParticle model is the model to
+communicate the available reactant per particle.
+
+[Restrictions:]
+
+none
+
+[Related commands:]
+
+"chemistryModel"_chemistryModel.html
+

doc/chemistryModel_species.txt

@@ -26,16 +26,18 @@ speciesProps
     partTempName            "partTemp";
     partRhoName             "partRho";
     verbose                 switch1;
+    Nevery                  number1;
 \} :pre
 
 {ChemistryFile} = path to file, where the reacting species are listed  :ulb,l
-{T} = name of the finite volume temperature field, it is already added in default and doesn't need to be specified if name is the same :l
+{T} = (optional, default "T") name of the finite volume temperature field :l
-{rho} = name of the finite volume density field, it is already added in default and doesn't need to be specified if name is the same :l
+{rho} = (optional, default "rho") name of the finite volume density field :l
-{voidfraction} = name of the finite volume void fraction field, it is already added in default and doesn't need to be specified if name is the same :l
+{voidfraction} = (optional, default "voidfraction") name of the finite volume void fraction field :l
-{molarConc} = name of the finite volume molar concentration field, it is already added in default and doesn't need to be specified if name is the same :l
+{molarConc} = (optional, default "molarConc") name of the finite volume molar concentration field :l
-{partTemp} = name of the finite volume cell averaged particle temperature field, it is already added in default and doesn't need to be specified if name is the same :l
+{partTemp} = (optional, default "partTemp") name of the finite volume cell averaged particle temperature field :l
-{partRho} = name of the finite volume cell averaged density temperature field, it is already added in default and doesn't need to be specified if name is the same :l
+{partRho} = (optional, default "partRho") name of the finite volume cell averaged density temperature field :l
-{switch1} = (optional, normally off) flag to give information :l
+{switch1} = (optional, default false) flag to output verbose information :l
+{number1} = (optional, default 1) number to adjust execution interval :l
 :ule
 
 [Examples:]