Skip to content
Snippets Groups Projects
Commit f35b32ce authored by Yue Wang's avatar Yue Wang Committed by Timo Koch
Browse files

[doc] add documentation for scheidegger dispersion tensor and doxygen.

parent 51258f03
No related branches found
No related tags found
1 merge request!3734Introduce subcategories in fluidmatrixinteractions with descriptions
......@@ -93,7 +93,7 @@ The following laws can be implemented by deriving from the abstract base class,
@defgroup DispersionTensors Dispersion Tensors
@brief Dispersion tensor models characterising mechanical dispersion in porous media
@details Mechanical dispersion is caused by particles traveling at different velocities through the porous medium \cite Fried1971. A particle in the middle of a pore has a higher velocity than a particle close to a grain. Due to the tortuosity of the porous medium, particles take different paths through it. Given the existence of an REV, mechanical dispersion typically leads to increased Fickian diffusion on the Darcy scale \cite Bear1986. The magnitude and directionality of the increase diffusive transport depends on the size of the averaging volumes and characteristics of the flow such as average velocity magnitude and direction.
@details Mechanical dispersion is caused by particles traveling at different velocities through the porous medium \cite Fried1971. A particle in the middle of a pore has a higher velocity than a particle close to a grain. Due to the tortuosity of the porous medium, particles take different paths through it. Given the existence of an REV, mechanical dispersion typically leads to increased Fickian diffusion on the Darcy scale \cite Bear1986. The magnitude and directionality of the increase diffusive transport depends on the size of the averaging volumes and characteristics of the flow such as average velocity magnitude and direction. The following classes can be implemented.
@ingroup Fluidmatrixinteractions
@defgroup PoreNetwork Pore Network
......
......@@ -10,16 +10,18 @@
#include <dune/common/fmatrix.hh>
#include <dumux/common/properties.hh>
namespace Dumux {
/*!
* \ingroup DispersionTensors
* \addtogroup DispersionTensors
* \copydetails Dumux::FullDispersionTensor
*/
namespace Dumux {
/*!
* \ingroup DispersionTensors
* \brief Full dispersion tensor
*
* ### Full dispersion tensor
* The full dispersion tensor is given by the spatial parameters.
*/
template<class TypeTag>
class FullDispersionTensor
......
......@@ -29,9 +29,24 @@ static constexpr bool hasVelocityInSpatialParams()
{ return Dune::Std::is_detected<HasVelocityInSpatialParams, Problem, SubControlVolumeFace>::value; }
}
/*!
* \addtogroup DispersionTensors
* \copydetails Dumux::ScheideggersDispersionTensor
*/
/*!
* \ingroup DispersionTensors
* \brief Scheidegger's dispersion tensor
*
* ### Scheidegger's dispersion tensor
* This class calculates the dispersion tensor for compositional and thermal models using Scheidegger's model.
* The dispersion tensor is given by:
* \f[
* D = \frac{\mathbf{v} \mathbf{v}^T}{\|\mathbf{v}\|} \cdot (\alpha_L - \alpha_T) + \|\mathbf{v}\| \cdot \alpha_T \cdot \mathbf{I}
* \f]
* where \f$\mathbf{v}\f$ is the velocity vector, \f$\alpha_L\f$ and \f$\alpha_T\f$ are the
* longitudinal and transverse dispersivities, respectively, and \f$\mathbf{I}\f$ is the identity matrix.
* The velocity is either taken from the spatial parameters or from the reconstructed velocity field and the dispersivities are taken from the spatial parameters.
*/
template<class TypeTag>
class ScheideggersDispersionTensor
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment