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