CorrectionLimitingMethod.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2013-2020 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
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.
15 
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.
20 
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/>.
23 
24 Class
25  Foam::CorrectionLimitingMethod
26 
27 Description
28  Base class for correction limiting methods.
29 
30 SourceFiles
31  CorrectionLimitingMethod.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef CorrectionLimitingMethod_H
36 #define CorrectionLimitingMethod_H
37 
38 #include "volFieldsFwd.H"
39 #include "dictionary.H"
40 #include "runTimeSelectionTables.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class CorrectionLimitingMethod Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 {
53 public:
54 
55  //- Runtime type information
56  TypeName("correctionLimitingMethod");
57 
58  //- Declare runtime constructor selection table
60  (
61  autoPtr,
63  dictionary,
64  (const dictionary& dict),
65  (dict)
66  );
67 
68 
69  // Constructors
70 
71  //- Construct from components
73 
74  //- Copy constructor
76 
77  //- Construct and return a clone
78  virtual autoPtr<CorrectionLimitingMethod> clone() const = 0;
79 
80 
81  //- Selector
83  (
84  const dictionary& dict
85  );
86 
87 
88  //- Destructor
89  virtual ~CorrectionLimitingMethod();
90 
91 
92  // Member Functions
93 
94  //- Return the limited velocity
95  virtual vector limitedVelocity
96  (
97  const vector uP,
98  const vector dU,
99  const vector uMean
100  ) const = 0;
101 
102 
103  // Member Operators
104 
105  //- Disallow default bitwise assignment
106  void operator=(const CorrectionLimitingMethod&) = delete;
107 };
108 
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 } // End namespace Foam
113 
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 
116 #endif
117 
118 // ************************************************************************* //
Base class for correction limiting methods.
TypeName("correctionLimitingMethod")
Runtime type information.
virtual autoPtr< CorrectionLimitingMethod > clone() const =0
Construct and return a clone.
CorrectionLimitingMethod(const dictionary &dict)
Construct from components.
virtual vector limitedVelocity(const vector uP, const vector dU, const vector uMean) const =0
Return the limited velocity.
declareRunTimeSelectionTable(autoPtr, CorrectionLimitingMethod, dictionary,(const dictionary &dict),(dict))
Declare runtime constructor selection table.
void operator=(const CorrectionLimitingMethod &)=delete
Disallow default bitwise assignment.
virtual ~CorrectionLimitingMethod()
Destructor.
static autoPtr< CorrectionLimitingMethod > New(const dictionary &dict)
Selector.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Namespace for OpenFOAM.
Macros to ease declaration of run-time selection tables.
dictionary dict