VoFPatchTransfer.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) 2017-2019 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::VoFPatchTransfer
26 
27 Description
28  Transfer mass between the film and the VoF in the continuous phase.
29 
30 SourceFiles
31  VoFPatchTransfer.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef VoFPatchTransfer_H
36 #define VoFPatchTransfer_H
37 
38 #include "transferModel.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace regionModels
45 {
46 namespace surfaceFilmModels
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class VoFPatchTransfer Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class VoFPatchTransfer
54 :
55  public transferModel
56 {
57 protected:
58 
59  //- Factor of the cell height above which the film is transferred
60  // to the VoF
61  scalar deltaFactorToVoF_;
62 
63  //- Factor of the cell height below which the VoF may be transferred
64  // to the film
65  scalar deltaFactorToFilm_;
66 
67  //- VoF limit above which all of the film is transferred to the VoF
68  scalar alphaToVoF_;
69 
70  //- VoF limit below which the VoF may be transferred to the film
71  scalar alphaToFilm_;
72 
73  //- Transfer rate coefficient
74  scalar transferRateCoeff_;
75 
76  //- List of patch IDs at which the film is removed
78 
79  //- Transferred mass for each patch at which the film is removed
81 
82 
83 public:
84 
85  //- Runtime type information
86  TypeName("VoFPatchTransfer");
87 
88 
89  // Constructors
90 
91  //- Construct from surface film model
93 
94  //- Disallow default bitwise copy construction
95  VoFPatchTransfer(const VoFPatchTransfer&) = delete;
96 
97 
98  //- Destructor
99  virtual ~VoFPatchTransfer();
100 
101 
102  // Member Functions
103 
104  //- Correct
105  virtual void correct
106  (
107  scalarField& availableMass,
108  scalarField& massToTransfer
109  );
110 
111  //- Correct kinematic and thermodynamic transfers
112  virtual void correct
113  (
114  scalarField& availableMass,
115  scalarField& massToTransfer,
116  scalarField& energyToTransfer
117  );
118 
119  //- Accumulate the total mass injected for the patches into the
120  // scalarField provided
121  virtual void patchTransferredMassTotals
122  (
123  scalarField& patchMasses
124  ) const;
125 
126 
127  // Member Operators
128 
129  //- Disallow default bitwise assignment
130  void operator=(const VoFPatchTransfer&) = delete;
131 };
132 
133 
134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
135 
136 } // End namespace surfaceFilmModels
137 } // End namespace regionModels
138 } // End namespace Foam
139 
140 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
141 
142 #endif
143 
144 // ************************************************************************* //
virtual void patchTransferredMassTotals(scalarField &patchMasses) const
Accumulate the total mass injected for the patches into the.
scalarField patchTransferredMasses_
Transferred mass for each patch at which the film is removed.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
labelList patchIDs_
List of patch IDs at which the film is removed.
Base class for film transfer models, handling mass transfer between the film and the continuous phase...
Definition: transferModel.H:56
scalar alphaToFilm_
VoF limit below which the VoF may be transferred to the film.
void operator=(const VoFPatchTransfer &)=delete
Disallow default bitwise assignment.
Transfer mass between the film and the VoF in the continuous phase.
const dictionary & dict() const
Return const access to the cloud dictionary.
Definition: subModelBase.C:110
VoFPatchTransfer(surfaceFilmRegionModel &film, const dictionary &dict)
Construct from surface film model.
const surfaceFilmRegionModel & film() const
Return const access to the film surface film model.
scalar deltaFactorToVoF_
Factor of the cell height above which the film is transferred.
scalar transferRateCoeff_
Transfer rate coefficient.
scalar alphaToVoF_
VoF limit above which all of the film is transferred to the VoF.
TypeName("VoFPatchTransfer")
Runtime type information.
Namespace for OpenFOAM.
scalar deltaFactorToFilm_
Factor of the cell height below which the VoF may be transferred.