src/lagrangian/intermediate/submodels/CloudFunctionObjects/CloudFunctionObjectList/CloudFunctionObjectList.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::CloudFunctionObjectList
  26
  27 Description
  28     List of cloud function objects
  29
  30 SourceFiles
  31     CloudFunctionObjectListI.H
  32     CloudFunctionObjectList.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef CloudFunctionObjectList_H
  37 #define CloudFunctionObjectList_H
  38
  39 #include "PtrList.H"
  40 #include "CloudFunctionObject.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                    Class CloudFunctionObjectList Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 template<class CloudType>
  52 class CloudFunctionObjectList
  53 :
  54     public PtrList<CloudFunctionObject<CloudType> >
  55 {
  56 protected:
  57
  58     // Protected Data
  59
  60         //- Reference to the owner cloud
  61         const CloudType& owner_;
  62
  63         //- Dictionary
  64         const dictionary dict_;
  65
  66
  67 public:
  68
  69     // Constructors
  70
  71         //- Null constructor
  72         CloudFunctionObjectList(CloudType& owner);
  73
  74         //- Construct from mesh
  75         CloudFunctionObjectList
  76         (
  77             CloudType& owner,
  78             const dictionary& dict,
  79             const bool readFields
  80         );
  81
  82         //- Construct copy
  83         CloudFunctionObjectList(const CloudFunctionObjectList& ppml);
  84
  85
  86     //- Destructor
  87     virtual ~CloudFunctionObjectList();
  88
  89
  90     // Member Functions
  91
  92         // Access
  93
  94             //- Return const access to the cloud owner
  95             inline const CloudType& owner() const;
  96
  97             //- Return refernce to the cloud owner
  98             inline CloudType& owner();
  99
 100             //- Return the forces dictionary
 101             inline const dictionary& dict() const;
 102
 103
 104         // Evaluation
 105
 106             //- Pre-evolve hook
 107             virtual void preEvolve();
 108
 109             //- Post-evolve hook
 110             virtual void postEvolve();
 111
 112             //- Post-move hook
 113             virtual void postMove
 114             (
 115                 const typename CloudType::parcelType& p,
 116                 const label cellI,
 117                 const scalar dt
 118             );
 119
 120             //- Post-patch hook
 121             virtual void postPatch
 122             (
 123                 const typename CloudType::parcelType& p,
 124                 const label patchI,
 125                 const label patchFaceI
 126             );
 127
 128             //- Post-face hook
 129             virtual void postFace
 130             (
 131                 const typename CloudType::parcelType& p,
 132                 const label faceI
 133             );
 134 };
 135
 136
 137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 138
 139 } // End namespace Foam
 140
 141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 142
 143 #include "CloudFunctionObjectListI.H"
 144
 145 #ifdef NoRepository
 146     #include "CloudFunctionObjectList.C"
 147 #endif
 148
 149 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 150
 151 #endif
 152
 153 // ************************************************************************* //