src/OpenFOAM/fields/pointPatchFields/constraint/wedge/wedgePointPatchField.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::wedgePointPatchField
  27
  28 Description
  29     Wedge front and back plane patch field
  30
  31 SourceFiles
  32     wedgePointPatchField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef wedgePointPatchField_H
  37 #define wedgePointPatchField_H
  38
  39 #include "pointPatchField.H"
  40 #include "wedgePointPatch.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                     Class wedgePointPatchField Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 template<class Type>
  52 class wedgePointPatchField
  53 :
  54     public pointPatchField<Type>
  55 {
  56
  57 public:
  58
  59     //- Runtime type information
  60     TypeName(wedgePointPatch::typeName_());
  61
  62
  63     // Constructors
  64
  65         //- Construct from patch and internal field
  66         wedgePointPatchField
  67         (
  68             const pointPatch&,
  69             const DimensionedField<Type, pointMesh>&
  70         );
  71
  72         //- Construct from patch, internal field and dictionary
  73         wedgePointPatchField
  74         (
  75             const pointPatch&,
  76             const DimensionedField<Type, pointMesh>&,
  77             const dictionary&
  78         );
  79
  80         //- Construct by mapping given patchField<Type> onto a new patch
  81         wedgePointPatchField
  82         (
  83             const wedgePointPatchField<Type>&,
  84             const pointPatch&,
  85             const DimensionedField<Type, pointMesh>&,
  86             const pointPatchFieldMapper&
  87         );
  88
  89         //- Construct and return a clone
  90         virtual autoPtr<pointPatchField<Type> > clone() const
  91         {
  92             return autoPtr<pointPatchField<Type> >
  93             (
  94                 new wedgePointPatchField<Type>
  95                 (
  96                     *this
  97                 )
  98             );
  99         }
 100
 101         //- Construct as copy setting internal field reference
 102         wedgePointPatchField
 103         (
 104             const wedgePointPatchField<Type>&,
 105             const DimensionedField<Type, pointMesh>&
 106         );
 107
 108         //- Construct and return a clone setting internal field reference
 109         virtual autoPtr<pointPatchField<Type> > clone
 110         (
 111             const DimensionedField<Type, pointMesh>& iF
 112         ) const
 113         {
 114             return autoPtr<pointPatchField<Type> >
 115             (
 116                 new wedgePointPatchField<Type>
 117                 (
 118                     *this, iF
 119                 )
 120             );
 121         }
 122
 123
 124     // Member functions
 125
 126         // Evaluation functions
 127
 128             //- Update the patch field
 129             virtual void evaluate
 130             (
 131                 const Pstream::commsTypes commsType=Pstream::blocking
 132             );
 133 };
 134
 135
 136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 137
 138 } // End namespace Foam
 139
 140 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 141
 142 #ifdef NoRepository
 143 #    include "wedgePointPatchField.C"
 144 #endif
 145
 146 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 147
 148 #endif
 149
 150 // ************************************************************************* //