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