noSwarm.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 | Copyright (C) 2014 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::swarmCorrections::noSwarm
26 
27 Description
28 
29 SourceFiles
30  noSwarm.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef noSwarm_H
35 #define noSwarm_H
36 
37 #include "swarmCorrection.H"
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43 
44 class phasePair;
45 
46 namespace swarmCorrections
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class noSwarm Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class noSwarm
54 :
55  public swarmCorrection
56 {
57 public:
58 
59  //- Runtime type information
60  TypeName("none");
61 
62 
63  // Constructors
64 
65  //- Construct from a dictionary and a phase pair
66  noSwarm
67  (
68  const dictionary& dict,
69  const phasePair& pair
70  );
71 
72 
73  //- Destructor
74  virtual ~noSwarm();
75 
76 
77  // Member Functions
78 
79  //- Swarm correction coefficient
80  tmp<volScalarField> Cs() const;
81 };
82 
83 
84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
85 
86 } // End namespace swarmCorrections
87 } // End namespace Foam
88 
89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
90 
91 #endif
92 
93 // ************************************************************************* //
TypeName("none")
Runtime type information.
Namespace for OpenFOAM.
dictionary dict
tmp< volScalarField > Cs() const
Swarm correction coefficient.
noSwarm(const dictionary &dict, const phasePair &pair)
Construct from a dictionary and a phase pair.
virtual ~noSwarm()
Destructor.