Commit 99516fd8 authored by Lars Bilke's avatar Lars Bilke
Browse files

Merge branch 'fix_doc' into 'master'

Fixed the display error in the  documentation of class RelPermUdell

See merge request ogs/ogs!3421
parents 11a96113 b890ca10
......@@ -198,3 +198,14 @@ year = {2008},
doi = {10.1680/geot.2008.58.3.157},
URL = {https://doi.org/10.1680/geot.2008.58.3.157}
}
@article{udell1985heat,
title={Heat transfer in porous media considering phase change and capillarity—the heat pipe effect},
author={Udell, Kent S},
journal={International Journal of Heat and Mass Transfer},
volume={28},
number={2},
pages={485--495},
year={1985},
publisher={Elsevier}
}
......@@ -20,18 +20,18 @@ class Medium;
class Phase;
class Component;
/**
* A simple relative permeability function as used in
* A simple relative permeability function proposed by
* Kent S Udell \cite udell1985heat.
*
* Kent S Udell. "Heat transfer in porous media considering phase change
* and capillarity-the heat pipe effect".In:International Journal of Heat
* and Mass Transfer 28.2 (1985), pp. 485-495
* Definition:
* \f$k_{\textrm{rel}}^{\alpha} =
* \left(s^{\textrm{eff}}_{\alpha}\right)^{3}\f$ where
* - \f$k_{\textrm{rel}}^{\alpha}\f$ is relative permeability of phase
* Definition:
* \f[ k_{\text{rel}}^{\alpha}
* =\left(S^{\text{eff}}_{\alpha}\right)^{3}\f] where
* - \f$k_{\text{rel}}^{\alpha}\f$ is relative permeability of phase
* \f$\alpha\f$
* - \f$s^{\textrm{eff}}_{\alpha}\f$ is the effective saturation of
* phase \f$\alpha\f$ \details This property must be a medium property, it
* - \f$S^{\text{eff}}_{\alpha}\f$ is the effective saturation of
* phase \f$\alpha\f$
*
* \details This property must be a medium property, it
* computes the permeability reduction due to saturation as function of
* capillary pressure.
*/
......
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