src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.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::surfaceNormalFixedValueFvPatchVectorField
  27
  28 Description
  29     Describes a surface normal vector boundary condition by its magnitude.
  30     Note: The value is positive for outward-pointing vectors
  31
  32 SourceFiles
  33     surfaceNormalFixedValueFvPatchVectorField.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef surfaceNormalFixedValueFvPatchVectorField_H
  38 #define surfaceNormalFixedValueFvPatchVectorField_H
  39
  40 #include "fvPatchFields.H"
  41 #include "fixedValueFvPatchFields.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                  Class surfaceNormalFixedValueFvPatch Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class surfaceNormalFixedValueFvPatchVectorField
  53 :
  54     public fixedValueFvPatchVectorField
  55 {
  56     // Private data
  57
  58         //- Surface-normal velocity value
  59         scalarField refValue_;
  60
  61
  62 public:
  63
  64     //- Runtime type information
  65     TypeName("surfaceNormalFixedValue");
  66
  67
  68     // Constructors
  69
  70         //- Construct from patch and internal field
  71         surfaceNormalFixedValueFvPatchVectorField
  72         (
  73             const fvPatch&,
  74             const DimensionedField<vector, volMesh>&
  75         );
  76
  77         //- Construct from patch, internal field and dictionary
  78         surfaceNormalFixedValueFvPatchVectorField
  79         (
  80             const fvPatch&,
  81             const DimensionedField<vector, volMesh>&,
  82             const dictionary&
  83         );
  84
  85         //- Construct by mapping given
  86         //  surfaceNormalFixedValueFvPatchVectorField
  87         //  onto a new patch
  88         surfaceNormalFixedValueFvPatchVectorField
  89         (
  90             const surfaceNormalFixedValueFvPatchVectorField&,
  91             const fvPatch&,
  92             const DimensionedField<vector, volMesh>&,
  93             const fvPatchFieldMapper&
  94         );
  95
  96         //- Construct as copy
  97         surfaceNormalFixedValueFvPatchVectorField
  98         (
  99             const surfaceNormalFixedValueFvPatchVectorField&
 100         );
 101
 102         //- Construct and return a clone
 103         virtual tmp<fvPatchVectorField> clone() const
 104         {
 105             return tmp<fvPatchVectorField>
 106             (
 107                 new surfaceNormalFixedValueFvPatchVectorField(*this)
 108             );
 109         }
 110
 111         //- Construct as copy setting internal field reference
 112         surfaceNormalFixedValueFvPatchVectorField
 113         (
 114             const surfaceNormalFixedValueFvPatchVectorField&,
 115             const DimensionedField<vector, volMesh>&
 116         );
 117
 118         //- Construct and return a clone setting internal field reference
 119         virtual tmp<fvPatchVectorField> clone
 120         (
 121             const DimensionedField<vector, volMesh>& iF
 122         ) const
 123         {
 124             return tmp<fvPatchVectorField>
 125             (
 126                 new surfaceNormalFixedValueFvPatchVectorField
 127                 (
 128                     *this,
 129                     iF
 130                 )
 131             );
 132         }
 133
 134
 135
 136     // Member functions
 137
 138         // Mapping functions
 139
 140             //- Map (and resize as needed) from self given a mapping object
 141             virtual void autoMap
 142             (
 143                 const fvPatchFieldMapper&
 144             );
 145
 146             //- Reverse map the given fvPatchField onto this fvPatchField
 147             virtual void rmap
 148             (
 149                 const fvPatchVectorField&,
 150                 const labelList&
 151             );
 152
 153
 154         //- Write
 155         virtual void write(Ostream&) const;
 156 };
 157
 158
 159 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 160
 161 } // End namespace Foam
 162
 163 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 164
 165 #endif
 166
 167 // ************************************************************************* //