NoSurfaceFilm.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 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::NoSurfaceFilm
26 
27 Description
28  Place holder for 'none' option
29 
30 SourceFiles
31  NoSurfaceFilm.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef NoSurfaceFilm_H
36 #define NoSurfaceFilm_H
37 
38 #include "SurfaceFilmModel.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class NoSurfaceFilm Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 template<class CloudType>
50 class NoSurfaceFilm
51 :
52  public SurfaceFilmModel<CloudType>
53 {
54 protected:
55 
56  // Protected data
57 
58  //- Convenience typedef for parcel type
59  typedef typename CloudType::parcelType parcelType;
60 
61 
62 public:
63 
64  //- Runtime type information
65  TypeName("none");
66 
67 
68  // Constructors
69 
70  //- Construct from dictionary
72 
73  //- Construct copy
75 
76  //- Construct and return a clone
78  {
80  (
81  new NoSurfaceFilm<CloudType>(*this)
82  );
83  }
84 
85 
86  //- Destructor
87  virtual ~NoSurfaceFilm();
88 
89 
90  // Member Functions
91 
92  // Evaluation
93 
94  //- Flag to indicate whether model activates the surface film model
95  virtual bool active() const;
96 
97  //- Transfer parcel from cloud to surface film
98  // Returns true if parcel is to be transferred
99  virtual bool transferParcel
100  (
101  parcelType& p,
102  const polyPatch& pp,
103  bool& keepParticle
104  );
105 
106  //- Set parcel properties
107  virtual void setParcelProperties
108  (
109  parcelType& p,
110  const label filmCelli
111  ) const;
112 
113 
114  // I-O
115 
116  //- Write surface film info to stream
117  virtual void info(Ostream& os);
118 };
119 
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 } // End namespace Foam
124 
125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
126 
127 #ifdef NoRepository
128  #include "NoSurfaceFilm.C"
129 #endif
130 
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
132 
133 #endif
134 
135 // ************************************************************************* //
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
virtual bool transferParcel(parcelType &p, const polyPatch &pp, bool &keepParticle)
Transfer parcel from cloud to surface film.
Definition: NoSurfaceFilm.C:70
virtual autoPtr< SurfaceFilmModel< CloudType > > clone() const
Construct and return a clone.
Definition: NoSurfaceFilm.H:76
Place holder for &#39;none&#39; option.
Definition: NoSurfaceFilm.H:49
virtual void info(Ostream &os)
Write surface film info to stream.
Definition: NoSurfaceFilm.C:90
virtual ~NoSurfaceFilm()
Destructor.
Definition: NoSurfaceFilm.C:55
virtual void setParcelProperties(parcelType &p, const label filmCelli) const
Set parcel properties.
Definition: NoSurfaceFilm.C:82
ParcelType parcelType
Type of parcel the cloud was instantiated for.
Definition: DSMCCloud.H:215
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
TypeName("none")
Runtime type information.
virtual bool active() const
Flag to indicate whether model activates the surface film model.
Definition: NoSurfaceFilm.C:62
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
volScalarField & p
A patch is a list of labels that address the faces in the global face list.
Definition: polyPatch.H:66
CloudType::parcelType parcelType
Convenience typedef for parcel type.
Definition: NoSurfaceFilm.H:58
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:69
NoSurfaceFilm(const dictionary &, CloudType &)
Construct from dictionary.
Definition: NoSurfaceFilm.C:33
Namespace for OpenFOAM.