From 8b79219950431b736a800275cdd65b1ea5a5a8a8 Mon Sep 17 00:00:00 2001
From: Andrew Heather <a.heather@opencfd.co.uk>
Date: Wed, 25 Nov 2015 09:05:28 +0000
Subject: [PATCH] ENH: Updated/clean-up header documentation
---
.../atmBoundaryLayer/atmBoundaryLayer.H | 6 +++---
.../SRFFreestreamVelocityFvPatchVectorField.H | 20 +++++++++----------
.../SRFVelocityFvPatchVectorField.H | 6 +++---
3 files changed, 16 insertions(+), 16 deletions(-)
diff --git a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayer/atmBoundaryLayer.H b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayer/atmBoundaryLayer.H
index f551ecc7e4e..f3353c0ab37 100644
--- a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayer/atmBoundaryLayer.H
+++ b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayer/atmBoundaryLayer.H
@@ -3,7 +3,7 @@
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2014-2015 OpenFOAM Foundation
- \\/ M anipulation |
+ \\/ M anipulation | Copyright (C) 2015 OpenCFD Ltd.
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
@@ -39,7 +39,7 @@ Description
\f]
\f[
- k = \frac{(U^*)^2}{\sqrt{C_mu}}
+ k = \frac{(U^*)^2}{\sqrt{C_{\mu}}}
\f]
\f[
@@ -50,7 +50,7 @@ Description
\vartable
U^* | Friction velocity
\kappa | von Karman's constant
- C_mu | Turbulence viscosity coefficient
+ C_{\mu} | Turbulence viscosity coefficient
z | Vertical coordinate
z_0 | Surface roughness height [m]
z_g | Minimum z-coordinate [m]
diff --git a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H
index 75bef5835d4..ba70362f493 100644
--- a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H
+++ b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H
@@ -3,7 +3,7 @@
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation
- \\/ M anipulation |
+ \\/ M anipulation | Copyright (C) 2015 OpenCFD Ltd.
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
- Foam::SRFVelocityFvPatchVectorField
+ Foam::SRFFreestreamVelocityFvPatchVectorField
Description
Freestream velocity condition to be used in conjunction with the single
@@ -32,17 +32,17 @@ Description
applies the appropriate rotation transformation in time and space to
determine the local velocity using:
- \f[
- U_p = cos(\theta)*U_{Inf} + sin(theta) (n^UInf) - U_{p,srf}
- \f]
+ \f[
+ U_p = cos(\theta) U_{Inf} + sin(\theta) (n \times U_{Inf}) - U_{p,srf}
+ \f]
where
\vartable
- U_p = patch velocity [m/s]
- U_{Inf} = free stream velocity in the absolute frame [m/s]
- theta = swept angle [rad]
- n = axis direction of the SRF
- U_{p,srf} = SRF velocity of the patch
+ U_p | patch velocity [m/s]
+ U_{Inf} | free stream velocity in the absolute frame [m/s]
+ \theta | swept angle [rad]
+ n | axis direction of the SRF
+ U_{p,srf} | SRF velocity of the patch [m/s]
\endvartable
diff --git a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H
index 33b0314cef2..61a5119ba99 100644
--- a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H
+++ b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H
@@ -52,9 +52,9 @@ Description
where
\vartable
- U_p = patch velocity [m/s]
- U_{in} = user-specified inlet velocity
- U_{p,srf} = SRF velocity
+ U_p | patch velocity [m/s]
+ U_{in} | user-specified inlet velocity
+ U_{p,srf} | SRF velocity
\endvartable
--
GitLab