src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.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::fanFvPatchField
  26
  27 Description
  28     Foam::fanFvPatchField
  29
  30 SourceFiles
  31     fanFvPatchField.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef fanFvPatchField_H
  36 #define fanFvPatchField_H
  37
  38 #include "jumpCyclicFvPatchField.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                        Class fanFvPatchField Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 template<class Type>
  50 class fanFvPatchField
  51 :
  52     public jumpCyclicFvPatchField<Type>
  53 {
  54     // Private data
  55
  56         //- Fan pressure rise polynomial coefficients
  57         List<scalar> f_;
  58
  59         //- "jump" field
  60         Field<Type> jump_;
  61
  62
  63 public:
  64
  65     //- Runtime type information
  66     TypeName("fan");
  67
  68
  69     // Constructors
  70
  71         //- Construct from patch and internal field
  72         fanFvPatchField
  73         (
  74             const fvPatch&,
  75             const DimensionedField<Type, volMesh>&
  76         );
  77
  78         //- Construct from patch, internal field and dictionary
  79         fanFvPatchField
  80         (
  81             const fvPatch&,
  82             const DimensionedField<Type, volMesh>&,
  83             const dictionary&
  84         );
  85
  86         //- Construct by mapping given fanFvPatchField onto a new patch
  87         fanFvPatchField
  88         (
  89             const fanFvPatchField<Type>&,
  90             const fvPatch&,
  91             const DimensionedField<Type, volMesh>&,
  92             const fvPatchFieldMapper&
  93         );
  94
  95         //- Construct as copy
  96         fanFvPatchField
  97         (
  98             const fanFvPatchField<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 fanFvPatchField<Type>(*this)
 107             );
 108         }
 109
 110         //- Construct as copy setting internal field reference
 111         fanFvPatchField
 112         (
 113             const fanFvPatchField<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 fanFvPatchField<Type>(*this, iF)
 126             );
 127         }
 128
 129
 130     // Member functions
 131
 132         // Access
 133
 134             //- Return the polynomial coefficients
 135             const List<scalar>& f() const
 136             {
 137                 return f_;
 138             }
 139
 140             //- Return the "jump" across the patch.
 141             virtual tmp<Field<Type> > jump() const
 142             {
 143                 if (this->cyclicPatch().owner())
 144                 {
 145                     return jump_;
 146                 }
 147                 else
 148                 {
 149                     return refCast<const fanFvPatchField<Type> >
 150                     (
 151                         this->neighbourPatchField()
 152                     ).jump();
 153                 }
 154             }
 155
 156
 157         // Mapping functions
 158
 159             //- Map (and resize as needed) from self given a mapping object
 160             virtual void autoMap
 161             (
 162                 const fvPatchFieldMapper&
 163             );
 164
 165             //- Reverse map the given fvPatchField onto this fvPatchField
 166             virtual void rmap
 167             (
 168                 const fvPatchField<Type>&,
 169                 const labelList&
 170             );
 171
 172         // Evaluation functions
 173
 174             //- Update the coefficients associated with the patch field
 175             virtual void updateCoeffs();
 176
 177
 178         //- Write
 179         virtual void write(Ostream&) const;
 180 };
 181
 182
 183 //- Specialisation of the jump-condition for the pressure
 184 template<>
 185 void fanFvPatchField<scalar>::updateCoeffs();
 186
 187
 188 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 189
 190 } // End namespace Foam
 191
 192 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 193
 194 #ifdef NoRepository
 195 #   include "fanFvPatchField.C"
 196 #endif
 197
 198 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 199
 200 #endif
 201
 202 // ************************************************************************* //