src/lagrangian/intermediate/submodels/CloudFunctionObjects/FacePostProcessing/FacePostProcessing.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::FacePostProcessing
  26
  27 Description
  28     Records particle face quantities on used-specified face zone
  29
  30     Currently supports:
  31         accummulated mass
  32         average mass flux
  33
  34 SourceFiles
  35     FacePostProcessing.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef FacePostProcessing_H
  40 #define FacePostProcessing_H
  41
  42 #include "CloudFunctionObject.H"
  43 #include "faceZone.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                      Class FacePostProcessing Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 template<class CloudType>
  55 class FacePostProcessing
  56 :
  57     public CloudFunctionObject<CloudType>
  58 {
  59     // Private Data
  60
  61         // Typedefs
  62
  63             //- Convenience typedef for parcel type
  64             typedef typename CloudType::parcelType parcelType;
  65
  66
  67         //- Face zone IDs
  68         labelList faceZoneIDs_;
  69
  70         //- Surface output format
  71         const word surfaceFormat_;
  72
  73         //- Flag to indicate whether data should be reset/cleared on writing
  74         Switch resetOnWrite_;
  75
  76         //- Total time
  77         scalar totalTime_;
  78
  79         //- Mass storage
  80         List<scalarField> mass_;
  81
  82         //- Mass total storage
  83         List<scalarField> massTotal_;
  84
  85         //- Mass flux storage
  86         List<scalarField> massFlux_;
  87
  88         //- Flag to indicate whether data should be written to file
  89         Switch log_;
  90
  91         //- Output file pointer per zone
  92         PtrList<OFstream> outputFilePtr_;
  93
  94         //- Output directory
  95         fileName outputDir_;
  96
  97
  98     // Private Member Functions
  99
 100         //- Helper function to create log files
 101         void makeLogFile
 102         (
 103             const word& zoneName,
 104             const label zoneI,
 105             const label nFaces,
 106             const scalar totArea
 107         );
 108
 109
 110 protected:
 111
 112     // Protected Member Functions
 113
 114         //- Write post-processing info
 115         void write();
 116
 117
 118 public:
 119
 120     //- Runtime type information
 121     TypeName("facePostProcessing");
 122
 123
 124     // Constructors
 125
 126         //- Construct from dictionary
 127         FacePostProcessing(const dictionary& dict, CloudType& owner);
 128
 129         //- Construct copy
 130         FacePostProcessing(const FacePostProcessing<CloudType>& ppm);
 131
 132         //- Construct and return a clone
 133         virtual autoPtr<CloudFunctionObject<CloudType> > clone() const
 134         {
 135             return autoPtr<CloudFunctionObject<CloudType> >
 136             (
 137                 new FacePostProcessing<CloudType>(*this)
 138             );
 139         }
 140
 141
 142     //- Destructor
 143     virtual ~FacePostProcessing();
 144
 145
 146     // Member Functions
 147
 148         // Access
 149
 150             //- Return const access to the reset on write flag
 151             inline const Switch& resetOnWrite() const;
 152
 153
 154         // Evaluation
 155
 156             //- Post-face hook
 157             virtual void postFace
 158             (
 159                 const parcelType& p,
 160                 const label faceI
 161             );
 162 };
 163
 164
 165 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 166
 167 } // End namespace Foam
 168
 169 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 170
 171 #include "FacePostProcessingI.H"
 172
 173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 174
 175 #ifdef NoRepository
 176 #   include "FacePostProcessing.C"
 177 #endif
 178
 179 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 180
 181 #endif
 182
 183 // ************************************************************************* //