src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/NoInteraction/NoInteraction.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::NoInteraction
  26
  27 Description
  28     Dummy class for 'none' option - will raise an error if any functions are
  29     called that require return values.
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef NoInteraction_H
  34 #define NoInteraction_H
  35
  36 #include "PatchInteractionModel.H"
  37
  38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  39
  40 namespace Foam
  41 {
  42 /*---------------------------------------------------------------------------*\
  43                        Class NoInteraction Declaration
  44 \*---------------------------------------------------------------------------*/
  45
  46 template<class CloudType>
  47 class NoInteraction
  48 :
  49     public PatchInteractionModel<CloudType>
  50 {
  51 public:
  52
  53     //- Runtime type information
  54     TypeName("none");
  55
  56
  57     // Constructors
  58
  59         //- Construct from dictionary
  60         NoInteraction(const dictionary& dict, CloudType& cloud);
  61
  62         //- Construct copy
  63         NoInteraction(const NoInteraction<CloudType>& pim);
  64
  65         //- Construct and return a clone
  66         virtual autoPtr<PatchInteractionModel<CloudType> > clone() const
  67         {
  68             return autoPtr<PatchInteractionModel<CloudType> >
  69             (
  70                 new NoInteraction<CloudType>(*this)
  71             );
  72         }
  73
  74
  75     //- Destructor
  76     virtual ~NoInteraction();
  77
  78
  79     // Member Functions
  80
  81         //- Flag to indicate whether model activates patch interaction model
  82         virtual bool active() const;
  83
  84         //- Apply velocity correction
  85         //  Returns true if particle remains in same cell
  86         virtual bool correct
  87         (
  88             typename CloudType::parcelType& p,
  89             const polyPatch& pp,
  90             bool& keepParticle,
  91             const scalar trackFraction,
  92             const tetIndices& tetIs
  93         );
  94 };
  95
  96
  97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  98
  99 } // End namespace Foam
 100
 101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 102
 103 #ifdef NoRepository
 104 #   include "NoInteraction.C"
 105 #endif
 106
 107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 108
 109 #endif
 110
 111 // ************************************************************************* //