src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-2010 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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::outletInletFvPatchField
  26
  27 Description
  28     Foam::outletInletFvPatchField
  29
  30 SourceFiles
  31     outletInletFvPatchField.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef outletInletFvPatchField_H
  36 #define outletInletFvPatchField_H
  37
  38 #include "mixedFvPatchField.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                      Class outletInletFvPatch Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 template<class Type>
  50 class outletInletFvPatchField
  51 :
  52     public mixedFvPatchField<Type>
  53 {
  54
  55 protected:
  56
  57     // Protected data
  58
  59         //- Name of flux field
  60         word phiName_;
  61
  62
  63 public:
  64
  65     //- Runtime type information
  66     TypeName("outletInlet");
  67
  68
  69     // Constructors
  70
  71         //- Construct from patch and internal field
  72         outletInletFvPatchField
  73         (
  74             const fvPatch&,
  75             const DimensionedField<Type, volMesh>&
  76         );
  77
  78         //- Construct from patch, internal field and dictionary
  79         outletInletFvPatchField
  80         (
  81             const fvPatch&,
  82             const DimensionedField<Type, volMesh>&,
  83             const dictionary&
  84         );
  85
  86         //- Construct by mapping given outletInletFvPatchField onto a new patch
  87         outletInletFvPatchField
  88         (
  89             const outletInletFvPatchField<Type>&,
  90             const fvPatch&,
  91             const DimensionedField<Type, volMesh>&,
  92             const fvPatchFieldMapper&
  93         );
  94
  95         //- Construct as copy
  96         outletInletFvPatchField
  97         (
  98             const outletInletFvPatchField<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 outletInletFvPatchField<Type>(*this)
 107             );
 108         }
 109
 110         //- Construct as copy setting internal field reference
 111         outletInletFvPatchField
 112         (
 113             const outletInletFvPatchField<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 outletInletFvPatchField<Type>(*this, iF)
 126             );
 127         }
 128
 129
 130     // Member functions
 131
 132         //- Update the coefficients associated with the patch field
 133         virtual void updateCoeffs();
 134
 135         //- Write
 136         virtual void write(Ostream&) const;
 137 };
 138
 139
 140 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 141
 142 } // End namespace Foam
 143
 144 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 145
 146 #ifdef NoRepository
 147 #   include "outletInletFvPatchField.C"
 148 #endif
 149
 150 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 151
 152 #endif
 153
 154 // ************************************************************************* //