noCorrectionLimiting.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-2018 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::CorrectionLimitingMethods::noCorrectionLimiting
26 
27 Description
28 
29 SourceFiles
30  noCorrectionLimiting.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef noCorrectionLimiting_H
35 #define noCorrectionLimiting_H
36 
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43 namespace CorrectionLimitingMethods
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class noCorrectionLimiting Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
53 {
54 public:
55 
56  //- Runtime type information
57  TypeName("none");
58 
59 
60  // Constructors
61 
62  //- Construct from components
64 
65  //- Construct as copy
67 
68  //- Construct and return a clone
70  {
72  (
73  new noCorrectionLimiting(*this)
74  );
75  }
76 
77 
78  //- Destructor
79  virtual ~noCorrectionLimiting();
80 
81 
82  // Member Functions
83 
84  //- Return the limited velocity
85  virtual vector limitedVelocity
86  (
87  const vector uP,
88  const vector dU,
89  const vector uMean
90  ) const;
91 };
92 
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 
96 } // End namespace CorrectionLimitingMethods
97 } // End namespace Foam
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 #endif
102 
103 // ************************************************************************* //
dictionary dict
noCorrectionLimiting(const dictionary &dict)
Construct from components.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual vector limitedVelocity(const vector uP, const vector dU, const vector uMean) const
Return the limited velocity.
Base class for correction limiting methods.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
virtual autoPtr< CorrectionLimitingMethod > clone() const
Construct and return a clone.
Namespace for OpenFOAM.
TypeName("none")
Runtime type information.