src/OpenFOAM/fields/pointPatchFields/constraint/symmetry/symmetryPointPatchField.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::symmetryPointPatchField
  26
  27 Description
  28     A Symmetry boundary condition for pointField
  29
  30 SourceFiles
  31     symmetryPointPatchField.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef symmetryPointPatchField_H
  36 #define symmetryPointPatchField_H
  37
  38 #include "basicSymmetryPointPatchField.H"
  39 #include "symmetryPointPatch.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                   Class symmetryPointPatchField Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 template<class Type>
  51 class symmetryPointPatchField
  52 :
  53     public basicSymmetryPointPatchField<Type>
  54 {
  55
  56 public:
  57
  58     //- Runtime type information
  59     TypeName(symmetryPointPatch::typeName_());
  60
  61
  62     // Constructors
  63
  64         //- Construct from patch and internal field
  65         symmetryPointPatchField
  66         (
  67             const pointPatch&,
  68             const DimensionedField<Type, pointMesh>&
  69         );
  70
  71         //- Construct from patch, internal field and dictionary
  72         symmetryPointPatchField
  73         (
  74             const pointPatch&,
  75             const DimensionedField<Type, pointMesh>&,
  76             const dictionary&
  77         );
  78
  79         //- Construct by mapping given patchField<Type> onto a new patch
  80         symmetryPointPatchField
  81         (
  82             const symmetryPointPatchField<Type>&,
  83             const pointPatch&,
  84             const DimensionedField<Type, pointMesh>&,
  85             const pointPatchFieldMapper&
  86         );
  87
  88         //- Construct and return a clone
  89         virtual autoPtr<pointPatchField<Type> > clone() const
  90         {
  91             return autoPtr<pointPatchField<Type> >
  92             (
  93                 new symmetryPointPatchField<Type>
  94                 (
  95                     *this
  96                 )
  97             );
  98         }
  99
 100         //- Construct as copy setting internal field reference
 101         symmetryPointPatchField
 102         (
 103             const symmetryPointPatchField<Type>&,
 104             const DimensionedField<Type, pointMesh>&
 105         );
 106
 107         //- Construct and return a clone setting internal field reference
 108         virtual autoPtr<pointPatchField<Type> > clone
 109         (
 110             const DimensionedField<Type, pointMesh>& iF
 111         ) const
 112         {
 113             return autoPtr<pointPatchField<Type> >
 114             (
 115                 new symmetryPointPatchField<Type>
 116                 (
 117                     *this,
 118                     iF
 119                 )
 120             );
 121         }
 122
 123
 124     // Member functions
 125
 126         //- Return the constraint type this pointPatchField implements
 127         virtual const word& constraintType() const
 128         {
 129             return symmetryPointPatch::typeName;
 130         }
 131
 132 };
 133
 134
 135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 136
 137 } // End namespace Foam
 138
 139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 140
 141 #ifdef NoRepository
 142 #    include "symmetryPointPatchField.C"
 143 #endif
 144
 145 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 146
 147 #endif
 148
 149 // ************************************************************************* //