From 213e143c47df1a482145cb5881c1522653d79982 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Atgeirr=20Fl=C3=B8=20Rasmussen?= Date: Thu, 21 Mar 2013 14:51:49 +0100 Subject: [PATCH] Fixes and improvements to time-of-flight solver docs. --- opm/core/tof/TofDiscGalReorder.cpp | 28 ----------------- opm/core/tof/TofDiscGalReorder.hpp | 48 +++++++++++++++++------------- opm/core/tof/TofReorder.cpp | 1 + opm/core/tof/TofReorder.hpp | 8 ++--- 4 files changed, 32 insertions(+), 53 deletions(-) diff --git a/opm/core/tof/TofDiscGalReorder.cpp b/opm/core/tof/TofDiscGalReorder.cpp index 589393aee..896ddc080 100644 --- a/opm/core/tof/TofDiscGalReorder.cpp +++ b/opm/core/tof/TofDiscGalReorder.cpp @@ -35,22 +35,6 @@ namespace Opm /// Construct solver. - /// \param[in] grid A 2d or 3d grid. - /// \param[in] param Parameters for the solver. - /// The following parameters are accepted (defaults): - /// use_cvi (false) Use ECVI velocity interpolation. - /// use_limiter (false) Use a slope limiter. If true, the next three parameters are used. - /// limiter_relative_flux_threshold (1e-3) Ignore upstream fluxes below this threshold, relative to total cell flux. - /// limiter_method ("MinUpwindFace") Limiter method used. Accepted methods are: - /// MinUpwindFace Limit cell tof to >= inflow face tofs. - /// limiter_usage ("DuringComputations") Usage pattern for limiter. Accepted choices are: - /// DuringComputations Apply limiter to cells as they are computed, - /// so downstream cells' solutions may be affected - /// by limiting in upstream cells. - /// AsPostProcess Apply in dependency order, but only after - /// computing (unlimited) solution. - /// AsSimultaneousPostProcess Apply to each cell independently, using un- - /// limited solution in neighbouring cells. TofDiscGalReorder::TofDiscGalReorder(const UnstructuredGrid& grid, const parameter::ParameterGroup& param) : grid_(grid), @@ -111,18 +95,6 @@ namespace Opm /// Solve for time-of-flight. - /// \param[in] darcyflux Array of signed face fluxes. - /// \param[in] porevolume Array of pore volumes. - /// \param[in] source Source term. Sign convention is: - /// (+) inflow flux, - /// (-) outflow flux. - /// \param[in] degree Polynomial degree of DG basis functions used. - /// \param[out] tof_coeff Array of time-of-flight solution coefficients. - /// The values are ordered by cell, meaning that - /// the K coefficients corresponding to the first - /// cell comes before the K coefficients corresponding - /// to the second cell etc. - /// K depends on degree and grid dimension. void TofDiscGalReorder::solveTof(const double* darcyflux, const double* porevolume, const double* source, diff --git a/opm/core/tof/TofDiscGalReorder.hpp b/opm/core/tof/TofDiscGalReorder.hpp index ba6c72dc0..59b84efc2 100644 --- a/opm/core/tof/TofDiscGalReorder.hpp +++ b/opm/core/tof/TofDiscGalReorder.hpp @@ -39,10 +39,10 @@ namespace Opm /// Implements a discontinuous Galerkin solver for /// (single-phase) time-of-flight using reordering. /// The equation solved is: - /// v \cdot \grad\tau = \phi - /// where v is the fluid velocity, \tau is time-of-flight and - /// \phi is the porosity. This is a boundary value problem, where - /// \tau is specified to be zero on all inflow boundaries. + /// \f[v \cdot \nabla\tau = \phi\f] + /// where \f$ v \f$ is the fluid velocity, \f$ \tau \f$ is time-of-flight and + /// \f$ \phi \f$ is the porosity. This is a boundary value problem, where + /// \f$ \tau \f$ is specified to be zero on all inflow boundaries. /// The user may specify the polynomial degree of the basis function space /// used, but only degrees 0 and 1 are supported so far. class TofDiscGalReorder : public ReorderSolverInterface @@ -51,23 +51,29 @@ namespace Opm /// Construct solver. /// \param[in] grid A 2d or 3d grid. /// \param[in] param Parameters for the solver. - /// The following parameters are accepted (defaults): - /// dg_degree (0) Polynomial degree of basis functions. - /// use_tensorial_basis (false) Use tensor-product basis, interpreting dg_degree as - /// bi/tri-degree not total degree. - /// use_cvi (false) Use ECVI velocity interpolation. - /// use_limiter (false) Use a slope limiter. If true, the next three parameters are used. - /// limiter_relative_flux_threshold (1e-3) Ignore upstream fluxes below this threshold, relative to total cell flux. - /// limiter_method ("MinUpwindFace") Limiter method used. Accepted methods are: - /// MinUpwindFace Limit cell tof to >= inflow face tofs. - /// limiter_usage ("DuringComputations") Usage pattern for limiter. Accepted choices are: - /// DuringComputations Apply limiter to cells as they are computed, - /// so downstream cells' solutions may be affected - /// by limiting in upstream cells. - /// AsPostProcess Apply in dependency order, but only after - /// computing (unlimited) solution. - /// AsSimultaneousPostProcess Apply to each cell independently, using un- - /// limited solution in neighbouring cells. + /// The following parameters are accepted (defaults):\n + ///