DESModelBase.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) 2015 OpenFOAM Foundation
9  Copyright (C) 2019 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::DESModelBase
29 
30 Description
31  Base class for DES models providing an interfaces to the LESRegion
32  function.
33 
34 SourceFiles
35  DESModelBase.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef DESModelBase_H
40 #define DESModelBase_H
41 
42 #include "className.H"
43 #include "tmp.H"
44 #include "volFieldsFwd.H"
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  class DESModelBase Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 class DESModelBase
56 {
57 public:
58 
59  //- Constructor
60  DESModelBase()
61  {}
62 
63  //- Destructor
64  virtual ~DESModelBase() = default;
65 
66  ClassName("DESModelBase");
67 
68 
69  // Public Member Functions
70 
71  //- Return the LES field indicator
72  virtual tmp<volScalarField> LESRegion() const = 0;
73 };
74 
75 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
76 
77 } // End namespace Foam
78 
79 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
80 
81 #endif
82 
83 // ************************************************************************* //
volFieldsFwd.H
Foam::DESModelBase::DESModelBase
DESModelBase()
Constructor.
Definition: DESModelBase.H:59
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::DESModelBase::ClassName
ClassName("DESModelBase")
className.H
Macro definitions for declaring ClassName(), NamespaceName(), etc.
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::DESModelBase::~DESModelBase
virtual ~DESModelBase()=default
Destructor.
tmp.H
Foam::DESModelBase::LESRegion
virtual tmp< volScalarField > LESRegion() const =0
Return the LES field indicator.
Foam::DESModelBase
Base class for DES models providing an interfaces to the LESRegion function.
Definition: DESModelBase.H:54