src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-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::pressureDirectedInletOutletVelocityFvPatchVectorField
  27
  28 Description
  29     Velocity inlet/outlet boundary condition for pressure boundary where the
  30     pressure is specified.  zero-gradient is applied for outflow (as defined
  31     by the flux) and for inflow the velocity is obtained from the flux with
  32     the specified `inletDirection'.
  33
  34 SourceFiles
  35     pressureDirectedInletOutletVelocityFvPatchVectorField.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef pressureDirectedInletOutletVelocityFvPatchVectorField_H
  40 #define pressureDirectedInletOutletVelocityFvPatchVectorField_H
  41
  42 #include "fvPatchFields.H"
  43 #include "mixedFvPatchFields.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51           Class pressureDirectedInletOutletVelocityFvPatch Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class pressureDirectedInletOutletVelocityFvPatchVectorField
  55 :
  56     public mixedFvPatchVectorField
  57 {
  58     // Private data
  59
  60         word phiName_;
  61         word rhoName_;
  62         vectorField inletDir_;
  63
  64
  65 public:
  66
  67     //- Runtime type information
  68     TypeName("pressureDirectedInletOutletVelocity");
  69
  70
  71     // Constructors
  72
  73         //- Construct from patch and internal field
  74         pressureDirectedInletOutletVelocityFvPatchVectorField
  75         (
  76             const fvPatch&,
  77             const DimensionedField<vector, volMesh>&
  78         );
  79
  80         //- Construct from patch, internal field and dictionary
  81         pressureDirectedInletOutletVelocityFvPatchVectorField
  82         (
  83             const fvPatch&,
  84             const DimensionedField<vector, volMesh>&,
  85             const dictionary&
  86         );
  87
  88         //- Construct by mapping given
  89         //  pressureDirectedInletOutletVelocityFvPatchVectorField
  90         //  onto a new patch
  91         pressureDirectedInletOutletVelocityFvPatchVectorField
  92         (
  93             const pressureDirectedInletOutletVelocityFvPatchVectorField&,
  94             const fvPatch&,
  95             const DimensionedField<vector, volMesh>&,
  96             const fvPatchFieldMapper&
  97         );
  98
  99         //- Construct as copy
 100         pressureDirectedInletOutletVelocityFvPatchVectorField
 101         (
 102             const pressureDirectedInletOutletVelocityFvPatchVectorField&
 103         );
 104
 105         //- Construct and return a clone
 106         virtual tmp<fvPatchVectorField> clone() const
 107         {
 108             return tmp<fvPatchVectorField>
 109             (
 110                 new pressureDirectedInletOutletVelocityFvPatchVectorField
 111                 (
 112                     *this
 113                 )
 114             );
 115         }
 116
 117         //- Construct as copy setting internal field reference
 118         pressureDirectedInletOutletVelocityFvPatchVectorField
 119         (
 120             const pressureDirectedInletOutletVelocityFvPatchVectorField&,
 121             const DimensionedField<vector, volMesh>&
 122         );
 123
 124         //- Construct and return a clone setting internal field reference
 125         virtual tmp<fvPatchVectorField> clone
 126         (
 127             const DimensionedField<vector, volMesh>& iF
 128         ) const
 129         {
 130             return tmp<fvPatchVectorField>
 131             (
 132                 new pressureDirectedInletOutletVelocityFvPatchVectorField
 133                 (
 134                     *this,
 135                     iF
 136                 )
 137             );
 138         }
 139
 140
 141     // Member functions
 142
 143         // Access
 144
 145             //- Return the name of rho
 146             const word& rhoName() const
 147             {
 148                 return rhoName_;
 149             }
 150
 151             //- Return reference to the name of rho to allow adjustment
 152             word& rhoName()
 153             {
 154                 return rhoName_;
 155             }
 156
 157             //- Return the name of phi
 158             const word& phiName() const
 159             {
 160                 return phiName_;
 161             }
 162
 163             //- Return reference to the name of phi to allow adjustment
 164             word& phiName()
 165             {
 166                 return phiName_;
 167             }
 168
 169
 170         // Mapping functions
 171
 172             //- Map (and resize as needed) from self given a mapping object
 173             virtual void autoMap
 174             (
 175                 const fvPatchFieldMapper&
 176             );
 177
 178             //- Reverse map the given fvPatchField onto this fvPatchField
 179             virtual void rmap
 180             (
 181                 const fvPatchVectorField&,
 182                 const labelList&
 183             );
 184
 185
 186         //- Update the coefficients associated with the patch field
 187         virtual void updateCoeffs();
 188
 189         //- Write
 190         virtual void write(Ostream&) const;
 191
 192
 193     // Member operators
 194
 195         virtual void operator=(const fvPatchField<vector>& pvf);
 196 };
 197
 198
 199 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 200
 201 } // End namespace Foam
 202
 203 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 204
 205 #endif
 206
 207 // ************************************************************************* //