NoStochasticCollision.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-2018 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::NoStochasticCollision
26 
27 Description
28  Dummy collision model for 'none'
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef NoStochasticCollision_H
33 #define NoStochasticCollision_H
34 
36 
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38 
39 namespace Foam
40 {
41 /*---------------------------------------------------------------------------*\
42  Class NoStochasticCollision Declaration
43 \*---------------------------------------------------------------------------*/
44 
45 template<class CloudType>
47 :
48  public StochasticCollisionModel<CloudType>
49 {
50 protected:
51 
52  // Protected Member Functions
53 
54  //- Update the model
55  virtual void collide
56  (
57  typename CloudType::parcelType::trackingData& td,
58  const scalar dt
59  );
60 
61 
62 public:
63 
64  //- Runtime type information
65  TypeName("none");
66 
67 
68  // Constructors
69 
70  //- Construct from dictionary
72 
73  //- Construct copy
75 
76  //- Construct and return a clone
78  {
80  (
82  );
83  }
84 
85 
86  //- Destructor
87  virtual ~NoStochasticCollision();
88 
89 
90  // Member Functions
91 
92  //- Flag to indicate whether model activates collision model
93  virtual bool active() const;
94 };
95 
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 } // End namespace Foam
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 #ifdef NoRepository
104  #include "NoStochasticCollision.C"
105 #endif
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 #endif
110 
111 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
virtual autoPtr< StochasticCollisionModel< CloudType > > clone() const
Construct and return a clone.
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 bool active() const
Flag to indicate whether model activates collision model.
virtual ~NoStochasticCollision()
Destructor.
NoStochasticCollision(const dictionary &dict, CloudType &owner)
Construct from dictionary.
Templated stochastic collision model class.
TypeName("none")
Runtime type information.
Dummy collision model for &#39;none&#39;.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:69
virtual void collide(typename CloudType::parcelType::trackingData &td, const scalar dt)
Update the model.
Namespace for OpenFOAM.