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) 1991-2008 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::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         scalarField refValue_;
  59
  60
  61 public:
  62
  63     //- Runtime type information
  64     TypeName("surfaceNormalFixedValue");
  65
  66
  67     // Constructors
  68
  69         //- Construct from patch and internal field
  70         surfaceNormalFixedValueFvPatchVectorField
  71         (
  72             const fvPatch&,
  73             const DimensionedField<vector, volMesh>&
  74         );
  75
  76         //- Construct from patch, internal field and dictionary
  77         surfaceNormalFixedValueFvPatchVectorField
  78         (
  79             const fvPatch&,
  80             const DimensionedField<vector, volMesh>&,
  81             const dictionary&
  82         );
  83
  84         //- Construct by mapping given
  85         //  surfaceNormalFixedValueFvPatchVectorField
  86         //  onto a new patch
  87         surfaceNormalFixedValueFvPatchVectorField
  88         (
  89             const surfaceNormalFixedValueFvPatchVectorField&,
  90             const fvPatch&,
  91             const DimensionedField<vector, volMesh>&,
  92             const fvPatchFieldMapper&
  93         );
  94
  95         //- Construct as copy
  96         surfaceNormalFixedValueFvPatchVectorField
  97         (
  98             const surfaceNormalFixedValueFvPatchVectorField&
  99         );
 100
 101         //- Construct and return a clone
 102         virtual tmp<fvPatchVectorField> clone() const
 103         {
 104             return tmp<fvPatchVectorField>
 105             (
 106                 new surfaceNormalFixedValueFvPatchVectorField(*this)
 107             );
 108         }
 109
 110         //- Construct as copy setting internal field reference
 111         surfaceNormalFixedValueFvPatchVectorField
 112         (
 113             const surfaceNormalFixedValueFvPatchVectorField&,
 114             const DimensionedField<vector, volMesh>&
 115         );
 116
 117         //- Construct and return a clone setting internal field reference
 118         virtual tmp<fvPatchVectorField> clone
 119         (
 120             const DimensionedField<vector, volMesh>& iF
 121         ) const
 122         {
 123             return tmp<fvPatchVectorField>
 124             (
 125                 new surfaceNormalFixedValueFvPatchVectorField
 126                 (
 127                     *this,
 128                     iF
 129                 )
 130             );
 131         }
 132
 133
 134
 135     // Member functions
 136
 137         // Mapping functions
 138
 139             //- Map (and resize as needed) from self given a mapping object
 140             virtual void autoMap
 141             (
 142                 const fvPatchFieldMapper&
 143             );
 144
 145             //- Reverse map the given fvPatchField onto this fvPatchField
 146             virtual void rmap
 147             (
 148                 const fvPatchVectorField&,
 149                 const labelList&
 150             );
 151
 152
 153         //- Write
 154         virtual void write(Ostream&) const;
 155 };
 156
 157
 158 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 159
 160 } // End namespace Foam
 161
 162 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 163
 164 #endif
 165
 166 // ************************************************************************* //