noCorrectionLimiting.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) 2013-2014 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::CorrectionLimitingMethods::noCorrectionLimiting
28 
29 Group
30  grpLagrangianIntermediateMPPICCorrectionLimitingMethods
31 
32 Description
33  Place holder for the 'none' option
34 
35 SourceFiles
36  noCorrectionLimiting.C
37 
38 \*---------------------------------------------------------------------------*/
39 
40 #ifndef noCorrectionLimiting_H
41 #define noCorrectionLimiting_H
42 
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 namespace CorrectionLimitingMethods
50 {
51 
52 /*---------------------------------------------------------------------------*\
53  Class noCorrectionLimiting Declaration
54 \*---------------------------------------------------------------------------*/
55 
57 :
59 {
60 public:
61 
62  //- Runtime type information
63  TypeName("none");
64 
65 
66  // Constructors
67 
68  //- Construct from components
70 
71  //- Construct as copy
73 
74  //- Construct and return a clone
76  {
78  (
79  new noCorrectionLimiting(*this)
80  );
81  }
82 
83 
84  //- Destructor
85  virtual ~noCorrectionLimiting();
86 
87 
88  // Member Functions
89 
90  //- Return the limited velocity
91  virtual vector limitedVelocity
92  (
93  const vector uP,
94  const vector dU,
95  const vector uMean
96  ) const;
97 };
98 
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 } // End namespace CorrectionLimitingMethods
103 } // End namespace Foam
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 #endif
108 
109 // ************************************************************************* //
Foam::CorrectionLimitingMethods::noCorrectionLimiting::TypeName
TypeName("none")
Runtime type information.
Foam::CorrectionLimitingMethods::noCorrectionLimiting
Place holder for the 'none' option.
Definition: noCorrectionLimiting.H:55
Foam::CorrectionLimitingMethod
Base class for correction limiting methods.
Definition: CorrectionLimitingMethod.H:55
Foam::CorrectionLimitingMethods::noCorrectionLimiting::limitedVelocity
virtual vector limitedVelocity(const vector uP, const vector dU, const vector uMean) const
Return the limited velocity.
Definition: noCorrectionLimiting.C:76
Foam::CorrectionLimitingMethods::noCorrectionLimiting::~noCorrectionLimiting
virtual ~noCorrectionLimiting()
Destructor.
Definition: noCorrectionLimiting.C:68
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam::CorrectionLimitingMethods::noCorrectionLimiting::clone
virtual autoPtr< CorrectionLimitingMethod > clone() const
Construct and return a clone.
Definition: noCorrectionLimiting.H:74
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
Foam::Vector< scalar >
Foam::CorrectionLimitingMethods::noCorrectionLimiting::noCorrectionLimiting
noCorrectionLimiting(const dictionary &dict)
Construct from components.
Definition: noCorrectionLimiting.C:49
CorrectionLimitingMethod.H