NoSurfaceFilm.H
Go to the documentation of this file.
1/*---------------------------------------------------------------------------*\
2 ========= |
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4 \\ / O peration |
5 \\ / A nd | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011-2016 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26Class
27 Foam::NoSurfaceFilm
28
29Group
30 grpLagrangianIntermediateSurfaceFilmSubModels
31
32Description
33 Place holder for 'none' option
34
35SourceFiles
36 NoSurfaceFilm.C
37
38\*---------------------------------------------------------------------------*/
39
40#ifndef NoSurfaceFilm_H
41#define NoSurfaceFilm_H
42
43#include "SurfaceFilmModel.H"
44
45// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46
47namespace Foam
48{
49
50/*---------------------------------------------------------------------------*\
51 Class NoSurfaceFilm Declaration
52\*---------------------------------------------------------------------------*/
53
54template<class CloudType>
55class NoSurfaceFilm
56:
57 public SurfaceFilmModel<CloudType>
58{
59protected:
60
61 // Protected data
62
63 //- Convenience typedef for parcel type
64 typedef typename CloudType::parcelType parcelType;
65
66
67public:
68
69 //- Runtime type information
70 TypeName("none");
71
72
73 // Constructors
74
75 //- Construct from dictionary
77
78 //- Construct copy
80
81 //- Construct and return a clone
83 {
85 (
87 );
88 }
89
90
91 //- Destructor
92 virtual ~NoSurfaceFilm();
93
94
95 // Member Functions
96
97 // Evaluation
98
99 //- Flag to indicate whether model activates the surface film model
100 virtual bool active() const;
101
102 //- Transfer parcel from cloud to surface film
103 // Returns true if parcel is to be transferred
104 virtual bool transferParcel
105 (
106 parcelType& p,
107 const polyPatch& pp,
108 bool& keepParticle
109 );
110
111 //- Set parcel properties
112 virtual void setParcelProperties
113 (
114 parcelType& p,
115 const label filmCelli
116 ) const;
117
118
119 // I-O
120
121 //- Write surface film info to stream
122 virtual void info(Ostream& os);
123};
124
125
126// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127
128} // End namespace Foam
129
130// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131
132#ifdef NoRepository
133 #include "NoSurfaceFilm.C"
134#endif
135
136// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
137
138#endif
139
140// ************************************************************************* //
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:75
ParcelType parcelType
Type of parcel the cloud was instantiated for.
Definition: DSMCCloud.H:220
Place holder for 'none' option.
Definition: NoSurfaceFilm.H:57
virtual ~NoSurfaceFilm()
Destructor.
Definition: NoSurfaceFilm.C:57
virtual void info(Ostream &os)
Write surface film info to stream.
Definition: NoSurfaceFilm.C:92
TypeName("none")
Runtime type information.
virtual void setParcelProperties(parcelType &p, const label filmCelli) const
Set parcel properties.
Definition: NoSurfaceFilm.C:84
virtual bool active() const
Flag to indicate whether model activates the surface film model.
Definition: NoSurfaceFilm.C:64
CloudType::parcelType parcelType
Convenience typedef for parcel type.
Definition: NoSurfaceFilm.H:63
virtual autoPtr< SurfaceFilmModel< CloudType > > clone() const
Construct and return a clone.
Definition: NoSurfaceFilm.H:81
virtual bool transferParcel(parcelType &p, const polyPatch &pp, bool &keepParticle)
Transfer parcel from cloud to surface film.
Definition: NoSurfaceFilm.C:72
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:62
Templated wall surface film model class.
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: autoPtr.H:66
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
A patch is a list of labels that address the faces in the global face list.
Definition: polyPatch.H:75
volScalarField & p
OBJstream os(runTime.globalPath()/outputName)
Namespace for OpenFOAM.
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73