Skip to content
Snippets Groups Projects
Commit 9826e61b authored by Melanie Lipp's avatar Melanie Lipp
Browse files

[doc] Remove \b in front of Grid and Newton, as Angular0/1/2 and... 

[doc] Remove \b in front of Grid and Newton, as Angular0/1/2 and EnableAbsoluteResidualCriterion won't be the first entries of their category any more in the next step.
parent 9ce87ca0
No related branches found
No related tags found
1 merge request!2586Doxygen update for 3.4
Pipeline #3732 waiting for manual action
Stage: trigger
    Stage: downstream modules
      Hide whitespace changes
      Inline Side-by-side
      doc/doxygen/extradoc/parameterlist.txt
      + 2
      − 2
      View file @ 9826e61b
      ...@@ -114,7 +114,7 @@ ...@@ -114,7 +114,7 @@
      * | Forchheimer | NewtonTolerance | Scalar | 1e-12 | The error tolerance in the Newton method for solving the Forchheimer equation | * | Forchheimer | NewtonTolerance | Scalar | 1e-12 | The error tolerance in the Newton method for solving the Forchheimer equation |
      * | \b FreeFlow | EnableUnsymmetrizedVelocityGradient | bool | false | For enabling unsymmetrized velocity gradient. If false consider the shear stress caused by the gradient of the velocities normal to our face of interest. | * | \b FreeFlow | EnableUnsymmetrizedVelocityGradient | bool | false | For enabling unsymmetrized velocity gradient. If false consider the shear stress caused by the gradient of the velocities normal to our face of interest. |
      * | Freeflow | EnableUnsymmetrizedVelocityGradientForBeaversJoseph | bool | false | For enabling unsymmetrized velocity gradient for the Beavers Joseph coupling condition. If true and if the current scvf is on a boundary and if a Dirichlet BC for the pressure or a BJ condition for the slip velocity is set there, assume a tangential velocity gradient of zero along the lateral face. | * | Freeflow | EnableUnsymmetrizedVelocityGradientForBeaversJoseph | bool | false | For enabling unsymmetrized velocity gradient for the Beavers Joseph coupling condition. If true and if the current scvf is on a boundary and if a Dirichlet BC for the pressure or a BJ condition for the slip velocity is set there, assume a tangential velocity gradient of zero along the lateral face. |
      * | \b Grid | Angular0/1/2 | std::vector<Scalar> | - | min/max value for angular coordinate. Cake grids can be created by either specifying Radial,Angular or Axial in all coordinate directions. | * | Grid | Angular0/1/2 | std::vector<Scalar> | - | min/max value for angular coordinate. Cake grids can be created by either specifying Radial,Angular or Axial in all coordinate directions. |
      * | Grid | Axial0/1/2 | std::vector<Scalar> | - | min/max value for axial coordinate. Cake grids can be created by either specifying Radial,Angular or Axial in all coordinate directions. | * | Grid | Axial0/1/2 | std::vector<Scalar> | - | min/max value for axial coordinate. Cake grids can be created by either specifying Radial,Angular or Axial in all coordinate directions. |
      * | Grid | BoundarySegments | bool | false | For the dune gmsh reader: Whether to insert boundary segments into the grid | * | Grid | BoundarySegments | bool | false | For the dune gmsh reader: Whether to insert boundary segments into the grid |
      * | Grid | Cells | std::array<int, dim> | - | The number of elements in a structured uniform grid in x, y and z direction | * | Grid | Cells | std::array<int, dim> | - | The number of elements in a structured uniform grid in x, y and z direction |
      ...@@ -233,7 +233,7 @@ ...@@ -233,7 +233,7 @@
      * | MPFA | Q | CoordScalar | - | The quadrature point parameterizaion to be used on scvfs | * | MPFA | Q | CoordScalar | - | The quadrature point parameterizaion to be used on scvfs |
      * | MPFA | TransmissibilityCriterion | int | 0 | | * | MPFA | TransmissibilityCriterion | int | 0 | |
      * | MPFA | TransmissibilityCriterionThreshold | Scalar | 1e-8 | | * | MPFA | TransmissibilityCriterionThreshold | Scalar | 1e-8 | |
      * | \b Newton | EnableAbsoluteResidualCriterion | bool | - | For Newton iterations to stop the absolute residual is demanded to be below a threshold value. At least two iterations. | * | Newton | EnableAbsoluteResidualCriterion | bool | - | For Newton iterations to stop the absolute residual is demanded to be below a threshold value. At least two iterations. |
      * | Newton | EnableChop | bool | - | chop the Newton update at the beginning of the non-linear solver | * | Newton | EnableChop | bool | - | chop the Newton update at the beginning of the non-linear solver |
      * | Newton | EnableDynamicOutput | bool | true | Prints current information about assembly and solution process in the coarse of the simulation. | * | Newton | EnableDynamicOutput | bool | true | Prints current information about assembly and solution process in the coarse of the simulation. |
      * | Newton | EnablePartialReassembly | bool | - | Every entity where the primary variables exhibit a relative shift summed up since the last linearization above 'eps' will be reassembled. | * | Newton | EnablePartialReassembly | bool | - | Every entity where the primary variables exhibit a relative shift summed up since the last linearization above 'eps' will be reassembled. |
      ......
      0% or .
      You are about to add 0 people to the discussion. Proceed with caution.
      Finish editing this message first!
      Please register or to comment