NoDispersion.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) 2011-2020 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::NoDispersion
26 
27 Description
28  Place holder for 'none' option
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef NoDispersion_H
33 #define NoDispersion_H
34 
35 #include "DispersionModel.H"
36 
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38 
39 namespace Foam
40 {
41 
42 /*---------------------------------------------------------------------------*\
43  Class NoDispersion Declaration
44 \*---------------------------------------------------------------------------*/
45 
46 template<class CloudType>
47 class NoDispersion
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  //- Construct copy
64 
65  //- Construct and return a clone
67  {
69  (
70  new NoDispersion<CloudType>(*this)
71  );
72  }
73 
74 
75  //- Destructor
76  virtual ~NoDispersion();
77 
78 
79  // Member Functions
80 
81  //- Update (disperse particles)
82  virtual vector update
83  (
84  const scalar dt,
85  const label celli,
86  const vector& U,
87  const vector& Uc,
88  vector& UTurb,
89  scalar& tTurb
90  );
91 };
92 
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 
96 } // End namespace Foam
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 #ifdef NoRepository
101  #include "NoDispersion.C"
102 #endif
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 #endif
107 
108 // ************************************************************************* //
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
const dictionary & dict() const
Return const access to the cloud dictionary.
Definition: subModelBase.C:110
const CloudType & owner() const
Return const access to the owner cloud.
virtual vector update(const scalar dt, const label celli, const vector &U, const vector &Uc, vector &UTurb, scalar &tTurb)
Update (disperse particles)
Definition: NoDispersion.C:55
virtual ~NoDispersion()
Destructor.
Definition: NoDispersion.C:47
virtual autoPtr< DispersionModel< CloudType > > clone() const
Construct and return a clone.
Definition: NoDispersion.H:65
NoDispersion(const dictionary &dict, CloudType &owner)
Construct from components.
Definition: NoDispersion.C:31
U
Definition: pEqn.H:72
TypeName("none")
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:52
Place holder for &#39;none&#39; option.
Definition: NoDispersion.H:46
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:75
Namespace for OpenFOAM.