Merge branch 'master' of ssh://git.code.sf.net/p/foam-extend/foam-extend-3.2
[foam-extend-3.2.git] / src / lagrangian / dsmc / submodels / BinaryCollisionModel / LarsenBorgnakkeVariableHardSphere / LarsenBorgnakkeVariableHardSphere.H
blobfcb2ff7112197611f899be0d94ed82833d9eeb08
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | foam-extend: Open Source CFD
4    \\    /   O peration     | Version:     3.2
5     \\  /    A nd           | Web:         http://www.foam-extend.org
6      \\/     M anipulation  | For copyright notice see file Copyright
7 -------------------------------------------------------------------------------
8 License
9     This file is part of foam-extend.
11     foam-extend is free software: you can redistribute it and/or modify it
12     under the terms of the GNU General Public License as published by the
13     Free Software Foundation, either version 3 of the License, or (at your
14     option) any later version.
16     foam-extend is distributed in the hope that it will be useful, but
17     WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19     General Public License for more details.
21     You should have received a copy of the GNU General Public License
22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
24 Description
25     Variable Hard Sphere BinaryCollision Model with Larsen Borgnakke internal
26     energy redistribution.  Based on the INELRS subroutine in Bird's DSMC0R.FOR
28 \*---------------------------------------------------------------------------*/
30 #ifndef LarsenBorgnakkeVariableHardSphere_H
31 #define LarsenBorgnakkeVariableHardSphere_H
33 #include "BinaryCollisionModel.H"
35 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
37 namespace Foam
39 /*---------------------------------------------------------------------------*\
40                       Class LarsenBorgnakkeVariableHardSphere Declaration
41 \*---------------------------------------------------------------------------*/
43 template<class CloudType>
44 class LarsenBorgnakkeVariableHardSphere
46     public BinaryCollisionModel<CloudType>
48     // Private data
50         //- Reference temperature
51         const scalar Tref_;
53         //- Relaxation collision number
54         const scalar relaxationCollisionNumber_;
57     // Private Member Functions
59         //- Calculate the energy ratio for distribution to internal degrees of
60         // freedom
61         scalar energyRatio
62         (
63             scalar ChiA,
64             scalar ChiB
65         );
68 public:
70     //- Runtime type information
71     TypeName("LarsenBorgnakkeVariableHardSphere");
74     // Constructors
76         //- Construct from dictionary
77         LarsenBorgnakkeVariableHardSphere
78         (
79             const dictionary& dict,
80             CloudType& cloud
81         );
84     // Destructor
85     virtual ~LarsenBorgnakkeVariableHardSphere();
88     // Member Functions
90         //- Return the collision cross section * relative velocity product
91         virtual scalar sigmaTcR
92         (
93             label typeIdP,
94             label typeIdQ,
95             const vector& UP,
96             const vector& UQ
97         ) const;
99         //- Apply collision
100         virtual void collide
101         (
102             label typeIdP,
103             label typeIdQ,
104             vector& UP,
105             vector& UQ,
106             scalar& EiP,
107             scalar& EiQ
108         );
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 } // End namespace Foam
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 #ifdef NoRepository
119 #   include "LarsenBorgnakkeVariableHardSphere.C"
120 #endif
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
124 #endif
126 // ************************************************************************* //