injectionModelList.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-2017 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
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 
26 Class
27  Foam::regionModels::surfaceFilmModels::injectionModelList
28 
29 Description
30  List container for film injection models
31 
32 SourceFiles
33  injectionModelList.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef injectionModelList_H
38 #define injectionModelList_H
39 
40 #include "PtrList.H"
41 #include "injectionModel.H"
42 #include "filmSubModelBase.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 namespace regionModels
49 {
50 namespace surfaceFilmModels
51 {
52 
53 /*---------------------------------------------------------------------------*\
54  Class injectionModelList Declaration
55 \*---------------------------------------------------------------------------*/
56 
58 :
59  public PtrList<injectionModel>,
60  public filmSubModelBase
61 {
62 private:
63 
64  // Private data
65 
66  //- List of mass injected per patch
67  scalarField massInjected_;
68 
69 
70  // Private Member Functions
71 
72  //- No copy construct
73  injectionModelList(const injectionModelList&) = delete;
74 
75  //- No copy assignment
76  void operator=(const injectionModelList&) = delete;
77 
78 
79 public:
80 
81  // Constructors
82 
83  //- Construct null
85 
86  //- Construct from type name, dictionary and surface film model
88  (
90  const dictionary& dict
91  );
92 
93 
94  //- Destructor
95  virtual ~injectionModelList();
96 
97 
98  // Member Functions
99 
100  // Evolution
101 
102  //- Correct
103  virtual void correct
104  (
105  scalarField& availableMass,
106  volScalarField& massToInject,
107  volScalarField& diameterToInject
108  );
109 
110 
111  // I-O
112 
113  //- Provide some info
114  virtual void info(Ostream& os);
115 };
116 
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 } // End namespace surfaceFilmModels
121 } // End namespace regionModels
122 } // End namespace Foam
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 #endif
127 
128 // ************************************************************************* //
Foam::regionModels::surfaceFilmModels::injectionModelList::info
virtual void info(Ostream &os)
Provide some info.
Definition: injectionModelList.C:126
Foam::regionModels::surfaceFilmModels::filmSubModelBase::film
const surfaceFilmRegionModel & film() const
Return const access to the film surface film model.
Definition: filmSubModelBaseI.H:39
Foam::Field< scalar >
Foam::regionModels::surfaceFilmModels::surfaceFilmRegionModel
Base class for surface film models.
Definition: surfaceFilmRegionModel.H:55
Foam::subModelBase::dict
const dictionary & dict() const
Return const access to the cloud dictionary.
Definition: subModelBase.C:113
Foam::PtrList
A list of pointers to objects of type <T>, with allocation/deallocation management of the pointers....
Definition: List.H:59
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
os
OBJstream os(runTime.globalPath()/outputName)
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::regionModels::surfaceFilmModels::injectionModelList
List container for film injection models.
Definition: injectionModelList.H:56
Foam::regionModels::surfaceFilmModels::injectionModelList::correct
virtual void correct(scalarField &availableMass, volScalarField &massToInject, volScalarField &diameterToInject)
Correct.
Definition: injectionModelList.C:98
PtrList.H
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
Foam::GeometricField< scalar, fvPatchField, volMesh >
Foam::regionModels::surfaceFilmModels::filmSubModelBase
Base class for surface film sub-models.
Definition: filmSubModelBase.H:56
Foam::regionModels::surfaceFilmModels::injectionModelList::~injectionModelList
virtual ~injectionModelList()
Destructor.
Definition: injectionModelList.C:91