STY: Change LES filter name
[OpenFOAM-1.7.x.git] / src / turbulenceModels / LES / LESdeltas / maxDeltaxyz / maxDeltaxyz.H
blob8ca13b4f719a39bb339194222bd0ce69f96253c0
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2010-2010 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
11     OpenFOAM is free software: you can redistribute it and/or modify it
12     under the terms of the GNU General Public License as published by
13     the Free Software Foundation, either version 3 of the License, or
14     (at your option) any later version.
16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
19     for more details.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::maxDeltaxyz
27 Description
28     maxDeltaxyz takes the maximum of the three dimensions per cell:
29     max(hx, hy, hz). Valid for structures hexahedral cells only.
32 SourceFiles
33     maxDeltaxyz.C
35 \*---------------------------------------------------------------------------*/
37 #ifndef maxDeltaxyzDelta_H
38 #define maxDeltaxyzDelta_H
40 #include "LESdelta.H"
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 namespace Foam
47 /*---------------------------------------------------------------------------*\
48                            Class maxDeltaxyz Declaration
49 \*---------------------------------------------------------------------------*/
51 class maxDeltaxyz
53     public LESdelta
55     // Private data
57         scalar deltaCoeff_; //
60     // Private Member Functions
62         //- Disallow default bitwise copy construct and assignment
63         maxDeltaxyz(const maxDeltaxyz&);
64         void operator=(const maxDeltaxyz&);
66         // Calculate the delta values
67         void calcDelta();
70 public:
72     //- Runtime type information
73     TypeName("maxDeltaxyz");
76     // Constructors
78         //- Construct from name, mesh and IOdictionary
79         maxDeltaxyz
80         (
81             const word& name,
82             const fvMesh& mesh,
83             const dictionary&
84         );
87     //- Destructor
88     virtual ~maxDeltaxyz()
89     {}
92     // Member Functions
94         //- Read the LESdelta dictionary
95         virtual void read(const dictionary&);
97         // Correct values
98         virtual void correct();
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 } // End namespace Foam
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 #endif
111 // ************************************************************************* //