src/OpenFOAM/fields/pointPatchFields/basic/calculated/calculatedPointPatchField.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::calculatedPointPatchField
  27
  28 Description
  29     A calculated boundary condition for pointField
  30
  31 SourceFiles
  32     calculatedPointPatchField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef calculatedPointPatchField_H
  37 #define calculatedPointPatchField_H
  38
  39 #include "pointPatchField.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                  Class calculatedPointPatchField Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 template<class Type>
  51 class calculatedPointPatchField
  52 :
  53     public pointPatchField<Type>
  54 {
  55
  56 public:
  57
  58     //- Runtime type information
  59     TypeName("calculated");
  60
  61
  62     // Constructors
  63
  64         //- Construct from patch and internal field
  65         calculatedPointPatchField
  66         (
  67             const pointPatch&,
  68             const DimensionedField<Type, pointMesh>&
  69         );
  70
  71         //- Construct from patch, internal field and dictionary
  72         calculatedPointPatchField
  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         calculatedPointPatchField
  81         (
  82             const calculatedPointPatchField<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 calculatedPointPatchField<Type>
  94                 (
  95                     *this
  96                 )
  97             );
  98         }
  99
 100         //- Construct as copy setting internal field reference
 101         calculatedPointPatchField
 102         (
 103             const calculatedPointPatchField<Type>&,
 104             const DimensionedField<Type, pointMesh>&
 105         );
 106
 107         //- Construct and return a clone setting internal field reference
 108         virtual autoPtr<pointPatchField<Type> >
 109         clone(const DimensionedField<Type, pointMesh>& iF) const
 110         {
 111             return autoPtr<pointPatchField<Type> >
 112             (
 113                 new calculatedPointPatchField<Type>
 114                 (
 115                     *this,
 116                     iF
 117                 )
 118             );
 119         }
 120 };
 121
 122
 123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 124
 125 } // End namespace Foam
 126
 127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 128
 129 #ifdef NoRepository
 130 #    include "calculatedPointPatchField.C"
 131 #endif
 132
 133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 134
 135 #endif
 136
 137 // ************************************************************************* //