src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2006-2009 OpenCFD Ltd.
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::compressible::turbulentMixingLengthFrequencyInletFvPatchScalarField
  27
  28 Description
  29     Calculate omega via the mixing length
  30
  31     Example of the boundary condition specification:
  32     @verbatim
  33         inlet
  34         {
  35             type            compressible::turbulentMixingLengthFrequencyInlet;
  36             mixingLength    0.005;         // 5 mm
  37             k               k;             // turbulent k field
  38             value           uniform 5;     // initial value
  39         }
  40     @endverbatim
  41
  42 SourceFiles
  43     turbulentMixingLengthFrequencyInletFvPatchScalarField.C
  44
  45 \*---------------------------------------------------------------------------*/
  46
  47 #ifndef compressibleturbulentMixingLengthFrequencyInletFvPatchScalarField_H
  48 #define compressibleturbulentMixingLengthFrequencyInletFvPatchScalarField_H
  49
  50 #include <finiteVolume/fixedValueFvPatchFields.H>
  51
  52 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  53
  54 namespace Foam
  55 {
  56 namespace compressible
  57 {
  58
  59 /*---------------------------------------------------------------------------*\
  60     Class turbulentMixingLengthFrequencyInletFvPatchScalarField Declaration
  61 \*---------------------------------------------------------------------------*/
  62
  63 class turbulentMixingLengthFrequencyInletFvPatchScalarField
  64 :
  65     public fixedValueFvPatchScalarField
  66 {
  67     // Private data
  68
  69         //- Turbulent length scale
  70         scalar mixingLength_;
  71
  72         //- Name of the turbulent kinetic energy field
  73         word kName_;
  74
  75
  76 public:
  77
  78     //- Runtime type information
  79     TypeName("compressible::turbulentMixingLengthFrequencyInlet");
  80
  81
  82     // Constructors
  83
  84         //- Construct from patch and internal field
  85         turbulentMixingLengthFrequencyInletFvPatchScalarField
  86         (
  87             const fvPatch&,
  88             const DimensionedField<scalar, volMesh>&
  89         );
  90
  91         //- Construct from patch, internal field and dictionary
  92         turbulentMixingLengthFrequencyInletFvPatchScalarField
  93         (
  94             const fvPatch&,
  95             const DimensionedField<scalar, volMesh>&,
  96             const dictionary&
  97         );
  98
  99         //- Construct by mapping given
 100         //  turbulentMixingLengthFrequencyInletFvPatchScalarField
 101         //  onto a new patch
 102         turbulentMixingLengthFrequencyInletFvPatchScalarField
 103         (
 104             const turbulentMixingLengthFrequencyInletFvPatchScalarField&,
 105             const fvPatch&,
 106             const DimensionedField<scalar, volMesh>&,
 107             const fvPatchFieldMapper&
 108         );
 109
 110         //- Construct as copy
 111         turbulentMixingLengthFrequencyInletFvPatchScalarField
 112         (
 113             const turbulentMixingLengthFrequencyInletFvPatchScalarField&
 114         );
 115
 116         //- Construct and return a clone
 117         virtual tmp<fvPatchScalarField> clone() const
 118         {
 119             return tmp<fvPatchScalarField>
 120             (
 121                 new turbulentMixingLengthFrequencyInletFvPatchScalarField
 122                 (
 123                     *this
 124                 )
 125             );
 126         }
 127
 128         //- Construct as copy setting internal field reference
 129         turbulentMixingLengthFrequencyInletFvPatchScalarField
 130         (
 131             const turbulentMixingLengthFrequencyInletFvPatchScalarField&,
 132             const DimensionedField<scalar, volMesh>&
 133         );
 134
 135         //- Construct and return a clone setting internal field reference
 136         virtual tmp<fvPatchScalarField> clone
 137         (
 138             const DimensionedField<scalar, volMesh>& iF
 139         ) const
 140         {
 141             return tmp<fvPatchScalarField>
 142             (
 143                 new turbulentMixingLengthFrequencyInletFvPatchScalarField
 144                 (
 145                     *this,
 146                     iF
 147                 )
 148             );
 149         }
 150
 151
 152     // Member functions
 153
 154         //- Update the coefficients associated with the patch field
 155         virtual void updateCoeffs();
 156
 157         //- Write
 158         virtual void write(Ostream&) const;
 159 };
 160
 161
 162 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 163
 164 } // End namespace compressible
 165 } // End namespace Foam
 166
 167 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 168
 169 #endif
 170
 171 // ************************ vim: set sw=4 sts=4 et: ************************ //