src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleTracks/ParticleTracks.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::ParticleTracks
  26
  27 Description
  28     Records particle state (all variables) on each call to postFace
  29
  30 SourceFiles
  31     ParticleTracks.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef ParticleTracks_H
  36 #define ParticleTracks_H
  37
  38 #include "CloudFunctionObject.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                        Class ParticleTracks Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 template<class CloudType>
  50 class ParticleTracks
  51 :
  52     public CloudFunctionObject<CloudType>
  53 {
  54     // Private data
  55
  56         // Typedefs
  57
  58             //- Convenience typedef for parcel type
  59             typedef typename CloudType::parcelType parcelType;
  60
  61             //- Convenience typedef for hash hit-table
  62             typedef HashTable<label, labelPair, typename labelPair::Hash<> >
  63                 hitTableType;
  64
  65         //- Number of face-hit intervals between storing parcel data
  66         label trackInterval_;
  67
  68         //- Maximum number of particles to store per track
  69         label maxSamples_;
  70
  71         //- Flag to indicate whether data should be reset/cleared on writing
  72         Switch resetOnWrite_;
  73
  74         //- Table of number of times a particle has hit a face
  75         hitTableType faceHitCounter_;
  76
  77         //- Pointer to the cloud storage
  78         autoPtr<Cloud<parcelType> > cloudPtr_;
  79
  80
  81 protected:
  82
  83     // Protected member functions
  84
  85         //- Write post-processing info
  86         void write();
  87
  88
  89 public:
  90
  91     //- Runtime type information
  92     TypeName("particleTracks");
  93
  94
  95     // Constructors
  96
  97         //- Construct from dictionary
  98         ParticleTracks(const dictionary& dict, CloudType& owner);
  99
 100         //- Construct copy
 101         ParticleTracks(const ParticleTracks<CloudType>& ppm);
 102
 103         //- Construct and return a clone
 104         virtual autoPtr<CloudFunctionObject<CloudType> > clone() const
 105         {
 106             return autoPtr<CloudFunctionObject<CloudType> >
 107             (
 108                 new ParticleTracks<CloudType>(*this)
 109             );
 110         }
 111
 112
 113     //- Destructor
 114     virtual ~ParticleTracks();
 115
 116
 117     // Member Functions
 118
 119         // Access
 120
 121             //- Return const access to the track interval
 122             inline label trackInterval() const;
 123
 124             //- Return const access to the max samples
 125             inline label maxSamples() const;
 126
 127             //- Return const access to the reset on write flag
 128             inline const Switch& resetOnWrite() const;
 129
 130             //- Rerurn the table of number of times a particle has hit a face
 131             inline const hitTableType& faceHitCounter() const;
 132
 133             //- Return const access to the cloud
 134             inline const Cloud<parcelType>& cloud() const;
 135
 136
 137         // Evaluation
 138
 139             //- Pre-evolve hook
 140             virtual void preEvolve();
 141
 142             //- Post-face hook
 143             virtual void postFace(const parcelType& p, const label faceI);
 144 };
 145
 146
 147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 148
 149 } // End namespace Foam
 150
 151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 152
 153 #include "ParticleTracksI.H"
 154
 155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 156
 157 #ifdef NoRepository
 158 #   include "ParticleTracks.C"
 159 #endif
 160
 161 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 162
 163 #endif
 164
 165 // ************************************************************************* //