src/finiteVolume/fields/fvsPatchFields/constraint/cyclic/cyclicFvsPatchField.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::cyclicFvsPatchField
  27
  28 Description
  29     Foam::cyclicFvsPatchField
  30
  31 SourceFiles
  32     cyclicFvsPatchField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef cyclicFvsPatchField_H
  37 #define cyclicFvsPatchField_H
  38
  39 #include "coupledFvsPatchField.H"
  40 #include "cyclicFvPatch.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class cyclicFvsPatch Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 template<class Type>
  52 class cyclicFvsPatchField
  53 :
  54     public coupledFvsPatchField<Type>
  55 {
  56     // Private data
  57
  58         //- Local reference cast into the cyclic patch
  59         const cyclicFvPatch& cyclicPatch_;
  60
  61
  62 public:
  63
  64     //- Runtime type information
  65     TypeName(cyclicFvPatch::typeName_());
  66
  67
  68     // Constructors
  69
  70         //- Construct from patch and internal field
  71         cyclicFvsPatchField
  72         (
  73             const fvPatch&,
  74             const DimensionedField<Type, surfaceMesh>&
  75         );
  76
  77         //- Construct from patch, internal field and dictionary
  78         cyclicFvsPatchField
  79         (
  80             const fvPatch&,
  81             const DimensionedField<Type, surfaceMesh>&,
  82             const dictionary&
  83         );
  84
  85         //- Construct by mapping given cyclicFvsPatchField onto a new patch
  86         cyclicFvsPatchField
  87         (
  88             const cyclicFvsPatchField<Type>&,
  89             const fvPatch&,
  90             const DimensionedField<Type, surfaceMesh>&,
  91             const fvPatchFieldMapper&
  92         );
  93
  94         //- Construct as copy
  95         cyclicFvsPatchField
  96         (
  97             const cyclicFvsPatchField<Type>&
  98         );
  99
 100         //- Construct and return a clone
 101         virtual tmp<fvsPatchField<Type> > clone() const
 102         {
 103             return tmp<fvsPatchField<Type> >
 104             (
 105                 new cyclicFvsPatchField<Type>(*this)
 106             );
 107         }
 108
 109         //- Construct as copy setting internal field reference
 110         cyclicFvsPatchField
 111         (
 112             const cyclicFvsPatchField<Type>&,
 113             const DimensionedField<Type, surfaceMesh>&
 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 cyclicFvsPatchField<Type>(*this, iF)
 125             );
 126         }
 127 };
 128
 129
 130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 131
 132 } // End namespace Foam
 133
 134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 135
 136 #ifdef NoRepository
 137 #   include "cyclicFvsPatchField.C"
 138 #endif
 139
 140 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 141
 142 #endif
 143
 144 // ************************************************************************* //