ENH: autoLayerDriver: better layering information message
[OpenFOAM-2.0.x.git] / src / turbulenceModels / compressible / turbulenceModel / derivedFvPatchFields / turbulentTemperatureCoupledBaffle / turbulentTemperatureCoupledBaffleFvPatchScalarField.H
blobe3a19153ecf9d3a2192a41962c75eff009142b57
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
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
13     the Free Software Foundation, either version 3 of the License, or
14     (at your 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, see <http://www.gnu.org/licenses/>.
24 Class
25     turbulentTemperatureCoupledBaffleFvPatchScalarField
27 Description
28     Harmonic fixed value boundary condition for temperature, to be used
29     for heat-transfer on back-to-back baffles.
31     If my temperature is T1, heat conductivity K1 and neighbour is T2,K2
33     both sides get fixedValue (K1/dx1*T1 + K2/dx2*T2)/(K1/dx1+K2/dx2)
35     Example usage:
36         myInterfacePatchName
37         {
38             type    compressible::turbulentTemperatureCoupledBaffle;
39             neighbourFieldName  T;
40             K                   lookup;
41             KName               K; // or none
42             value               uniform 300;
43         }
45     Needs to be on underlying directMapped(Wall)FvPatch.
47     Note: see temperatureCoupledBase on ways to specify K.
49     Note: runs in parallel with arbitrary decomposition. Uses directMapped
50     functionality to calculate exchange.
52     Note: lags interface data so both sides use same data.
53     - problem: schedule to calculate average would interfere
54     with standard processor swaps.
55     - so: updateCoeffs sets both to same Twall. Only need to do
56     this for last outer iteration but don't have access to this.
58 SourceFiles
59     turbulentTemperatureCoupledBaffleFvPatchScalarField.C
61 \*---------------------------------------------------------------------------*/
63 #ifndef turbulentTemperatureCoupledBaffleFvPatchScalarField_H
64 #define turbulentTemperatureCoupledBaffleFvPatchScalarField_H
66 #include "fixedValueFvPatchFields.H"
67 #include "temperatureCoupledBase.H"
69 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
71 namespace Foam
74 /*---------------------------------------------------------------------------*\
75         Class turbulentTemperatureCoupledBaffleFvPatchScalarField Declaration
76 \*---------------------------------------------------------------------------*/
78 class turbulentTemperatureCoupledBaffleFvPatchScalarField
80     public fixedValueFvPatchScalarField,
81     public temperatureCoupledBase
83     // Private data
85         //- Name of field on the neighbour region
86         const word neighbourFieldName_;
89     // Private Member Functions
91         //- Am I or neighbour owner of interface
92         bool interfaceOwner(const polyMesh&, const polyPatch&) const;
95 public:
97     //- Runtime type information
98     TypeName("compressible::turbulentTemperatureCoupledBaffle");
101     // Constructors
103         //- Construct from patch and internal field
104         turbulentTemperatureCoupledBaffleFvPatchScalarField
105         (
106             const fvPatch&,
107             const DimensionedField<scalar, volMesh>&
108         );
110         //- Construct from patch, internal field and dictionary
111         turbulentTemperatureCoupledBaffleFvPatchScalarField
112         (
113             const fvPatch&,
114             const DimensionedField<scalar, volMesh>&,
115             const dictionary&
116         );
118         //- Construct by mapping given
119         //  turbulentTemperatureCoupledBaffleFvPatchScalarField onto a new patch
120         turbulentTemperatureCoupledBaffleFvPatchScalarField
121         (
122             const turbulentTemperatureCoupledBaffleFvPatchScalarField&,
123             const fvPatch&,
124             const DimensionedField<scalar, volMesh>&,
125             const fvPatchFieldMapper&
126         );
128         //- Construct and return a clone
129         virtual tmp<fvPatchScalarField> clone() const
130         {
131             return tmp<fvPatchScalarField>
132             (
133                 new turbulentTemperatureCoupledBaffleFvPatchScalarField(*this)
134             );
135         }
137         //- Construct as copy setting internal field reference
138         turbulentTemperatureCoupledBaffleFvPatchScalarField
139         (
140             const turbulentTemperatureCoupledBaffleFvPatchScalarField&,
141             const DimensionedField<scalar, volMesh>&
142         );
144         //- Construct and return a clone setting internal field reference
145         virtual tmp<fvPatchScalarField> clone
146         (
147             const DimensionedField<scalar, volMesh>& iF
148         ) const
149         {
150             return tmp<fvPatchScalarField>
151             (
152                 new turbulentTemperatureCoupledBaffleFvPatchScalarField
153                 (
154                     *this,
155                     iF
156                 )
157             );
158         }
161     // Member functions
163         //- Update the coefficients associated with the patch field
164         virtual void updateCoeffs();
166         //- Write
167         virtual void write(Ostream&) const;
171 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
173 } // End namespace Foam
175 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
177 #endif
179 // ************************************************************************* //