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