nutkRoughWallFunctionFvPatchScalarField.H 5.58 KB
Newer Older
1
2
3
4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
5
    \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
6
7
8
9
10
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

11
12
13
14
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
15
16
17
18
19
20
21

    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.

    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::incompressible::RASModels::nutkRoughWallFunctionFvPatchScalarField
26
27
28

Description
    Boundary condition for turbulent (kinematic) viscosity when using wall
29
    functions for rough walls, based on turbulence kinetic energy.
30
31
32
33
34
35
36
37

    Manipulates the E parameter to account for roughness effects, based on
    KsPlus.

    - roughness height = sand-grain roughness (0 for smooth walls)
    - roughness constant = 0.5-1.0 (0.5 default)

SourceFiles
38
    nutkRoughWallFunctionFvPatchScalarField.C
39
40
41

\*---------------------------------------------------------------------------*/

42
43
#ifndef nutkRoughWallFunctionFvPatchScalarField_H
#define nutkRoughWallFunctionFvPatchScalarField_H
44

45
#include "nutkWallFunctionFvPatchScalarField.H"
46
47
48
49
50
51
52
53
54
55
56

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{
namespace incompressible
{
namespace RASModels
{

/*---------------------------------------------------------------------------*\
57
           Class nutkRoughWallFunctionFvPatchScalarField Declaration
58
59
\*---------------------------------------------------------------------------*/

60
class nutkRoughWallFunctionFvPatchScalarField
61
:
62
    public nutkWallFunctionFvPatchScalarField
63
{
64
protected:
65

66
    // Protected data
67

68
69
70
71
72
73
74
        //- Roughness height
        scalarField Ks_;

        //- Roughness constant
        scalarField Cs_;


75
    // Protected Member Functions
76
77

        //- Compute the roughness function
78
79
80
81
        virtual scalar fnRough(const scalar KsPlus, const scalar Cs) const;

        //- Calculate the turbulence viscosity
        virtual tmp<scalarField> calcNut() const;
82
83
84
85
86


public:

    //- Runtime type information
87
    TypeName("nutkRoughWallFunction");
88
89
90
91
92


    // Constructors

        //- Construct from patch and internal field
93
        nutkRoughWallFunctionFvPatchScalarField
94
95
96
97
98
99
        (
            const fvPatch&,
            const DimensionedField<scalar, volMesh>&
        );

        //- Construct from patch, internal field and dictionary
100
        nutkRoughWallFunctionFvPatchScalarField
101
102
103
104
105
106
107
        (
            const fvPatch&,
            const DimensionedField<scalar, volMesh>&,
            const dictionary&
        );

        //- Construct by mapping given
108
        //  nutkRoughWallFunctionFvPatchScalarField
109
        //  onto a new patch
110
        nutkRoughWallFunctionFvPatchScalarField
111
        (
112
            const nutkRoughWallFunctionFvPatchScalarField&,
113
114
115
116
117
118
            const fvPatch&,
            const DimensionedField<scalar, volMesh>&,
            const fvPatchFieldMapper&
        );

        //- Construct as copy
119
        nutkRoughWallFunctionFvPatchScalarField
120
        (
121
            const nutkRoughWallFunctionFvPatchScalarField&
122
123
124
125
126
127
128
        );

        //- Construct and return a clone
        virtual tmp<fvPatchScalarField> clone() const
        {
            return tmp<fvPatchScalarField>
            (
129
                new nutkRoughWallFunctionFvPatchScalarField(*this)
130
131
132
133
            );
        }

        //- Construct as copy setting internal field reference
134
        nutkRoughWallFunctionFvPatchScalarField
135
        (
136
            const nutkRoughWallFunctionFvPatchScalarField&,
137
138
139
140
141
142
143
144
145
146
147
            const DimensionedField<scalar, volMesh>&
        );

        //- Construct and return a clone setting internal field reference
        virtual tmp<fvPatchScalarField> clone
        (
            const DimensionedField<scalar, volMesh>& iF
        ) const
        {
            return tmp<fvPatchScalarField>
            (
148
                new nutkRoughWallFunctionFvPatchScalarField(*this, iF)
149
150
151
152
153
154
            );
        }


    // Member functions

155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
        // Acces functions

            // Return Ks
             scalarField& Ks()
            {
                return Ks_;
            }

            // Return Cs
            scalarField& Cs()
            {
                return Cs_;
            }


170
171
172
        // Mapping functions

            //- Map (and resize as needed) from self given a mapping object
173
            virtual void autoMap(const fvPatchFieldMapper&);
174
175
176
177
178
179
180
181
182
183
184
185

            //- Reverse map the given fvPatchField onto this fvPatchField
            virtual void rmap
            (
                const fvPatchScalarField&,
                const labelList&
            );


        // I-O

            //- Write
186
            virtual void write(Ostream&) const;
187
188
189
190
191
192
193
194
195
196
197
198
199
200
};


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace RASModels
} // End namespace incompressible
} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //