massTransferModel.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 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::massTransferModel
26 
27 Description
28 
29 SourceFiles
30  massTransferModel.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef massTransferModel_H
35 #define massTransferModel_H
36 
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38 
39 #include "volFields.H"
40 #include "dictionary.H"
41 #include "runTimeSelectionTables.H"
42 
43 namespace Foam
44 {
45 
46 class phasePair;
47 
48 /*---------------------------------------------------------------------------*\
49  Class massTransferModel Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 {
54 protected:
55 
56  // Protected data
57 
58  //- Phase pair
59  const phasePair& pair_;
60 
61 
62 public:
63 
64  //- Runtime type information
65  TypeName("massTransferModel");
66 
67 
68  // Declare runtime construction
69 
71  (
72  autoPtr,
74  dictionary,
75  (
76  const dictionary& dict,
77  const phasePair& pair
78  ),
79  (dict, pair)
80  );
81 
82 
83  // Static data members
84 
85  //- Coefficient dimensions
86  static const dimensionSet dimK;
87 
88 
89  // Constructors
90 
91  //- Construct from a dictionary and a phase pair
93  (
94  const dictionary& dict,
95  const phasePair& pair
96  );
97 
98 
99  //- Destructor
100  virtual ~massTransferModel();
101 
102 
103  // Selectors
104 
106  (
107  const dictionary& dict,
108  const phasePair& pair
109  );
110 
111 
112  // Member Functions
113 
114  //- The implicit mass transfer coefficient
115  // Note: this has had the species mass diffusivity factored out
116  virtual tmp<volScalarField> K() const = 0;
117 };
118 
119 
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 
122 } // End namespace Foam
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 #endif
127 
128 // ************************************************************************* //
virtual tmp< volScalarField > K() const =0
The implicit mass transfer coefficient.
massTransferModel(const dictionary &dict, const phasePair &pair)
Construct from a dictionary and a phase pair.
Macros to ease declaration of run-time selection tables.
virtual ~massTransferModel()
Destructor.
static const dimensionSet dimK
Coefficient dimensions.
const phasePair & pair_
Phase pair.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
dictionary dict
Dimension set for the base types.
Definition: dimensionSet.H:116
TypeName("massTransferModel")
Runtime type information.
declareRunTimeSelectionTable(autoPtr, massTransferModel, dictionary,( const dictionary &dict, const phasePair &pair ),(dict, pair))
static autoPtr< massTransferModel > New(const dictionary &dict, const phasePair &pair)
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117
A class for managing temporary objects.
Definition: PtrList.H:118