src/lagrangian/intermediate/submodels/Kinematic/PostProcessingModel/NoPostProcessing/NoPostProcessing.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2008-2009 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::NoPostProcessing
  27
  28 Description
  29     Place holder for 'none' option
  30
  31 SourceFiles
  32     NoPostProcessing.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef NoPostProcessing_H
  37 #define NoPostProcessing_H
  38
  39 #include "PostProcessingModel.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                       Class NoPostProcessing Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 template<class CloudType>
  51 class NoPostProcessing
  52 :
  53     public PostProcessingModel<CloudType>
  54 {
  55 protected:
  56
  57     // Protected member functions
  58
  59         //- Write post-processing info
  60         void write();
  61
  62
  63 public:
  64
  65     //- Runtime type information
  66     TypeName("none");
  67
  68
  69     // Constructors
  70
  71         //- Construct from components
  72         NoPostProcessing(const dictionary&, CloudType&);
  73
  74
  75     //- Destructor
  76     virtual ~NoPostProcessing();
  77
  78
  79     // Member Functions
  80
  81         // Evaluation
  82
  83             //- Flag to indicate whether model activates post-processing model
  84             virtual bool active() const;
  85
  86             //- Gather post-processing info on patch
  87             virtual void postPatch
  88             (
  89                 const typename CloudType::parcelType& p,
  90                 const label patchI
  91             );
  92 };
  93
  94
  95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  96
  97 } // End namespace Foam
  98
  99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 100
 101 #ifdef NoRepository
 102 #   include "NoPostProcessing.C"
 103 #endif
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 #endif
 108
 109 // ************************************************************************* //