src/finiteVolume/fields/fvsPatchFields/constraint/cyclicGgi/cyclicGgiFvsPatchField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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     cyclicGgiFvsPatchField
  27
  28 Description
  29     Non-matching cyclic generalized grid interface patch field.
  30
  31 Author
  32     Martin Beaudoin, Hydro-Quebec, (2008)
  33
  34 Contributor
  35     Hrvoje Jasak, Wikki Ltd.
  36
  37 SourceFiles
  38     cyclicGgiFvsPatchField.C
  39
  40 \*---------------------------------------------------------------------------*/
  41
  42 #ifndef cyclicGgiFvsPatchField_H
  43 #define cyclicGgiFvsPatchField_H
  44
  45 #include "coupledFvsPatchField.H"
  46 #include "cyclicGgiFvPatch.H"
  47
  48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  49
  50 namespace Foam
  51 {
  52
  53 /*---------------------------------------------------------------------------*\
  54                       Class cyclicGgiFvsPatchField Declaration
  55 \*---------------------------------------------------------------------------*/
  56
  57 template<class Type>
  58 class cyclicGgiFvsPatchField
  59 :
  60     public coupledFvsPatchField<Type>
  61 {
  62     // Private data
  63
  64         //- Local reference cast into the cyclicGgi patch
  65         const cyclicGgiFvPatch& cyclicGgiPatch_;
  66
  67
  68 public:
  69
  70     //- Runtime type information
  71     TypeName(cyclicGgiFvPatch::typeName_());
  72
  73
  74     // Constructors
  75
  76         //- Construct from patch and internal field
  77         cyclicGgiFvsPatchField
  78         (
  79             const fvPatch&,
  80             const DimensionedField<Type, surfaceMesh>&
  81         );
  82
  83         //- Construct from patch, internal field and dictionary
  84         cyclicGgiFvsPatchField
  85         (
  86             const fvPatch&,
  87             const DimensionedField<Type, surfaceMesh>&,
  88             const dictionary&
  89         );
  90
  91         //- Construct by mapping given cyclicGgiFvsPatchField onto a new patch
  92         cyclicGgiFvsPatchField
  93         (
  94             const cyclicGgiFvsPatchField<Type>&,
  95             const fvPatch&,
  96             const DimensionedField<Type, surfaceMesh>&,
  97             const fvPatchFieldMapper&
  98         );
  99
 100         //- Construct as copy setting internal field reference
 101         cyclicGgiFvsPatchField
 102         (
 103             const cyclicGgiFvsPatchField<Type>&,
 104             const DimensionedField<Type, surfaceMesh>&
 105         );
 106
 107         //- Construct and return a clone
 108         virtual tmp<fvsPatchField<Type> > clone() const
 109         {
 110             return tmp<fvsPatchField<Type> >
 111             (
 112                 new cyclicGgiFvsPatchField<Type>(*this)
 113             );
 114         }
 115
 116         //- Construct and return a clone setting internal field reference
 117         virtual tmp<fvsPatchField<Type> > clone
 118         (
 119             const DimensionedField<Type, surfaceMesh>& iF
 120         ) const
 121         {
 122             return tmp<fvsPatchField<Type> >
 123             (
 124                 new cyclicGgiFvsPatchField<Type>(*this, iF)
 125             );
 126         }
 127 };
 128
 129
 130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 131
 132 } // End namespace Foam
 133
 134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 135
 136 #ifdef NoRepository
 137 #   include "cyclicGgiFvsPatchField.C"
 138 #endif
 139
 140 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 141
 142 #endif
 143
 144 // ************************************************************************* //