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