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