src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.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::SRFVelocityFvPatchVectorField
  27
  28 Description
  29     Velocity patch to be used with SRF model
  30
  31 SourceFiles
  32     SRFVelocityFvPatchVectorField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef SRFVelocityFvPatchVectorField_H
  37 #define SRFVelocityFvPatchVectorField_H
  38
  39 #include "fvPatchFields.H"
  40 #include "fixedValueFvPatchFields.H"
  41 #include "Switch.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                Class SRFVelocityFvPatchVectorField Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class SRFVelocityFvPatchVectorField
  53 :
  54     public fixedValueFvPatchVectorField
  55 {
  56     // Private data
  57
  58         //- Is the supplied inlet value relative to the SRF
  59         Switch relative_;
  60
  61         //- Inlet value
  62         vectorField inletValue_;
  63
  64
  65 public:
  66
  67     //- Runtime type information
  68     TypeName("SRFVelocity");
  69
  70
  71     // Constructors
  72
  73         //- Construct from patch and internal field
  74         SRFVelocityFvPatchVectorField
  75         (
  76             const fvPatch&,
  77             const DimensionedField<vector, volMesh>&
  78         );
  79
  80         //- Construct from patch, internal field and dictionary
  81         SRFVelocityFvPatchVectorField
  82         (
  83             const fvPatch&,
  84             const DimensionedField<vector, volMesh>&,
  85             const dictionary&
  86         );
  87
  88         //- Construct by mapping given SRFVelocityFvPatchVectorField
  89         //  onto a new patch
  90         SRFVelocityFvPatchVectorField
  91         (
  92             const SRFVelocityFvPatchVectorField&,
  93             const fvPatch&,
  94             const DimensionedField<vector, volMesh>&,
  95             const fvPatchFieldMapper&
  96         );
  97
  98         //- Construct as copy
  99         SRFVelocityFvPatchVectorField
 100         (
 101             const SRFVelocityFvPatchVectorField&
 102         );
 103
 104         //- Construct and return a clone
 105         virtual tmp<fvPatchVectorField> clone() const
 106         {
 107             return tmp<fvPatchVectorField>
 108             (
 109                 new SRFVelocityFvPatchVectorField(*this)
 110             );
 111         }
 112
 113         //- Construct as copy setting internal field reference
 114         SRFVelocityFvPatchVectorField
 115         (
 116             const SRFVelocityFvPatchVectorField&,
 117             const DimensionedField<vector, volMesh>&
 118         );
 119
 120         //- Construct and return a clone setting internal field reference
 121         virtual tmp<fvPatchVectorField> clone
 122         (
 123             const DimensionedField<vector, volMesh>& iF
 124         ) const
 125         {
 126             return tmp<fvPatchVectorField>
 127             (
 128                 new SRFVelocityFvPatchVectorField(*this, iF)
 129             );
 130         }
 131
 132
 133     // Member functions
 134
 135         // Access
 136
 137             //- Return const access to the relative flag
 138             const Switch& relative() const
 139             {
 140                 return relative_;
 141             }
 142
 143
 144         // Mapping functions
 145
 146             //- Map (and resize as needed) from self given a mapping object
 147             virtual void autoMap
 148             (
 149                 const fvPatchFieldMapper&
 150             );
 151
 152             //- Reverse map the given fvPatchField onto this fvPatchField
 153             virtual void rmap
 154             (
 155                 const fvPatchVectorField&,
 156                 const labelList&
 157             );
 158
 159
 160         // Evaluation functions
 161
 162             //- Update the coefficients associated with the patch field
 163             virtual void updateCoeffs();
 164
 165
 166         // I-O
 167
 168             //- Write
 169             virtual void write(Ostream&) const;
 170 };
 171
 172
 173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 174
 175 } // End namespace Foam
 176
 177 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 178
 179 #endif
 180
 181 // ************************************************************************* //