initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / src / turbulenceModels / incompressible / RAS / derivedFvPatchFields / turbulentHeatFluxTemperature / turbulentHeatFluxTemperatureFvPatchScalarField.H
blob848c9ca403ffbf4e1e703cfee37628efaaf762e5
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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 the
13     Free Software Foundation; either version 2 of the License, or (at your
14     option) any later version.
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.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM; if not, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 Class
26     Foam::turbulentHeatFluxTemperatureFvPatchScalarField
28 Description
29     Fixed heat flux boundary condition for temperature.
31 SourceFiles
32     turbulentHeatFluxTemperatureFvPatchScalarField.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef turbulentHeatFluxTemperatureFvPatchScalarFields_H
37 #define turbulentHeatFluxTemperatureFvPatchScalarFields_H
39 #include "fvPatchFields.H"
40 #include "fixedGradientFvPatchFields.H"
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 namespace Foam
46 namespace incompressible
49 /*---------------------------------------------------------------------------*\
50        Class turbulentHeatFluxTemperatureFvPatchScalarField Declaration
51 \*---------------------------------------------------------------------------*/
53 class turbulentHeatFluxTemperatureFvPatchScalarField
55     public fixedGradientFvPatchScalarField
57 // Private data
59     //- Heat flux [W/m2]
60     scalarField q_;
62     //- Name of effective thermal diffusivity field
63     word alphaEffName_;
65     //- Name of specific heat capacity field
66     word CpName_;
69 public:
71     //- Runtime type information
72     TypeName("turbulentHeatFluxTemperature");
75     // Constructors
77         //- Construct from patch and internal field
78         turbulentHeatFluxTemperatureFvPatchScalarField
79         (
80             const fvPatch&,
81             const DimensionedField<scalar, volMesh>&
82         );
84         //- Construct from patch, internal field and dictionary
85         turbulentHeatFluxTemperatureFvPatchScalarField
86         (
87             const fvPatch&,
88             const DimensionedField<scalar, volMesh>&,
89             const dictionary&
90         );
92         //- Construct by mapping given
93         //  turbulentHeatFluxTemperatureFvPatchScalarField onto
94         //  a new patch
95         turbulentHeatFluxTemperatureFvPatchScalarField
96         (
97             const turbulentHeatFluxTemperatureFvPatchScalarField&,
98             const fvPatch&,
99             const DimensionedField<scalar, volMesh>&,
100             const fvPatchFieldMapper&
101         );
103         //- Construct as copy
104         turbulentHeatFluxTemperatureFvPatchScalarField
105         (
106             const turbulentHeatFluxTemperatureFvPatchScalarField&
107         );
109         //- Construct and return a clone
110         virtual tmp<fvPatchScalarField> clone() const
111         {
112             return tmp<fvPatchScalarField>
113             (
114                 new turbulentHeatFluxTemperatureFvPatchScalarField(*this)
115             );
116         }
118         //- Construct as copy setting internal field reference
119         turbulentHeatFluxTemperatureFvPatchScalarField
120         (
121             const turbulentHeatFluxTemperatureFvPatchScalarField&,
122             const DimensionedField<scalar, volMesh>&
123         );
125         //- Construct and return a clone setting internal field reference
126         virtual tmp<fvPatchScalarField> clone
127         (
128             const DimensionedField<scalar, volMesh>& iF
129         ) const
130         {
131             return tmp<fvPatchScalarField>
132             (
133                 new turbulentHeatFluxTemperatureFvPatchScalarField
134                 (
135                     *this,
136                     iF
137                 )
138             );
139         }
142     // Member functions
144         // Mapping functions
146             //- Map (and resize as needed) from self given a mapping object
147             virtual void autoMap(const fvPatchFieldMapper&);
149             //- Reverse map the given fvPatchField onto this fvPatchField
150             virtual void rmap
151             (
152                 const fvPatchScalarField&,
153                 const labelList&
154             );
157         // Evaluation functions
159             //- Update the coefficients associated with the patch field
160             virtual void updateCoeffs();
163         // I-O
165             //- Write
166             virtual void write(Ostream&) const;
170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
172 } // End namespace incompressible
173 } // End namespace Foam
175 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
177 #endif
179 // ************************************************************************* //