src/lagrangian/intermediate/submodels/CloudFunctionObjects/VoidFraction/VoidFraction.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::VoidFraction
  26
  27 Description
  28     Creates particle void fraction field on carrier phase
  29
  30 SourceFiles
  31     VoidFraction.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef VoidFraction_H
  36 #define VoidFraction_H
  37
  38 #include "CloudFunctionObject.H"
  39 #include "volFields.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                        Class VoidFraction Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 template<class CloudType>
  51 class VoidFraction
  52 :
  53     public CloudFunctionObject<CloudType>
  54 {
  55     // Private Data
  56
  57         // Typedefs
  58
  59             //- Convenience typedef for parcel type
  60             typedef typename CloudType::parcelType parcelType;
  61
  62
  63         //- Void fraction field
  64         autoPtr<volScalarField> thetaPtr_;
  65
  66
  67 protected:
  68
  69     // Protected Member Functions
  70
  71         //- Write post-processing info
  72         virtual void write();
  73
  74
  75 public:
  76
  77     //- Runtime type information
  78     TypeName("voidFraction");
  79
  80
  81     // Constructors
  82
  83         //- Construct from dictionary
  84         VoidFraction(const dictionary& dict, CloudType& owner);
  85
  86         //- Construct copy
  87         VoidFraction(const VoidFraction<CloudType>& vf);
  88
  89         //- Construct and return a clone
  90         virtual autoPtr<CloudFunctionObject<CloudType> > clone() const
  91         {
  92             return autoPtr<CloudFunctionObject<CloudType> >
  93             (
  94                 new VoidFraction<CloudType>(*this)
  95             );
  96         }
  97
  98
  99     //- Destructor
 100     virtual ~VoidFraction();
 101
 102
 103     // Member Functions
 104
 105         // Evaluation
 106
 107             //- Pre-evolve hook
 108             virtual void preEvolve();
 109
 110             //- Post-evolve hook
 111             virtual void postEvolve();
 112
 113             //- Post-move hook
 114             virtual void postMove
 115             (
 116                 const parcelType& p,
 117                 const label cellI,
 118                 const scalar dt
 119             );
 120 };
 121
 122
 123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 124
 125 } // End namespace Foam
 126
 127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 128
 129 #ifdef NoRepository
 130 #   include "VoidFraction.C"
 131 #endif
 132
 133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 134
 135 #endif
 136
 137 // ************************************************************************* //