src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/NoCollision/NoCollision.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
  24 Class
  25     Foam::NoCollision
  26
  27 Description
  28     Place holder for 'none' option
  29
  30 SourceFiles
  31     NoCollision.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef NoCollision_H
  36 #define NoCollision_H
  37
  38 #include "CollisionModel.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                         Class NoCollision Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 template<class CloudType>
  50 class NoCollision
  51 :
  52     public CollisionModel<CloudType>
  53 {
  54
  55 public:
  56
  57     //- Runtime type information
  58     TypeName("none");
  59
  60
  61     // Constructors
  62
  63         //- Construct from components
  64         NoCollision(const dictionary& dict, CloudType& owner);
  65
  66         //- Construct copy
  67         NoCollision(NoCollision<CloudType>& cm);
  68
  69         //- Construct and return a clone
  70         virtual autoPtr<CollisionModel<CloudType> > clone()
  71         {
  72             return autoPtr<CollisionModel<CloudType> >
  73             (
  74                 new NoCollision<CloudType>(*this)
  75             );
  76         }
  77
  78
  79     //- Destructor
  80     virtual ~NoCollision();
  81
  82
  83     // Member Functions
  84
  85         //- Return the number of times to subcycle the current
  86         //  timestep to meet the criteria of the collision model.  For
  87         //  this model this will always be 1.
  88         virtual label nSubCycles() const;
  89
  90         //- Flag to indicate whether model activates collision model
  91         virtual bool active() const;
  92
  93         //- Indicates whether model determines wall collisions or not,
  94         //  used to determine what value to use for wallImpactDistance
  95         virtual bool controlsWallInteraction() const;
  96
  97         // Collision function
  98         virtual void collide();
  99 };
 100
 101
 102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 103
 104 } // End namespace Foam
 105
 106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 107
 108 #ifdef NoRepository
 109 #   include "NoCollision.C"
 110 #endif
 111
 112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 113
 114 #endif
 115
 116 // ************************************************************************* //