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

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     ggiFvsPatchField
  26
  27 Description
  28     Generalized grid interface patch field.
  29
  30 Author
  31     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  32
  33 SourceFiles
  34     ggiFvsPatchField.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef ggiFvsPatchField_H
  39 #define ggiFvsPatchField_H
  40
  41 #include "coupledFvsPatchField.H"
  42 #include "ggiFvPatch.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                       Class ggiFvsPatchField Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 template<class Type>
  54 class ggiFvsPatchField
  55 :
  56     public coupledFvsPatchField<Type>
  57 {
  58     // Private data
  59
  60         //- Local reference cast into the ggi patch
  61         const ggiFvPatch& ggiPatch_;
  62
  63
  64 public:
  65
  66     //- Runtime type information
  67     TypeName(ggiFvPatch::typeName_());
  68
  69
  70     // Constructors
  71
  72         //- Construct from patch and internal field
  73         ggiFvsPatchField
  74         (
  75             const fvPatch&,
  76             const DimensionedField<Type, surfaceMesh>&
  77         );
  78
  79         //- Construct from patch, internal field and dictionary
  80         ggiFvsPatchField
  81         (
  82             const fvPatch&,
  83             const DimensionedField<Type, surfaceMesh>&,
  84             const dictionary&
  85         );
  86
  87         //- Construct by mapping given ggiFvsPatchField onto a new patch
  88         ggiFvsPatchField
  89         (
  90             const ggiFvsPatchField<Type>&,
  91             const fvPatch&,
  92             const DimensionedField<Type, surfaceMesh>&,
  93             const fvPatchFieldMapper&
  94         );
  95
  96         //- Construct as copy setting internal field reference
  97         ggiFvsPatchField
  98         (
  99             const ggiFvsPatchField<Type>&,
 100             const DimensionedField<Type, surfaceMesh>&
 101         );
 102
 103         //- Construct and return a clone
 104         virtual tmp<fvsPatchField<Type> > clone() const
 105         {
 106             return tmp<fvsPatchField<Type> >
 107             (
 108                 new ggiFvsPatchField<Type>(*this)
 109             );
 110         }
 111
 112         //- Construct and return a clone setting internal field reference
 113         virtual tmp<fvsPatchField<Type> > clone
 114         (
 115             const DimensionedField<Type, surfaceMesh>& iF
 116         ) const
 117         {
 118             return tmp<fvsPatchField<Type> >
 119             (
 120                 new ggiFvsPatchField<Type>(*this, iF)
 121             );
 122         }
 123 };
 124
 125
 126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 127
 128 } // End namespace Foam
 129
 130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 131
 132 #ifdef NoRepository
 133 #   include "ggiFvsPatchField.C"
 134 #endif
 135
 136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 137
 138 #endif
 139
 140 // ************************************************************************* //