conductivityModel.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-2018 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::kineticTheoryModels::conductivityModel
28 
29 SourceFiles
30  conductivityModel.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef conductivityModel_H
35 #define conductivityModel_H
36 
37 #include "dictionary.H"
38 #include "volFields.H"
39 #include "dimensionedTypes.H"
40 #include "runTimeSelectionTables.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace kineticTheoryModels
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class conductivityModel Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 {
55  // Private member functions
56 
57  //- Disallow default bitwise copy construct
59 
60  //- Disallow default bitwise assignment
61  void operator=(const conductivityModel&);
62 
63 
64 protected:
65 
66  // Protected data
67 
68  const dictionary& dict_;
69 
70 
71 public:
72 
73  //- Runtime type information
74  TypeName("conductivityModel");
75 
76  // Declare runtime constructor selection table
78  (
79  autoPtr,
81  dictionary,
82  (
83  const dictionary& dict
84  ),
85  (dict)
86  );
87 
88 
89  // Constructors
90 
91  //- Construct from components
93 
94 
95  // Selectors
96 
98  (
99  const dictionary& dict
100  );
101 
102 
103  //- Destructor
104  virtual ~conductivityModel();
105 
106 
107  // Member Functions
108 
109  virtual tmp<volScalarField> kappa
110  (
111  const volScalarField& alpha1,
112  const volScalarField& Theta,
113  const volScalarField& g0,
114  const volScalarField& rho1,
115  const volScalarField& da,
116  const dimensionedScalar& e
117  ) const = 0;
118 
119  virtual bool read()
120  {
121  return true;
122  }
123 };
124 
125 
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127 
128 } // End namespace kineticTheoryModels
129 } // End namespace Foam
130 
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
132 
133 #endif
134 
135 // ************************************************************************* //
volFields.H
Foam::kineticTheoryModels::conductivityModel::dict_
const dictionary & dict_
Definition: conductivityModel.H:67
Foam::kineticTheoryModels::conductivityModel::~conductivityModel
virtual ~conductivityModel()
Destructor.
Definition: conductivityModel.C:56
Foam::tmp< volScalarField >
alpha1
const volScalarField & alpha1
Definition: setRegionFluidFields.H:8
Foam::kineticTheoryModels::conductivityModel::TypeName
TypeName("conductivityModel")
Runtime type information.
Foam::kineticTheoryModels::conductivityModel::declareRunTimeSelectionTable
declareRunTimeSelectionTable(autoPtr, conductivityModel, dictionary,(const dictionary &dict),(dict))
Foam::kineticTheoryModels::conductivityModel::read
virtual bool read()
Definition: conductivityModel.H:118
Foam::kineticTheoryModels::conductivityModel::kappa
virtual tmp< volScalarField > kappa(const volScalarField &alpha1, const volScalarField &Theta, const volScalarField &g0, const volScalarField &rho1, const volScalarField &da, const dimensionedScalar &e) const =0
rho1
volScalarField & rho1
Definition: setRegionFluidFields.H:27
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam::dimensioned< scalar >
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::kineticTheoryModels::conductivityModel::New
static autoPtr< conductivityModel > New(const dictionary &dict)
Definition: newConductivityModel.C:35
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
runTimeSelectionTables.H
Macros to ease declaration of run-time selection tables.
Foam::kineticTheoryModels::conductivityModel
Definition: conductivityModel.H:52
Foam::constant::electromagnetic::e
const dimensionedScalar e
Elementary charge.
Definition: createFields.H:11
dictionary.H
dimensionedTypes.H
Foam::GeometricField< scalar, fvPatchField, volMesh >