src/finiteVolume/fields/fvsPatchFields/constraint/ggi/ggiFvsPatchField.H

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