src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.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     Foam::inletOutletFvPatchField
  27
  28 Description
  29     Foam::inletOutletFvPatchField
  30
  31 SourceFiles
  32     inletOutletFvPatchField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef inletOutletFvPatchField_H
  37 #define inletOutletFvPatchField_H
  38
  39 #include "mixedFvPatchField.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                      Class inletOutletFvPatch Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 template<class Type>
  51 class inletOutletFvPatchField
  52 :
  53     public mixedFvPatchField<Type>
  54 {
  55
  56 protected:
  57
  58     // Protected data
  59
  60         word phiName_;
  61
  62
  63 public:
  64
  65     //- Runtime type information
  66     TypeName("inletOutlet");
  67
  68
  69     // Constructors
  70
  71         //- Construct from patch and internal field
  72         inletOutletFvPatchField
  73         (
  74             const fvPatch&,
  75             const DimensionedField<Type, volMesh>&
  76         );
  77
  78         //- Construct from patch, internal field and dictionary
  79         inletOutletFvPatchField
  80         (
  81             const fvPatch&,
  82             const DimensionedField<Type, volMesh>&,
  83             const dictionary&
  84         );
  85
  86         //- Construct by mapping given inletOutletFvPatchField onto a new patch
  87         inletOutletFvPatchField
  88         (
  89             const inletOutletFvPatchField<Type>&,
  90             const fvPatch&,
  91             const DimensionedField<Type, volMesh>&,
  92             const fvPatchFieldMapper&
  93         );
  94
  95         //- Construct as copy
  96         inletOutletFvPatchField
  97         (
  98             const inletOutletFvPatchField<Type>&
  99         );
 100
 101         //- Construct and return a clone
 102         virtual tmp<fvPatchField<Type> > clone() const
 103         {
 104             return tmp<fvPatchField<Type> >
 105             (
 106                 new inletOutletFvPatchField<Type>(*this)
 107             );
 108         }
 109
 110         //- Construct as copy setting internal field reference
 111         inletOutletFvPatchField
 112         (
 113             const inletOutletFvPatchField<Type>&,
 114             const DimensionedField<Type, volMesh>&
 115         );
 116
 117         //- Construct and return a clone setting internal field reference
 118         virtual tmp<fvPatchField<Type> > clone
 119         (
 120             const DimensionedField<Type, volMesh>& iF
 121         ) const
 122         {
 123             return tmp<fvPatchField<Type> >
 124             (
 125                 new inletOutletFvPatchField<Type>(*this, iF)
 126             );
 127         }
 128
 129
 130     // Member functions
 131
 132         // Access
 133
 134             //- Return the name of phi
 135             const word& phiName() const
 136             {
 137                 return phiName_;
 138             }
 139
 140             //- Return reference to the name of phi to allow adjustment
 141             word& phiName()
 142             {
 143                 return phiName_;
 144             }
 145
 146
 147         //- Update the coefficients associated with the patch field
 148         virtual void updateCoeffs();
 149
 150         //- Write
 151         virtual void write(Ostream&) const;
 152
 153
 154     // Member operators
 155
 156         virtual void operator=(const fvPatchField<Type>& pvf);
 157 };
 158
 159
 160 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 161
 162 } // End namespace Foam
 163
 164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 165
 166 #ifdef NoRepository
 167 #   include "inletOutletFvPatchField.C"
 168 #endif
 169
 170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 171
 172 #endif
 173
 174 // ************************************************************************* //