From 96235dc9e85db8759e9c7f1e592653fa8d66e74c Mon Sep 17 00:00:00 2001 From: andy Date: Wed, 5 Feb 2014 13:32:16 +0000 Subject: [PATCH] ENH: Improved header documentation --- .../LES/LESdeltas/maxDeltaxyz/maxDeltaxyz.H | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/src/turbulenceModels/LES/LESdeltas/maxDeltaxyz/maxDeltaxyz.H b/src/turbulenceModels/LES/LESdeltas/maxDeltaxyz/maxDeltaxyz.H index 0b6a9a65a2..05df8af552 100644 --- a/src/turbulenceModels/LES/LESdeltas/maxDeltaxyz/maxDeltaxyz.H +++ b/src/turbulenceModels/LES/LESdeltas/maxDeltaxyz/maxDeltaxyz.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,9 +25,10 @@ Class Foam::maxDeltaxyz Description - maxDeltaxyz takes the maximum of the three dimensions per cell: - max(hx, hy, hz). Valid for structures hexahedral cells only. - + Delta calculated by taking the maximum distance between the cell centre + and any face centre. For a regular hex cell, the computed delta will + equate to half of the cell width; accordingly, the deltaCoeff model + coefficient should be set to 2 for this case. SourceFiles maxDeltaxyz.C @@ -45,7 +46,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class maxDeltaxyz Declaration + Class maxDeltaxyz Declaration \*---------------------------------------------------------------------------*/ class maxDeltaxyz @@ -54,7 +55,8 @@ class maxDeltaxyz { // Private data - scalar deltaCoeff_; // + //- Model coefficient + scalar deltaCoeff_; // Private Member Functions