src/OpenFOAM/fields/pointPatchFields/constraint/cyclic/cyclicPointPatchField.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::cyclicPointPatchField
  27
  28 Description
  29     Cyclic front and back plane patch field
  30
  31 SourceFiles
  32     cyclicPointPatchField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef cyclicPointPatchField_H
  37 #define cyclicPointPatchField_H
  38
  39 #include "coupledPointPatchField.H"
  40 #include "cyclicPointPatch.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                     Class cyclicPointPatchField Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 template<class Type>
  52 class cyclicPointPatchField
  53 :
  54     public coupledPointPatchField<Type>
  55 {
  56     // Private data
  57
  58         //- Local reference cast into the cyclic patch
  59         const cyclicPointPatch& cyclicPatch_;
  60
  61
  62 public:
  63
  64     //- Runtime type information
  65     TypeName(cyclicPointPatch::typeName_());
  66
  67
  68     // Constructors
  69
  70         //- Construct from patch and internal field
  71         cyclicPointPatchField
  72         (
  73             const pointPatch&,
  74             const DimensionedField<Type, pointMesh>&
  75         );
  76
  77         //- Construct from patch, internal field and dictionary
  78         cyclicPointPatchField
  79         (
  80             const pointPatch&,
  81             const DimensionedField<Type, pointMesh>&,
  82             const dictionary&
  83         );
  84
  85         //- Construct by mapping given patchField<Type> onto a new patch
  86         cyclicPointPatchField
  87         (
  88             const cyclicPointPatchField<Type>&,
  89             const pointPatch&,
  90             const DimensionedField<Type, pointMesh>&,
  91             const pointPatchFieldMapper&
  92         );
  93
  94         //- Construct and return a clone
  95         virtual autoPtr<pointPatchField<Type> > clone() const
  96         {
  97             return autoPtr<pointPatchField<Type> >
  98             (
  99                 new cyclicPointPatchField<Type>
 100                 (
 101                     *this
 102                 )
 103             );
 104         }
 105
 106         //- Construct as copy setting internal field reference
 107         cyclicPointPatchField
 108         (
 109             const cyclicPointPatchField<Type>&,
 110             const DimensionedField<Type, pointMesh>&
 111         );
 112
 113         //- Construct and return a clone setting internal field reference
 114         virtual autoPtr<pointPatchField<Type> > clone
 115         (
 116             const DimensionedField<Type, pointMesh>& iF
 117         ) const
 118         {
 119             return autoPtr<pointPatchField<Type> >
 120             (
 121                 new cyclicPointPatchField<Type>
 122                 (
 123                     *this, iF
 124                 )
 125             );
 126         }
 127
 128
 129     // Member functions
 130
 131         //- Cyclic coupled interface functions
 132
 133             //- Does the patch field perform the transfromation
 134             virtual bool doTransform() const
 135             {
 136                 return !(cyclicPatch_.parallel() || pTraits<Type>::rank == 0);
 137             }
 138
 139             //- Return face transformation tensor
 140             virtual const tensorField& forwardT() const
 141             {
 142                 return cyclicPatch_.forwardT();
 143             }
 144
 145             //- Return neighbour-cell transformation tensor
 146             virtual const tensorField& reverseT() const
 147             {
 148                 return cyclicPatch_.reverseT();
 149             }
 150
 151
 152         // Evaluation functions
 153
 154             //- Evaluate the patch field
 155             virtual void evaluate
 156             (
 157                 const Pstream::commsTypes commsType=Pstream::blocking
 158             )
 159             {}
 160
 161             //- Complete swap of patch point values and add to local values
 162             virtual void swapAdd(Field<Type>&) const;
 163 };
 164
 165
 166 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 167
 168 } // End namespace Foam
 169
 170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 171
 172 #ifdef NoRepository
 173 #    include "cyclicPointPatchField.C"
 174 #endif
 175
 176 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 177
 178 #endif
 179
 180 // ************************************************************************* //