NoCollision.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::NoCollision
26 
27 Description
28  Place holder for 'none' option
29 
30 SourceFiles
31  NoCollision.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef NoCollision_H
36 #define NoCollision_H
37 
38 #include "CollisionModel.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class NoCollision Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 template<class CloudType>
50 class NoCollision
51 :
52  public CollisionModel<CloudType>
53 {
54 
55 public:
56 
57  //- Runtime type information
58  TypeName("none");
59 
60 
61  // Constructors
62 
63  //- Construct from components
65 
66  //- Construct copy
68 
69  //- Construct and return a clone
71  {
73  (
74  new NoCollision<CloudType>(*this)
75  );
76  }
77 
78 
79  //- Destructor
80  virtual ~NoCollision();
81 
82 
83  // Member Functions
84 
85  //- Return the number of times to subcycle the current
86  // timestep to meet the criteria of the collision model. For
87  // this model this will always be 1.
88  virtual label nSubCycles() const;
89 
90  // Collision function
91  virtual void collide();
92 };
93 
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 } // End namespace Foam
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 #ifdef NoRepository
102  #include "NoCollision.C"
103 #endif
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 #endif
108 
109 // ************************************************************************* //
const CloudType & owner() const
Return const access to the owner cloud.
Templated collision model class.
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:79
Place holder for 'none' option.
Definition: NoCollision.H:52
virtual label nSubCycles() const
Return the number of times to subcycle the current.
Definition: NoCollision.C:61
virtual autoPtr< CollisionModel< CloudType > > clone() const
Construct and return a clone.
Definition: NoCollision.H:69
TypeName("none")
Runtime type information.
NoCollision(const dictionary &dict, CloudType &owner)
Construct from components.
Definition: NoCollision.C:32
virtual ~NoCollision()
Destructor.
Definition: NoCollision.C:54
virtual void collide()
Definition: NoCollision.C:68
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:160
const dictionary & dict() const
Return const access to the cloud dictionary.
Definition: subModelBase.C:110
Namespace for OpenFOAM.
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