temperatureCoupledBase.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) 2011-2020 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::temperatureCoupledBase
26 
27 Description
28  Common functions used in temperature coupled boundaries.
29 
30  The thermal conductivity \c kappa is obtained from the region fluidThermo
31  or solidThermo as appropriate.
32 
33  For turbulent fluid regions \c kappa is obtained from the
34  thermophysicalTransportModel \c kappaEff.
35 
36  For solid regions kappa may be obtained from the anisotropic alpha field
37  by specifying the optional \c alphaAni field name.
38 
39  \par Keywords provided by this class:
40  \table
41  Property | Description | Required | Default value
42  alphaAni | Name of the non-isotropic alpha | no |
43  \endtable
44 
45 SourceFiles
46  temperatureCoupledBase.C
47 
48 \*---------------------------------------------------------------------------*/
49 
50 #ifndef temperatureCoupledBase_H
51 #define temperatureCoupledBase_H
52 
53 #include "scalarField.H"
54 #include "NamedEnum.H"
55 #include "fvPatch.H"
56 
57 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
58 
59 namespace Foam
60 {
61 
62 /*---------------------------------------------------------------------------*\
63  Class temperatureCoupledBase Declaration
64 \*---------------------------------------------------------------------------*/
65 
66 class temperatureCoupledBase
67 {
68  // Private data
69 
70  //- Underlying patch
71  const fvPatch& patch_;
72 
73  //- Name of the optional anisotropic alpha for solid conductivity
74  // This field is read and used if available
75  const word alphaAniName_;
76 
77 
78 public:
79 
80  // Constructors
81 
82  //- Construct from patch
84  (
85  const fvPatch& patch
86  );
87 
88  //- Construct from patch and dictionary
90  (
91  const fvPatch& patch,
92  const dictionary& dict
93  );
94 
95  //- Construct from patch and temperatureCoupledBase
97  (
98  const fvPatch& patch,
99  const temperatureCoupledBase& base
100  );
101 
102 
103  // Member Functions
104 
105  //- Given patch temperature calculate corresponding K field
106  tmp<scalarField> kappa(const fvPatchScalarField& Tp) const;
107 
108  //- Write
109  void write(Ostream&) const;
110 };
111 
112 
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 
115 } // End namespace Foam
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 #endif
120 
121 // ************************************************************************* //
dictionary dict
temperatureCoupledBase(const fvPatch &patch)
Construct from patch.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:66
A class for handling words, derived from string.
Definition: word.H:59
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
Common functions used in temperature coupled boundaries.
tmp< scalarField > kappa(const fvPatchScalarField &Tp) const
Given patch temperature calculate corresponding K field.
A class for managing temporary objects.
Definition: PtrList.H:53
void write(Ostream &) const
Write.
Namespace for OpenFOAM.