RichardsFastSlow/doc/latex/class_physics.tex

\hypertarget{class_physics}{}\doxysection{Physics Class Reference}
\label{class_physics}\index{Physics@{Physics}}


The \mbox{\hyperlink{class_physics}{Physics}} class contains all physical parameters characterising the soil.  




{\ttfamily \#include $<$physics.\+hpp$>$}

\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{class_physics_a7ecf3b371b799eb43e7c9b8e59b251cd}\label{class_physics_a7ecf3b371b799eb43e7c9b8e59b251cd}} 
double \mbox{\hyperlink{class_physics_a7ecf3b371b799eb43e7c9b8e59b251cd}{s\+\_\+\+BC}} (double P)
\begin{DoxyCompactList}\small\item\em Brooks and Corey saturation map. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{class_physics_a0636c81bbfe75ad32f980aed005c5c18}\label{class_physics_a0636c81bbfe75ad32f980aed005c5c18}} 
double \mbox{\hyperlink{class_physics_a0636c81bbfe75ad32f980aed005c5c18}{ds\+\_\+\+BC}} (double P)
\begin{DoxyCompactList}\small\item\em Brooks and Corey derivative of the saturation map. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{class_physics_ae7372da9f822cb4170b2dda36d524d62}\label{class_physics_ae7372da9f822cb4170b2dda36d524d62}} 
void() \mbox{\hyperlink{class_physics_ae7372da9f822cb4170b2dda36d524d62}{s\+\_\+ds\+\_\+\+BC}} (double P, double \&v, double \&dv)
\begin{DoxyCompactList}\small\item\em Brooks and Corey saturation and its derivative setter. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{class_physics_a74dea829cd454fb541bc6c6700d83824}\label{class_physics_a74dea829cd454fb541bc6c6700d83824}} 
double \mbox{\hyperlink{class_physics_a74dea829cd454fb541bc6c6700d83824}{kr\+\_\+\+BC}} (double P)
\begin{DoxyCompactList}\small\item\em Brooks and Corey relative conductivity map. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{class_physics_af087f965a61b5bfe74ffe7270c6522e1}\label{class_physics_af087f965a61b5bfe74ffe7270c6522e1}} 
double \mbox{\hyperlink{class_physics_af087f965a61b5bfe74ffe7270c6522e1}{dkr\+\_\+\+BC}} (double P)
\begin{DoxyCompactList}\small\item\em Brooks and Corey derivative of the relative conductivity map. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{class_physics_acb5e0e5ae75a0e403c7d8830a62b436b}\label{class_physics_acb5e0e5ae75a0e403c7d8830a62b436b}} 
void() \mbox{\hyperlink{class_physics_acb5e0e5ae75a0e403c7d8830a62b436b}{kr\+\_\+dkr\+\_\+\+BC}} (double P, double \&v, double \&dv)
\begin{DoxyCompactList}\small\item\em Brooks and Corey relative conductivity and its derivative setter. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{class_physics_a4c11513fe2acfc75582c051d27e72bbd}\label{class_physics_a4c11513fe2acfc75582c051d27e72bbd}} 
double \mbox{\hyperlink{class_physics_a4c11513fe2acfc75582c051d27e72bbd}{g}}
\begin{DoxyCompactList}\small\item\em Gravity acceleration. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{class_physics_a001776b79916d7a81a93a2e134cf779e}\label{class_physics_a001776b79916d7a81a93a2e134cf779e}} 
double \mbox{\hyperlink{class_physics_a001776b79916d7a81a93a2e134cf779e}{rho}}
\begin{DoxyCompactList}\small\item\em Fluid density. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{class_physics_aa58363bbb2feaf728ed6d31e05e7a957}\label{class_physics_aa58363bbb2feaf728ed6d31e05e7a957}} 
double \mbox{\hyperlink{class_physics_aa58363bbb2feaf728ed6d31e05e7a957}{phi}}
\begin{DoxyCompactList}\small\item\em Porosity of the soil. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{class_physics_ab1490c3d28e2576990646a6de56d358b}\label{class_physics_ab1490c3d28e2576990646a6de56d358b}} 
double \mbox{\hyperlink{class_physics_ab1490c3d28e2576990646a6de56d358b}{k0}}
\begin{DoxyCompactList}\small\item\em Conductivity of the saturated soil. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{class_physics_a5992a20f18d607ec172df4815c7299cc}\label{class_physics_a5992a20f18d607ec172df4815c7299cc}} 
double \mbox{\hyperlink{class_physics_a5992a20f18d607ec172df4815c7299cc}{nivrivsat}}
\begin{DoxyCompactList}\small\item\em Characterise the water pressure at the bottom of the overland water. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{class_physics_a65cddae93909986d331f5e592cde6dfe}\label{class_physics_a65cddae93909986d331f5e592cde6dfe}} 
double($\ast$ \mbox{\hyperlink{class_physics_a65cddae93909986d331f5e592cde6dfe}{s}} )(double)
\begin{DoxyCompactList}\small\item\em Return the saturation in function of the pressure. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{class_physics_a354fbd584df73eead3873f188071c87a}\label{class_physics_a354fbd584df73eead3873f188071c87a}} 
double($\ast$ \mbox{\hyperlink{class_physics_a354fbd584df73eead3873f188071c87a}{ds}} )(double)
\begin{DoxyCompactList}\small\item\em Return the derivtive of the saturation in function of the pressure. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{class_physics_aec4d02772570ff1320e33f858f22875e}\label{class_physics_aec4d02772570ff1320e33f858f22875e}} 
void($\ast$ \mbox{\hyperlink{class_physics_aec4d02772570ff1320e33f858f22875e}{s\+\_\+ds}} )(double, double \&, double \&)
\begin{DoxyCompactList}\small\item\em Set the saturation and its derivative in function of the pressure. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{class_physics_ad053182af1e0f57931f3eae4a181ba19}\label{class_physics_ad053182af1e0f57931f3eae4a181ba19}} 
double($\ast$ \mbox{\hyperlink{class_physics_ad053182af1e0f57931f3eae4a181ba19}{kr}} )(double)
\begin{DoxyCompactList}\small\item\em Return the relative conductivity in function of the pressure. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{class_physics_a26944c7092b333620c7698d38be78d84}\label{class_physics_a26944c7092b333620c7698d38be78d84}} 
double($\ast$ \mbox{\hyperlink{class_physics_a26944c7092b333620c7698d38be78d84}{dkr}} )(double)
\begin{DoxyCompactList}\small\item\em Return the derivtive of the relative conductivity in function of the pressure. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{class_physics_ac7d38942e7ab0a36439e271ad6643cd3}\label{class_physics_ac7d38942e7ab0a36439e271ad6643cd3}} 
void($\ast$ \mbox{\hyperlink{class_physics_ac7d38942e7ab0a36439e271ad6643cd3}{kr\+\_\+dkr}} )(double, double \&, double \&)
\begin{DoxyCompactList}\small\item\em Set the relative conductivity and its derivative in function of the pressure. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{class_physics_a8f03c01b41872e542b96c7c004802d5a}\label{class_physics_a8f03c01b41872e542b96c7c004802d5a}} 
double \mbox{\hyperlink{class_physics_a8f03c01b41872e542b96c7c004802d5a}{model\+\_\+datas}} \mbox{[}6\mbox{]}
\begin{DoxyCompactList}\small\item\em Datas used to define the model. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
The \mbox{\hyperlink{class_physics}{Physics}} class contains all physical parameters characterising the soil. 

Definition at line 24 of file physics.\+hpp.



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
src/physics.\+hpp\end{DoxyCompactItemize}