cubeRootVolDelta.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2015 OpenFOAM Foundation
9  Copyright (C) 2016 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 Class
28  Foam::cubeRootVolDelta
29 
30 Description
31  Simple cube-root of cell volume delta used in LES models.
32 
33 SourceFiles
34  cubeRootVolDelta.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef cubeRootVolDelta_H
39 #define cubeRootVolDelta_H
40 
41 #include "LESdelta.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 namespace LESModels
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class cubeRootVolDelta Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 class cubeRootVolDelta
55 :
56  public LESdelta
57 {
58  // Private data
59 
60  scalar deltaCoeff_;
61 
62 
63  // Private Member Functions
64 
65  //- No copy construct
66  cubeRootVolDelta(const cubeRootVolDelta&) = delete;
67 
68  //- No copy assignment
69  void operator=(const cubeRootVolDelta&) = delete;
70 
71 
72 public:
73 
74  //- Runtime type information
75  TypeName("cubeRootVol");
76 
77 
78  // Constructors
79 
80  //- Construct from name, turbulenceModel and dictionary
82  (
83  const word& name,
85  const dictionary&
86  );
87 
88 
89  //- Destructor
90  virtual ~cubeRootVolDelta() = default;
91 
92 
93  // Member Functions
94 
95  //- Calculate the delta values
96  void calcDelta();
97 
98  //- Read the LESdelta dictionary
99  virtual void read(const dictionary&);
100 
101  // Correct values
102  virtual void correct();
103 };
104 
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 } // End namespace LESModels
109 } // End namespace Foam
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 #endif
114 
115 // ************************************************************************* //
Foam::LESModels::cubeRootVolDelta
Definition: cubeRootVolDelta.H:53
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::LESModels::cubeRootVolDelta::correct
virtual void correct()
Definition: cubeRootVolDelta.C:128
Foam::LESdelta::turbulence
const turbulenceModel & turbulence() const
Return turbulenceModel reference.
Definition: LESdelta.H:134
Foam::LESModels::cubeRootVolDelta::~cubeRootVolDelta
virtual ~cubeRootVolDelta()=default
Destructor.
Foam::turbulenceModel
Abstract base class for turbulence models (RAS, LES and laminar).
Definition: turbulenceModel.H:63
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::LESModels::cubeRootVolDelta::read
virtual void read(const dictionary &)
Read the LESdelta dictionary.
Definition: cubeRootVolDelta.C:116
LESdelta.H
Foam::LESdelta
Abstract base class for LES deltas.
Definition: LESdelta.H:53
Foam::LESModels::cubeRootVolDelta::calcDelta
void calcDelta()
Calculate the delta values.
Definition: cubeRootVolDelta.C:46
Foam::name
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:59
Foam::LESModels::cubeRootVolDelta::TypeName
TypeName("cubeRootVol")
Runtime type information.