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