FreeFOAM The Cross-Platform CFD Toolkit
NoDispersion.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) 1991-2010 OpenCFD Ltd.
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::NoDispersion
26 
27 Description
28  Place holder for 'none' option
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef NoDispersion_H
33 #define NoDispersion_H
34 
36 
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38 
39 namespace Foam
40 {
41 
42 /*---------------------------------------------------------------------------*\
43  Class NoDispersion Declaration
44 \*---------------------------------------------------------------------------*/
45 
46 template<class CloudType>
48 :
49  public DispersionModel<CloudType>
50 {
51 public:
52 
53  //- Runtime type information
54  TypeName("none");
55 
56 
57  // Constructors
58 
59  //- Construct from components
61  (
62  const dictionary& dict,
63  CloudType& owner
64  );
65 
66 
67  //- Destructor
68  virtual ~NoDispersion();
69 
70 
71  // Member Functions
72 
73  //- Flag to indicate whether model activates injection model
74  virtual bool active() const;
75 
76  //- Cache carrier fields
77  virtual void cacheFields(const bool store);
78 
79  //- Update (disperse particles)
80  virtual vector update
81  (
82  const scalar dt,
83  const label celli,
84  const vector& U,
85  const vector& Uc,
86  vector& UTurb,
87  scalar& tTurb
88  );
89 };
90 
91 
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 
94 } // End namespace Foam
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 #ifdef NoRepository
100 #endif
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 #endif
105 
106 // ************************ vim: set sw=4 sts=4 et: ************************ //