src/lagrangian/intermediate/submodels/Kinematic/DragModel/NoDrag/NoDrag.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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
  25 Class
  26     Foam::NoDrag
  27
  28 Description
  29     Dummy drag model for 'no drag'
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef NoDrag_H
  34 #define NoDrag_H
  35
  36 #include "DragModel.H"
  37
  38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  39
  40 namespace Foam
  41 {
  42 /*---------------------------------------------------------------------------*\
  43                             Class NoDrag Declaration
  44 \*---------------------------------------------------------------------------*/
  45
  46 template<class CloudType>
  47 class NoDrag
  48 :
  49     public DragModel<CloudType>
  50 {
  51
  52 public:
  53
  54     //- Runtime type information
  55     TypeName("NoDrag");
  56
  57
  58     // Constructors
  59
  60         //- Construct from dictionary
  61         NoDrag
  62         (
  63             const dictionary& dict,
  64             CloudType& owner
  65         );
  66
  67
  68     // Destructor
  69
  70         ~NoDrag();
  71
  72
  73     // Member Functions
  74
  75         //- Flag to indicate whether model activates drag model
  76         bool active() const;
  77
  78         //- Return drag coefficient
  79         scalar Cd(const scalar) const;
  80 };
  81
  82
  83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  84
  85 } // End namespace Foam
  86
  87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  88
  89 #ifdef NoRepository
  90 #   include "NoDrag.C"
  91 #endif
  92
  93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  94
  95 #endif
  96
  97 // ************************************************************************* //