initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / src / turbulenceModels / incompressible / RAS / derivedFvPatchFields / wallFunctions / omegaWallFunctions / omegaWallFunction / omegaWallFunctionFvPatchScalarField.H
blobce9060de8a097c0003a4854d51983e4997e55376
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2008-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::incompressible::RASModels::omegaWallFunctionFvPatchScalarField
28 Description
29     Replaces functionality in wallFunctionsI.H
31 SourceFiles
32     omegaWallFunctionFvPatchScalarField.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef omegaWallFunctionFvPatchScalarField_H
37 #define omegaWallFunctionFvPatchScalarField_H
39 #include "fixedInternalValueFvPatchField.H"
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 namespace Foam
45 namespace incompressible
47 namespace RASModels
50 /*---------------------------------------------------------------------------*\
51            Class omegaWallFunctionFvPatchScalarField Declaration
52 \*---------------------------------------------------------------------------*/
54 class omegaWallFunctionFvPatchScalarField
56     public fixedInternalValueFvPatchField<scalar>
58     // Private data
60         //- Name of velocity field
61         word UName_;
63         //- Name of turbulence kinetic energy field
64         word kName_;
66         //- Name of turbulence generation field
67         word GName_;
69         //- Name of laminar viscosity field
70         word nuName_;
72         //- Name of turbulent viscosity field
73         word nutName_;
75         //- Cmu coefficient
76         scalar Cmu_;
78         //- Von Karman constant
79         scalar kappa_;
81         //- E coefficient
82         scalar E_;
85     // Private member functions
87         //- Check the type of the patch
88         void checkType();
91 public:
93     //- Runtime type information
94     TypeName("omegaWallFunction");
97     // Constructors
99         //- Construct from patch and internal field
100         omegaWallFunctionFvPatchScalarField
101         (
102             const fvPatch&,
103             const DimensionedField<scalar, volMesh>&
104         );
106         //- Construct from patch, internal field and dictionary
107         omegaWallFunctionFvPatchScalarField
108         (
109             const fvPatch&,
110             const DimensionedField<scalar, volMesh>&,
111             const dictionary&
112         );
114         //- Construct by mapping given
115         // omegaWallFunctionFvPatchScalarField
116         //  onto a new patch
117         omegaWallFunctionFvPatchScalarField
118         (
119             const omegaWallFunctionFvPatchScalarField&,
120             const fvPatch&,
121             const DimensionedField<scalar, volMesh>&,
122             const fvPatchFieldMapper&
123         );
125         //- Construct as copy
126         omegaWallFunctionFvPatchScalarField
127         (
128             const omegaWallFunctionFvPatchScalarField&
129         );
131         //- Construct and return a clone
132         virtual tmp<fvPatchScalarField> clone() const
133         {
134             return tmp<fvPatchScalarField>
135             (
136                 new omegaWallFunctionFvPatchScalarField(*this)
137             );
138         }
140         //- Construct as copy setting internal field reference
141         omegaWallFunctionFvPatchScalarField
142         (
143             const omegaWallFunctionFvPatchScalarField&,
144             const DimensionedField<scalar, volMesh>&
145         );
147         //- Construct and return a clone setting internal field reference
148         virtual tmp<fvPatchScalarField> clone
149         (
150             const DimensionedField<scalar, volMesh>& iF
151         ) const
152         {
153             return tmp<fvPatchScalarField>
154             (
155                 new omegaWallFunctionFvPatchScalarField(*this, iF)
156             );
157         }
160     // Member functions
162         // Evaluation functions
164             //- Update the coefficients associated with the patch field
165             virtual void updateCoeffs();
168         // I-O
170             //- Write
171             void write(Ostream&) const;
175 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
177 } // End namespace RASModels
178 } // End namespace incompressible
179 } // End namespace Foam
181 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
183 #endif
185 // ************************************************************************* //