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