All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
transferModelList.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::transferModelList
26 
27 Description
28  List container for film transfer models
29 
30 SourceFiles
31  transferModelList.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef transferModelList_H
36 #define transferModelList_H
37 
38 #include "PtrList.H"
39 #include "transferModel.H"
40 #include "filmSubModelBase.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace regionModels
47 {
48 namespace surfaceFilmModels
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class transferModelList Declaration
53 \*---------------------------------------------------------------------------*/
54 
56 :
57  public PtrList<transferModel>,
58  public filmSubModelBase
59 {
60  // Private Data
61 
62  //- List of mass transferred per patch
63  scalarField massTransferred_;
64 
65 
66 public:
67 
68  // Constructors
69 
70  //- Construct null
72 
73  //- Construct from type name, dictionary and surface film model
75  (
77  const dictionary& dict
78  );
79 
80  //- Disallow default bitwise copy construction
81  transferModelList(const transferModelList&) = delete;
82 
83 
84  //- Destructor
85  virtual ~transferModelList();
86 
87 
88  // Member Functions
89 
90  //- Correct kinematic transfers
91  virtual void correct
92  (
93  scalarField& availableMass,
94  volScalarField& massToTransfer
95  );
96 
97  //- Correct kinematic and thermodynamic transfers
98  virtual void correct
99  (
100  scalarField& availableMass,
101  volScalarField& massToTransfer,
102  volScalarField& energyToTransfer
103  );
104 
105  //- Provide some info
106  virtual void info(Ostream& os);
107 
108 
109  // Member Operators
110 
111  //- Disallow default bitwise assignment
112  void operator=(const transferModelList&) = delete;
113 };
114 
115 
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 
118 } // End namespace surfaceFilmModels
119 } // End namespace regionModels
120 } // End namespace Foam
121 
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123 
124 #endif
125 
126 // ************************************************************************* //
Base class for surface film sub-models.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
void operator=(const transferModelList &)=delete
Disallow default bitwise assignment.
const dictionary & dict() const
Return const access to the cloud dictionary.
Definition: subModelBase.C:110
const surfaceFilmRegionModel & film() const
Return const access to the film surface film model.
virtual void correct(scalarField &availableMass, volScalarField &massToTransfer)
Correct kinematic transfers.
transferModelList(surfaceFilmRegionModel &film)
Construct null.
List container for film transfer models.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
virtual void info(Ostream &os)
Provide some info.
A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used...
Definition: List.H:70
Namespace for OpenFOAM.