src/sampling/sampledSurface/sampledPatch/sampledPatch.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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::sampledPatch
  27
  28 Description
  29     A sampledSurface on a patch. Non-triangulated by default.
  30
  31 SourceFiles
  32     sampledPatch.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef sampledPatch_H
  37 #define sampledPatch_H
  38
  39 #include "sampledSurface.H"
  40 #include "MeshedSurface.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                        Class sampledPatch Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class sampledPatch
  52 :
  53     public MeshedSurface<face>,
  54     public sampledSurface
  55 {
  56     //- Private typedefs for convenience
  57         typedef MeshedSurface<face> MeshStorage;
  58
  59     // Private data
  60
  61         //- Name of patch
  62         const word patchName_;
  63
  64         //- Triangulated faces or keep faces as is
  65         bool triangulate_;
  66
  67         //- Track if the surface needs an update
  68         mutable bool needsUpdate_;
  69
  70         //- Local patch face labels
  71         labelList patchFaceLabels_;
  72
  73     // Private Member Functions
  74
  75
  76         //- sample field on faces
  77         template <class Type>
  78         tmp<Field<Type> > sampleField
  79         (
  80             const GeometricField<Type, fvPatchField, volMesh>& vField
  81         ) const;
  82
  83
  84         template <class Type>
  85         tmp<Field<Type> >
  86         interpolateField(const interpolation<Type>&) const;
  87
  88
  89         //- remap action on triangulation or cleanup
  90         virtual void remapFaces(const UList<label>& faceMap);
  91
  92 public:
  93
  94     //- Runtime type information
  95     TypeName("sampledPatch");
  96
  97
  98     // Constructors
  99
 100         //- Construct from components
 101         sampledPatch
 102         (
 103             const word& name,
 104             const polyMesh& mesh,
 105             const word& patchName,
 106             const bool triangulate = false
 107         );
 108
 109         //- Construct from dictionary
 110         sampledPatch
 111         (
 112             const word& name,
 113             const polyMesh& mesh,
 114             const dictionary& dict
 115         );
 116
 117
 118     // Destructor
 119
 120         virtual ~sampledPatch();
 121
 122
 123     // Member Functions
 124
 125         //- Does the surface need an update?
 126         virtual bool needsUpdate() const;
 127
 128         //- Mark the surface as needing an update.
 129         //  May also free up unneeded data.
 130         //  Return false if surface was already marked as expired.
 131         virtual bool expire();
 132
 133         //- Update the surface as required.
 134         //  Do nothing (and return false) if no update was needed
 135         virtual bool update();
 136
 137
 138         const word patchName() const
 139         {
 140             return patchName_;
 141         }
 142
 143         label patchIndex() const
 144         {
 145             return mesh().boundaryMesh().findPatchID(patchName_);
 146         }
 147
 148         const labelList& patchFaceLabels() const
 149         {
 150             return patchFaceLabels_;
 151         }
 152
 153         //- Points of surface
 154         virtual const pointField& points() const
 155         {
 156             return MeshStorage::points();
 157         }
 158
 159         //- Faces of surface
 160         virtual const faceList& faces() const
 161         {
 162             return MeshStorage::faces();
 163         }
 164
 165
 166         //- sample field on surface
 167         virtual tmp<scalarField> sample
 168         (
 169             const volScalarField&
 170         ) const;
 171
 172         //- sample field on surface
 173         virtual tmp<vectorField> sample
 174         (
 175             const volVectorField&
 176         ) const;
 177
 178         //- sample field on surface
 179         virtual tmp<sphericalTensorField> sample
 180         (
 181             const volSphericalTensorField&
 182         ) const;
 183
 184         //- sample field on surface
 185         virtual tmp<symmTensorField> sample
 186         (
 187             const volSymmTensorField&
 188         ) const;
 189
 190         //- sample field on surface
 191         virtual tmp<tensorField> sample
 192         (
 193             const volTensorField&
 194         ) const;
 195
 196
 197         //- interpolate field on surface
 198         virtual tmp<scalarField> interpolate
 199         (
 200             const interpolation<scalar>&
 201         ) const;
 202
 203
 204         //- interpolate field on surface
 205         virtual tmp<vectorField> interpolate
 206         (
 207             const interpolation<vector>&
 208         ) const;
 209
 210         //- interpolate field on surface
 211         virtual tmp<sphericalTensorField> interpolate
 212         (
 213             const interpolation<sphericalTensor>&
 214         ) const;
 215
 216         //- interpolate field on surface
 217         virtual tmp<symmTensorField> interpolate
 218         (
 219             const interpolation<symmTensor>&
 220         ) const;
 221
 222         //- interpolate field on surface
 223         virtual tmp<tensorField> interpolate
 224         (
 225             const interpolation<tensor>&
 226         ) const;
 227
 228         //- Write
 229         virtual void print(Ostream&) const;
 230 };
 231
 232
 233 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 234
 235 } // End namespace Foam
 236
 237 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 238
 239 #ifdef NoRepository
 240 #   include "sampledPatchTemplates.C"
 241 #endif
 242
 243 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 244
 245 #endif
 246
 247 // ************************************************************************* //