More documentation of the transport model.

Signed-off-by: Santiago Ospina De Los Ríos's avatarSantiago Ospina <santiago.ospina@iup.uni-heidelberg.de>
parent 554d2804
......@@ -4,20 +4,9 @@ build-cmake/
# Exclude generated files
python/dorie/wrapper/pf_from_file.py
python/dorie/wrapper/test_dorie.py
python/dorie/cli/cmds.py
python/dorie/dorie/cli/cmds.py
test/maps/cell_ids.h5
# Ignore temporary and auto-generated files #
*~
*.pyc
*.log
*.DS_Store
*/__pycache__/
*./DS_Store
*/.DS_Store?
*/._*
*/.Spotlight-V100
*/.Trashes
*/ehthumbs.db
*/Thumbs.db
# Ignore auxiliary Python files
__pycache__/
*.egg-info/
......@@ -23,7 +23,6 @@
@defgroup TransportModel Transport
@{
@ingroup Models
@todo document transport model
@}
@defgroup LocalOperators Local operators
......
......@@ -37,6 +37,7 @@ namespace Operator {
* @date 2018
* @copyright MIT License.
* @ingroup LocalOperators
* @ingroup TransportModel
*
* @todo Use diffusion coefficient grid function.
* @todo Implement outflow boundary condition.
......@@ -434,6 +435,7 @@ private:
* @date 2018
* @copyright MIT License.
* @ingroup LocalOperators
* @ingroup TransportModel
*
* @bug The water content is not being updated by the set time to the
* right state of the grid function.
......
......@@ -22,6 +22,9 @@ namespace Dorie{
* @ingroup TransportModel
* @see Same as Dune::Dorie::FlowBoundary.
*
* @todo Allow the user to decide wheter the solute in the boundary is
* total solute or concentration of solute.
*
* @tparam Traits The Dune::Dorie::BaseTraits that defines basic data
* types.
*/
......
......@@ -28,6 +28,8 @@ using SoluteInitial = Dune::PDELab::ConstGridFunction<
* <a href="https://en.wikipedia.org/wiki/Kernel_(statistics)">kernels</a>
* ) that allow more realistic boundary conditions for the transport
* simulation.
* @todo Allow the user to decide wheter the initial solute is
* total solute or concentration of solute.
*
* @tparam Traits The Dune::Dorie::BaseTraits that defines basic data
* types.
......
......@@ -30,6 +30,33 @@
namespace Dune{
namespace Dorie{
/**
@addtogroup TransportModel
@{
The transport model implements a class that fulfill the
Dune::Dorie::SimulationBase class requirements (see @ref Models), and which
specifically solves the transport equation for unsaturated media:
@f{eqnarray*}{
\partial_t[\theta C_w] +
\nabla\cdot [\textbf{j}_w C_w] -
\nabla [\theta \mathsf{D}_{eff}\nabla C_w]=0 &\qquad \text{in }
\Omega\\
C_w = g &\qquad \text{on } \Gamma_D
\subseteq\partial\Omega\\
\nabla C_w \cdot \textbf{n} = \textbf{j}_{\scriptscriptstyle
C_w}& \qquad \text{on } \Gamma_N =\partial\Omega \backslash
\Gamma_D
@f}
It implemented with a finite volume scheme and is written so that could be run
independently of the @ref RichardsModel model (e.g. with an
stationary case), or fully coupled with a transient case with fluxes provided
by the Dune::Dorie::RichardsSimulation class.
@}
**/
/*-------------------------------------------------------------------------*//**
* @brief Traits for the class TransportSimulation.
* @details This class extends BaseTraits to be used for the
......@@ -39,7 +66,7 @@ namespace Dorie{
* @copyright MIT License.
* @ingroup TransportModel
*
* @todo Allow higher order methods.
* @todo Implement higher order methods.
*
* @tparam BaseTraits Traits defining domain and range field
* properties of the simulation.
......@@ -50,7 +77,7 @@ template<class BaseTraits, class GFWaterFluxType, class GFWaterContentType>
struct TransportSimulationTraits : public BaseTraits
{
static constexpr int dim = BaseTraits::dim;
static constexpr int order = 0; // TODO: FV when 0, DG if higher!
static constexpr int order = 0;
using RF = typename BaseTraits::RF;
using Grid = typename BaseTraits::Grid;
using GV = typename BaseTraits::GV;
......
Markdown is supported
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