OilfieldToolsNet/opm-simulators
4
0
Fork 0
mirror of https://github.com/OPM/opm-simulators.git synced 2025-02-25 18:55:30 -06:00
Code Issues Packages Projects Releases Wiki Activity

Change doxygen syntax to use markdown.

Browse Source
This commit is contained in:
Atgeirr Flø Rasmussen 2013-03-22 09:55:12 +01:00
parent 3d382f8220
commit 1bfcf77b38
1 changed files with 13 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
opm/core/tof/TofDiscGalReorder.hpp
View File

@ -52,28 +52,24 @@ namespace Opm
/// \param[in] grid A 2d or 3d grid. /// \param[in] grid A 2d or 3d grid.
/// \param[in] param Parameters for the solver. /// \param[in] param Parameters for the solver.
/// The following parameters are accepted (defaults):\n /// The following parameters are accepted (defaults):\n
/// <ul> /// - \c dg_degree (0) -- Polynomial degree of basis functions.
/// <li> \c dg_degree (0) Polynomial degree of basis functions. /// - \c use_tensorial_basis (false) -- Use tensor-product basis, interpreting dg_degree as
/// <li> \c use_tensorial_basis (false) Use tensor-product basis, interpreting dg_degree as
/// bi/tri-degree not total degree. /// bi/tri-degree not total degree.
/// <li> \c use_cvi (false) Use ECVI velocity interpolation. /// - \c use_cvi (false) -- Use ECVI velocity interpolation.
/// <li> \c use_limiter (false) Use a slope limiter. If true, the next three parameters are used. /// - \c use_limiter (false) -- Use a slope limiter. If true, the next three parameters are used.
/// <li> \c limiter_relative_flux_threshold (1e-3) Ignore upstream fluxes below this threshold, relative to total cell flux. /// - \c limiter_relative_flux_threshold (1e-3) -- Ignore upstream fluxes below this threshold,
/// <li> \c limiter_method ("MinUpwindFace") Limiter method used. Accepted methods are: /// relative to total cell flux.
/// <ul> /// - \c limiter_method ("MinUpwindFace") -- Limiter method used. Accepted methods are:
/// <li> MinUpwindFace Limit cell tof to >= inflow face tofs. /// - MinUpwindFace -- Limit cell tof to >= inflow face tofs.
/// <li> MinUpwindAverage Limit cell tof to >= inflow cell average tofs. /// - MinUpwindAverage -- Limit cell tof to >= inflow cell average tofs.
/// </ul> /// - \c limiter_usage ("DuringComputations") -- Usage pattern for limiter. Accepted choices are:
/// <li> \c limiter_usage ("DuringComputations") Usage pattern for limiter. Accepted choices are: /// - DuringComputations -- Apply limiter to cells as they are computed,
/// <ul>
/// <li> DuringComputations Apply limiter to cells as they are computed,
/// so downstream cells' solutions may be affected /// so downstream cells' solutions may be affected
/// by limiting in upstream cells. /// by limiting in upstream cells.
/// <li> AsPostProcess Apply in dependency order, but only after /// - AsPostProcess -- Apply in dependency order, but only after
/// computing (unlimited) solution. /// computing (unlimited) solution.
/// <li> AsSimultaneousPostProcess Apply to each cell independently, using un- /// - AsSimultaneousPostProcess -- Apply to each cell independently, using un-
/// limited solution in neighbouring cells. /// limited solution in neighbouring cells.
/// </ul>
TofDiscGalReorder(const UnstructuredGrid& grid, TofDiscGalReorder(const UnstructuredGrid& grid,
const parameter::ParameterGroup& param); const parameter::ParameterGroup& param);