patchInjection.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 | Copyright (C) 2015-2016 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::regionModels::surfaceFilmModels::patchInjection
26 
27 Description
28  Remove and inject the mass in the film as it passes over the selected
29  patches.
30 
31 SourceFiles
32  patchInjection.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef patchInjection_H
37 #define patchInjection_H
38 
39 #include "injectionModel.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 namespace regionModels
46 {
47 namespace surfaceFilmModels
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class patchInjection Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 class patchInjection
55 :
56  public injectionModel
57 {
58  // Private member functions
59 
60  //- Disallow default bitwise copy construct
62 
63  //- Disallow default bitwise assignment
64  void operator=(const patchInjection&);
65 
66 
67 protected:
68 
69  //- Stable film thickness - mass only removed if thickness execeeds
70  // this threhold value
71  scalar deltaStable_;
72 
73  //- List of patch IDs at which the film is removed
75 
76  //- Injected mass for each patch at which the film is removed
78 
79 
80 public:
81 
82  //- Runtime type information
83  TypeName("patchInjection");
84 
85 
86  // Constructors
87 
88  //- Construct from surface film model
90 
91 
92  //- Destructor
93  virtual ~patchInjection();
94 
95 
96  // Member Functions
97 
98  //- Correct
99  virtual void correct
100  (
101  scalarField& availableMass,
102  scalarField& massToInject,
103  scalarField& diameterToInject
104  );
105 
106  //- Accumulate the total mass injected for the patches into the
107  // scalarField provided
108  virtual void patchInjectedMassTotals
109  (
110  scalarField& patchMasses
111  ) const;
112 };
113 
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 } // End namespace surfaceFilmModels
118 } // End namespace regionModels
119 } // End namespace Foam
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 #endif
124 
125 // ************************************************************************* //
const dictionary & dict() const
Return const access to the cloud dictionary.
Definition: subModelBase.C:110
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
scalarField patchInjectedMasses_
Injected mass for each patch at which the film is removed.
Remove and inject the mass in the film as it passes over the selected patches.
virtual void patchInjectedMassTotals(scalarField &patchMasses) const
Accumulate the total mass injected for the patches into the.
labelList patchIDs_
List of patch IDs at which the film is removed.
TypeName("patchInjection")
Runtime type information.
scalar deltaStable_
Stable film thickness - mass only removed if thickness execeeds.
Base class for film injection models, handling mass transfer from the film.
const surfaceFilmModel & owner() const
Return const access to the owner surface film model.
Namespace for OpenFOAM.