mirror of
https://github.com/OPM/opm-simulators.git
synced 2025-01-18 21:12:57 -06:00
Fixes and improvements to transport solver docs.
This commit is contained in:
parent
213e143c47
commit
b05fec38fd
@ -27,10 +27,10 @@ struct UnstructuredGrid;
|
||||
namespace Opm
|
||||
{
|
||||
|
||||
/// Interface for reordering transport models.
|
||||
/// A transport model must provide the solveSingleCell() and
|
||||
/// Interface for implementing reordering solvers.
|
||||
/// A subclass must provide the solveSingleCell() and
|
||||
/// solveMultiCell methods, and is expected to implement a solve()
|
||||
/// method that will have an interface geared to the model's
|
||||
/// method that will have an interface geared to the its's own
|
||||
/// needs. (The solve() method is therefore not virtual in this
|
||||
/// class.) The reorderAndTransport() method is provided as an aid
|
||||
/// to implementing solve() in subclasses, together with the
|
||||
|
@ -39,6 +39,7 @@ namespace Opm
|
||||
/// Construct solver.
|
||||
/// \param[in] grid A 2d or 3d grid.
|
||||
/// \param[in] props Rock and fluid properties.
|
||||
/// \param[in] gravity Gravity vector (null for no gravity).
|
||||
/// \param[in] tol Tolerance used in the solver.
|
||||
/// \param[in] maxit Maximum number of non-linear iterations used.
|
||||
TransportSolverTwophaseReorder(const UnstructuredGrid& grid,
|
||||
@ -51,6 +52,8 @@ namespace Opm
|
||||
virtual ~TransportSolverTwophaseReorder();
|
||||
|
||||
/// Solve for saturation at next timestep.
|
||||
/// Note that this only performs advection by total velocity, and
|
||||
/// no gravity segregation.
|
||||
/// \param[in] porevolume Array of pore volumes.
|
||||
/// \param[in] source Transport source term. For interpretation see Opm::computeTransportSource().
|
||||
/// \param[in] dt Time step.
|
||||
|
Loading…
Reference in New Issue
Block a user