From 34805b5a047c4f6cdf7eb376c9fa07fb2ab37e75 Mon Sep 17 00:00:00 2001
From: Stefanie Kiemle <stefanie.kiemle@iws.uni-stuttgart.de>
Date: Thu, 6 Oct 2022 09:46:45 +0000
Subject: [PATCH] Merge branch 'fix/documentation-flux-fourier-nonequilibrium'
into 'master'
Add documentation to Fourier non-equilibrium
See merge request dumux-repositories/dumux!3314
(cherry picked from commit 838df590f8d1f3513646f548eb944c18eb4f5fc4)
c0287457 Add documentation to Fourier non-equilibrium
---
dumux/flux/fourierslawnonequilibrium.hh | 15 +++++++++++++--
1 file changed, 13 insertions(+), 2 deletions(-)
diff --git a/dumux/flux/fourierslawnonequilibrium.hh b/dumux/flux/fourierslawnonequilibrium.hh
index ad2458aaa4..3a2f57017f 100644
--- a/dumux/flux/fourierslawnonequilibrium.hh
+++ b/dumux/flux/fourierslawnonequilibrium.hh
@@ -19,8 +19,19 @@
/*!
* \file
* \ingroup Flux
- * \brief This file contains the data which is required to calculate
- * diffusive mass fluxes due to molecular diffusion with Fourier's law.
+ * \brief Diffusive heat flux according to non-equilibrium Fourier's law
+ *
+ * This law is based on the general form of Fourier's law which describes the diffusive
+ * heat flux as proportional to a temperature gradient \f$\textbf{grad}\, T_\alpha \f$.
+ * In contrast to the general form, a local thermodynamic equilibrium is not assumed.
+ * Thus, the heat flux for the different phases \f$\alpha \f$ needs to be solved.
+ * \n
+ * \f[
+ * \textbf{j}_{heat,\alpha} = - \lambda_\alpha \; \textbf{grad}\, T_\alpha
+ * \f]
+ * \n
+ * With \f$\lambda_\alpha \f$ as the thermal conductivity for either a solid, liquid or
+ * gaseous phase.
*/
#ifndef DUMUX_DISCRETIZATION_FOURIERS_LAW_NONEQUILIBRIUM_HH
#define DUMUX_DISCRETIZATION_FOURIERS_LAW_NONEQUILIBRIUM_HH
--
GitLab