src/OpenFOAM/fields/pointPatchFields/derived/fixedNormalSlip/fixedNormalSlipPointPatchField.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::fixedNormalSlipPointPatchField
  26
  27 Description
  28     slip with user-specified normal
  29
  30 SourceFiles
  31     fixedNormalSlipPointPatchField.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef fixedNormalSlipPointPatchField_H
  36 #define fixedNormalSlipPointPatchField_H
  37
  38 #include "slipPointPatchField.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 // Forward declaration of friend functions and operators
  46
  47 template<class Type>
  48 class fixedNormalSlipPointPatchField;
  49
  50 template<class Type>
  51 Ostream& operator<<
  52 (
  53     Ostream&,
  54     const fixedNormalSlipPointPatchField<Type>&
  55 );
  56
  57
  58 /*---------------------------------------------------------------------------*\
  59                         Class fixedNormalSlipPointPatchField Declaration
  60 \*---------------------------------------------------------------------------*/
  61
  62 template<class Type>
  63 class fixedNormalSlipPointPatchField
  64 :
  65     public slipPointPatchField<Type>
  66 {
  67     // Private data
  68
  69         //- User specified normal
  70         vector n_;
  71
  72
  73 public:
  74
  75     //- Runtime type information
  76     TypeName("fixedNormalSlip");
  77
  78
  79     // Constructors
  80
  81         //- Construct from patch and internal field
  82         fixedNormalSlipPointPatchField
  83         (
  84             const pointPatch&,
  85             const DimensionedField<Type, pointMesh>&
  86         );
  87
  88         //- Construct from patch, internal field and dictionary
  89         fixedNormalSlipPointPatchField
  90         (
  91             const pointPatch&,
  92             const DimensionedField<Type, pointMesh>&,
  93             const dictionary&
  94         );
  95
  96         //- Construct by mapping given patchField<Type> onto a new patch
  97         fixedNormalSlipPointPatchField
  98         (
  99             const fixedNormalSlipPointPatchField<Type>&,
 100             const pointPatch&,
 101             const DimensionedField<Type, pointMesh>&,
 102             const pointPatchFieldMapper&
 103         );
 104
 105         //- Construct and return a clone
 106         virtual autoPtr<pointPatchField<Type> > clone() const
 107         {
 108             return autoPtr<pointPatchField<Type> >
 109             (
 110                 new fixedNormalSlipPointPatchField<Type>
 111                 (
 112                     *this
 113                 )
 114             );
 115         }
 116
 117         //- Construct as copy setting internal field reference
 118         fixedNormalSlipPointPatchField
 119         (
 120             const fixedNormalSlipPointPatchField<Type>&,
 121             const DimensionedField<Type, pointMesh>&
 122         );
 123
 124         //- Construct and return a clone setting internal field reference
 125         virtual autoPtr<pointPatchField<Type> > clone
 126         (
 127             const DimensionedField<Type, pointMesh>& iF
 128         ) const
 129         {
 130             return autoPtr<pointPatchField<Type> >
 131             (
 132                 new fixedNormalSlipPointPatchField<Type>
 133                 (
 134                     *this,
 135                     iF
 136                 )
 137             );
 138         }
 139
 140     // Member functions
 141
 142         // Evaluation functions
 143
 144             //- Update the patch field
 145             virtual void evaluate
 146             (
 147                 const Pstream::commsTypes commsType=Pstream::blocking
 148             );
 149
 150
 151         //- Write
 152         virtual void write(Ostream&) const;
 153 };
 154
 155
 156 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 157
 158 } // End namespace Foam
 159
 160 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 161
 162 #ifdef NoRepository
 163 #    include "fixedNormalSlipPointPatchField.C"
 164 #endif
 165
 166 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 167
 168 #endif
 169
 170 // ************************************************************************* //