src/finiteVolume/fields/fvPatchFields/constraint/nonuniformTransformCyclic/nonuniformTransformCyclicFvPatchField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::nonuniformTransformCyclicFvPatchField
  26
  27 Description
  28     Foam::nonuniformTransformCyclicFvPatchField
  29
  30 SourceFiles
  31     nonuniformTransformCyclicFvPatchField.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef nonuniformTransformCyclicFvPatchField_H
  36 #define nonuniformTransformCyclicFvPatchField_H
  37
  38 #include "cyclicFvPatchField.H"
  39 #include "nonuniformTransformCyclicFvPatch.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47               Class nonuniformTransformCyclicFvPatch Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 template<class Type>
  51 class nonuniformTransformCyclicFvPatchField
  52 :
  53     public cyclicFvPatchField<Type>
  54 {
  55     // Private data
  56
  57 public:
  58
  59     //- Runtime type information
  60     TypeName(nonuniformTransformCyclicFvPatch::typeName_());
  61
  62
  63     // Constructors
  64
  65         //- Construct from patch and internal field
  66         nonuniformTransformCyclicFvPatchField
  67         (
  68             const fvPatch&,
  69             const DimensionedField<Type, volMesh>&
  70         );
  71
  72         //- Construct from patch, internal field and dictionary
  73         nonuniformTransformCyclicFvPatchField
  74         (
  75             const fvPatch&,
  76             const DimensionedField<Type, volMesh>&,
  77             const dictionary&
  78         );
  79
  80         //- Construct by mapping given
  81         //  nonuniformTransformCyclicFvPatchField onto a new patch
  82         nonuniformTransformCyclicFvPatchField
  83         (
  84             const nonuniformTransformCyclicFvPatchField<Type>&,
  85             const fvPatch&,
  86             const DimensionedField<Type, volMesh>&,
  87             const fvPatchFieldMapper&
  88         );
  89
  90         //- Construct as copy
  91         nonuniformTransformCyclicFvPatchField
  92         (
  93             const nonuniformTransformCyclicFvPatchField<Type>&
  94         );
  95
  96         //- Construct and return a clone
  97         virtual tmp<fvPatchField<Type> > clone() const
  98         {
  99             return tmp<fvPatchField<Type> >
 100             (
 101                 new nonuniformTransformCyclicFvPatchField<Type>(*this)
 102             );
 103         }
 104
 105         //- Construct as copy setting internal field reference
 106         nonuniformTransformCyclicFvPatchField
 107         (
 108             const nonuniformTransformCyclicFvPatchField<Type>&,
 109             const DimensionedField<Type, volMesh>&
 110         );
 111
 112         //- Construct and return a clone setting internal field reference
 113         virtual tmp<fvPatchField<Type> > clone
 114         (
 115             const DimensionedField<Type, volMesh>& iF
 116         ) const
 117         {
 118             return tmp<fvPatchField<Type> >
 119             (
 120                 new nonuniformTransformCyclicFvPatchField<Type>(*this, iF)
 121             );
 122         }
 123
 124 };
 125
 126
 127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 128
 129 } // End namespace Foam
 130
 131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 132
 133 #ifdef NoRepository
 134 #   include "nonuniformTransformCyclicFvPatchField.C"
 135 #endif
 136
 137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 138
 139 #endif
 140
 141 // ************************************************************************* //