Skip to content
Snippets Groups Projects
Commit 8b792199 authored by Andrew Heather's avatar Andrew Heather
Browse files

ENH: Updated/clean-up header documentation

parent 6c1b2f4e
No related branches found
No related tags found
No related merge requests found
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2014-2015 OpenFOAM Foundation \\ / A nd | Copyright (C) 2014-2015 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation | Copyright (C) 2015 OpenCFD Ltd.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
This file is part of OpenFOAM. This file is part of OpenFOAM.
...@@ -39,7 +39,7 @@ Description ...@@ -39,7 +39,7 @@ Description
\f] \f]
\f[ \f[
k = \frac{(U^*)^2}{\sqrt{C_mu}} k = \frac{(U^*)^2}{\sqrt{C_{\mu}}}
\f] \f]
\f[ \f[
...@@ -50,7 +50,7 @@ Description ...@@ -50,7 +50,7 @@ Description
\vartable \vartable
U^* | Friction velocity U^* | Friction velocity
\kappa | von Karman's constant \kappa | von Karman's constant
C_mu | Turbulence viscosity coefficient C_{\mu} | Turbulence viscosity coefficient
z | Vertical coordinate z | Vertical coordinate
z_0 | Surface roughness height [m] z_0 | Surface roughness height [m]
z_g | Minimum z-coordinate [m] z_g | Minimum z-coordinate [m]
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation | Copyright (C) 2015 OpenCFD Ltd.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
This file is part of OpenFOAM. This file is part of OpenFOAM.
...@@ -22,7 +22,7 @@ License ...@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class Class
Foam::SRFVelocityFvPatchVectorField Foam::SRFFreestreamVelocityFvPatchVectorField
Description Description
Freestream velocity condition to be used in conjunction with the single Freestream velocity condition to be used in conjunction with the single
...@@ -32,17 +32,17 @@ Description ...@@ -32,17 +32,17 @@ Description
applies the appropriate rotation transformation in time and space to applies the appropriate rotation transformation in time and space to
determine the local velocity using: determine the local velocity using:
\f[ \f[
U_p = cos(\theta)*U_{Inf} + sin(theta) (n^UInf) - U_{p,srf} U_p = cos(\theta) U_{Inf} + sin(\theta) (n \times U_{Inf}) - U_{p,srf}
\f] \f]
where where
\vartable \vartable
U_p = patch velocity [m/s] U_p | patch velocity [m/s]
U_{Inf} = free stream velocity in the absolute frame [m/s] U_{Inf} | free stream velocity in the absolute frame [m/s]
theta = swept angle [rad] \theta | swept angle [rad]
n = axis direction of the SRF n | axis direction of the SRF
U_{p,srf} = SRF velocity of the patch U_{p,srf} | SRF velocity of the patch [m/s]
\endvartable \endvartable
......
...@@ -52,9 +52,9 @@ Description ...@@ -52,9 +52,9 @@ Description
where where
\vartable \vartable
U_p = patch velocity [m/s] U_p | patch velocity [m/s]
U_{in} = user-specified inlet velocity U_{in} | user-specified inlet velocity
U_{p,srf} = SRF velocity U_{p,srf} | SRF velocity
\endvartable \endvartable
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment