src/finiteVolume/fields/fvPatchFields/derived/parabolicVelocity/parabolicVelocityFvPatchVectorField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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     parabolicVelocityFvPatchVectorField
  27
  28 Description
  29     Boundary condition specifies a parabolic velocity inlet profile
  30     (fixed value), given maximum velocity value (peak of the parabola),
  31     flow direction n and direction of the parabolic coordinate y
  32
  33 SourceFiles
  34     parabolicVelocityFvPatchVectorField.C
  35
  36 Author
  37     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  38
  39 \*---------------------------------------------------------------------------*/
  40
  41 #ifndef parabolicVelocityFvPatchVectorField_H
  42 #define parabolicVelocityFvPatchVectorField_H
  43
  44 #include "fvPatchFields.H"
  45 #include "fixedValueFvPatchFields.H"
  46
  47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  48
  49 namespace Foam
  50 {
  51
  52 /*---------------------------------------------------------------------------*\
  53               Class parabolicVelocityFvPatchField Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class parabolicVelocityFvPatchVectorField
  57 :
  58     public fixedValueFvPatchVectorField
  59 {
  60     // Private data
  61
  62         //- Peak velocity magnitude
  63         scalar maxValue_;
  64
  65         //- Flow direction
  66         vector n_;
  67
  68         //- Direction of the y-coordinate
  69         vector y_;
  70
  71
  72 public:
  73
  74     //- Runtime type information
  75     TypeName("parabolicVelocity");
  76
  77
  78     // Constructors
  79
  80         //- Construct from patch and internal field
  81         parabolicVelocityFvPatchVectorField
  82         (
  83             const fvPatch&,
  84             const DimensionedField<vector, volMesh>&
  85         );
  86
  87         //- Construct from patch, internal field and dictionary
  88         parabolicVelocityFvPatchVectorField
  89         (
  90             const fvPatch&,
  91             const DimensionedField<vector, volMesh>&,
  92             const dictionary&
  93         );
  94
  95         //- Construct by mapping given parabolicVelocityFvPatchVectorField
  96         //  onto a new patch
  97         parabolicVelocityFvPatchVectorField
  98         (
  99             const parabolicVelocityFvPatchVectorField&,
 100             const fvPatch&,
 101             const DimensionedField<vector, volMesh>&,
 102             const fvPatchFieldMapper&
 103         );
 104
 105         //- Construct and return a clone
 106         virtual tmp<fvPatchVectorField> clone() const
 107         {
 108             return tmp<fvPatchVectorField>
 109             (
 110                 new parabolicVelocityFvPatchVectorField(*this)
 111             );
 112         }
 113
 114         //- Construct as copy setting internal field reference
 115         parabolicVelocityFvPatchVectorField
 116         (
 117             const parabolicVelocityFvPatchVectorField&,
 118             const DimensionedField<vector, volMesh>&
 119         );
 120
 121         //- Construct and return a clone setting internal field reference
 122         virtual tmp<fvPatchVectorField> clone
 123         (
 124             const DimensionedField<vector, volMesh>& iF
 125         ) const
 126         {
 127             return tmp<fvPatchVectorField>
 128             (
 129                 new parabolicVelocityFvPatchVectorField(*this, iF)
 130             );
 131         }
 132
 133
 134     // Member functions
 135
 136         //- Return max value
 137         scalar& maxValue()
 138         {
 139             return maxValue_;
 140         }
 141
 142         //- Return flow direction
 143         vector& n()
 144         {
 145             return n_;
 146         }
 147
 148         //- Return y direction
 149         vector& y()
 150         {
 151             return y_;
 152         }
 153
 154         //- Update coefficients
 155         virtual void updateCoeffs();
 156
 157         //- Write
 158         virtual void write(Ostream&) const;
 159 };
 160
 161
 162 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 163
 164 } // End namespace Foam
 165
 166 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 167
 168 #endif
 169
 170 // ************************************************************************* //