src/lagrangian/dsmc/submodels/BinaryCollisionModel/VariableHardSphere/VariableHardSphere.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2009-2009 OpenCFD Ltd.
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  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>
  46 class VariableHardSphere
  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
  65         VariableHardSphere
  66         (
  67             const dictionary& dict,
  68             CloudType& cloud
  69         );
  70
  71
  72     // Destructor
  73     virtual ~VariableHardSphere();
  74
  75
  76     // Member Functions
  77
  78         //- Return the collision cross section * relative velocity product
  79         virtual scalar sigmaTcR
  80         (
  81             label typeIdP,
  82             label typeIdQ,
  83             const vector& UP,
  84             const vector& UQ
  85         ) const;
  86
  87         //- Apply collision
  88         virtual void collide
  89         (
  90             label typeIdP,
  91             label typeIdQ,
  92             vector& UP,
  93             vector& UQ,
  94             scalar& EiP,
  95             scalar& EiQ
  96         );
  97 };
  98
  99
 100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 101
 102 } // End namespace Foam
 103
 104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 105
 106 #ifdef NoRepository
 107 #   include "VariableHardSphere.C"
 108 #endif
 109
 110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 111
 112 #endif
 113
 114 // ************************************************************************* //