swarmCorrection.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-2015 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::swarmCorrection
26 
27 Description
28 
29 SourceFiles
30  swarmCorrection.C
31  newSwarmCorrection.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef swarmCorrection_H
36 #define swarmCorrection_H
37 
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 
40 #include "volFields.H"
41 #include "dictionary.H"
42 #include "runTimeSelectionTables.H"
43 
44 namespace Foam
45 {
46 
47 class phasePair;
48 
49 /*---------------------------------------------------------------------------*\
50  Class swarmCorrection Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class swarmCorrection
54 {
55 protected:
56 
57  // Protected data
58 
59  //- Phase pair
60  const phasePair& pair_;
61 
62 
63 public:
64 
65  //- Runtime type information
66  TypeName("swarmCorrection");
67 
68 
69  // Declare runtime construction
71  (
72  autoPtr,
74  dictionary,
75  (
76  const dictionary& dict,
77  const phasePair& pair
78  ),
79  (dict, pair)
80  );
81 
82 
83  // Constructors
84 
85  //- Construct from a dictionary and a phase pair
87  (
88  const dictionary& dict,
89  const phasePair& pair
90  );
91 
92 
93  //- Destructor
94  virtual ~swarmCorrection();
95 
96 
97  // Selectors
98 
100  (
101  const dictionary& dict,
102  const phasePair& pair
103  );
104 
105 
106  // Member Functions
107 
108  //- Swarm correction coefficient
109  virtual tmp<volScalarField> Cs() const = 0;
110 };
111 
112 
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 
115 } // End namespace Foam
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 #endif
120 
121 // ************************************************************************* //
const phasePair & pair_
Phase pair.
swarmCorrection(const dictionary &dict, const phasePair &pair)
Construct from a dictionary and a phase pair.
virtual ~swarmCorrection()
Destructor.
Macros to ease declaration of run-time selection tables.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
virtual tmp< volScalarField > Cs() const =0
Swarm correction coefficient.
dictionary dict
declareRunTimeSelectionTable(autoPtr, swarmCorrection, dictionary,( const dictionary &dict, const phasePair &pair ),(dict, pair))
static autoPtr< swarmCorrection > New(const dictionary &dict, const phasePair &pair)
TypeName("swarmCorrection")
Runtime type information.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117
A class for managing temporary objects.
Definition: PtrList.H:118