NoBinaryCollision.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) 2011-2016 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::NoBinaryCollision
26 
27 Description
28  No collison BinaryCollision Model
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef NoBinaryCollision_H
33 #define NoBinaryCollision_H
34 
35 #include "BinaryCollisionModel.H"
36 
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38 
39 namespace Foam
40 {
41 /*---------------------------------------------------------------------------*\
42  Class NoBinaryCollision Declaration
43 \*---------------------------------------------------------------------------*/
44 
45 template<class CloudType>
47 :
48  public BinaryCollisionModel<CloudType>
49 {
50 public:
51 
52  //- Runtime type information
53  TypeName("none");
54 
55 
56  // Constructors
57 
58  //- Construct from dictionary
60  (
61  const dictionary& dict,
63  );
64 
65 
66  //- Destructor
67  virtual ~NoBinaryCollision();
68 
69 
70  // Member Functions
71 
72  //- Flag to indicate whether model activates collision model
73  virtual bool active() const;
74 
75  //- Return the collision cross section * relative velocity product
76  virtual scalar sigmaTcR
77  (
78  const typename CloudType::parcelType& pP,
79  const typename CloudType::parcelType& pQ
80  ) const;
81 
82  //- Apply collision
83  virtual void collide
84  (
85  typename CloudType::parcelType& pP,
86  typename CloudType::parcelType& pQ
87  );
88 };
89 
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 } // End namespace Foam
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 #ifdef NoRepository
98  #include "NoBinaryCollision.C"
99 #endif
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 #endif
104 
105 // ************************************************************************* //
virtual bool active() const
Flag to indicate whether model activates collision model.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual ~NoBinaryCollision()
Destructor.
No collison BinaryCollision Model.
Templated DSMC particle collision class.
Definition: DSMCCloud.H:55
A cloud is a collection of lagrangian particles.
Definition: cloud.H:51
virtual void collide(typename CloudType::parcelType &pP, typename CloudType::parcelType &pQ)
Apply collision.
ParcelType parcelType
Type of parcel the cloud was instantiated for.
Definition: DSMCCloud.H:217
const dictionary & dict() const
Return the dictionary.
virtual scalar sigmaTcR(const typename CloudType::parcelType &pP, const typename CloudType::parcelType &pQ) const
Return the collision cross section * relative velocity product.
TypeName("none")
Runtime type information.
NoBinaryCollision(const dictionary &dict, CloudType &cloud)
Construct from dictionary.
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:68
Namespace for OpenFOAM.