src/sampling/sampledSurface/isoSurface/sampledIsoSurfaceCell.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::sampledIsoSurfaceCell
  27
  28 Description
  29     A sampledSurface defined by a surface of iso value. Always triangulated.
  30     To be used in sampleSurfaces / functionObjects. Recalculates iso surface
  31     only if time changes.
  32
  33 SourceFiles
  34     sampledIsoSurfaceCell.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef sampledIsoSurfaceCell_H
  39 #define sampledIsoSurfaceCell_H
  40
  41 #include "sampledSurface.H"
  42 #include "triSurface.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                     Class sampledIsoSurfaceCell Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class sampledIsoSurfaceCell
  54 :
  55     public sampledSurface,
  56     public triSurface
  57 {
  58     // Private data
  59
  60         //- Field to get isoSurface of
  61         const word isoField_;
  62
  63         //- iso value
  64         const scalar isoVal_;
  65
  66         //- Whether to coarse
  67         const Switch regularise_;
  68
  69         //- Whether to recalculate cell values as average of point values
  70         const Switch average_;
  71
  72         //- zone name (if restricted to zones)
  73         word zoneName_;
  74
  75         //- triangles converted to faceList
  76         mutable autoPtr<faceList> facesPtr_;
  77
  78
  79         // Recreated for every isoSurface
  80
  81             //- Time at last call, also track it surface needs an update
  82             mutable label prevTimeIndex_;
  83
  84             //- For every triangle the original cell in mesh
  85             mutable labelList meshCells_;
  86
  87
  88     // Private Member Functions
  89
  90         //- Create iso surface (if time has changed)
  91         //  Do nothing (and return false) if no update was needed
  92         bool updateGeometry() const;
  93
  94         //- sample field on faces
  95         template <class Type>
  96         tmp<Field<Type> > sampleField
  97         (
  98             const GeometricField<Type, fvPatchField, volMesh>& vField
  99         ) const;
 100
 101
 102         template <class Type>
 103         tmp<Field<Type> >
 104         interpolateField(const interpolation<Type>&) const;
 105
 106
 107 public:
 108
 109     //- Runtime type information
 110     TypeName("sampledIsoSurfaceCell");
 111
 112
 113     // Constructors
 114
 115         //- Construct from dictionary
 116         sampledIsoSurfaceCell
 117         (
 118             const word& name,
 119             const polyMesh& mesh,
 120             const dictionary& dict
 121         );
 122
 123
 124     // Destructor
 125
 126         virtual ~sampledIsoSurfaceCell();
 127
 128
 129     // Member Functions
 130
 131         //- Does the surface need an update?
 132         virtual bool needsUpdate() const;
 133
 134         //- Mark the surface as needing an update.
 135         //  May also free up unneeded data.
 136         //  Return false if surface was already marked as expired.
 137         virtual bool expire();
 138
 139         //- Update the surface as required.
 140         //  Do nothing (and return false) if no update was needed
 141         virtual bool update();
 142
 143
 144         //- Points of surface
 145         virtual const pointField& points() const
 146         {
 147             return triSurface::points();
 148         }
 149
 150         //- Faces of surface
 151         virtual const faceList& faces() const
 152         {
 153             if (facesPtr_.empty())
 154             {
 155                 const triSurface& s = *this;
 156
 157                 facesPtr_.reset(new faceList(s.size()));
 158
 159                 forAll(s, i)
 160                 {
 161                     facesPtr_()[i] = s[i].triFaceFace();
 162                 }
 163             }
 164             return facesPtr_;
 165         }
 166
 167
 168         //- sample field on surface
 169         virtual tmp<scalarField> sample
 170         (
 171             const volScalarField&
 172         ) const;
 173
 174         //- sample field on surface
 175         virtual tmp<vectorField> sample
 176         (
 177             const volVectorField&
 178         ) const;
 179
 180         //- sample field on surface
 181         virtual tmp<sphericalTensorField> sample
 182         (
 183             const volSphericalTensorField&
 184         ) const;
 185
 186         //- sample field on surface
 187         virtual tmp<symmTensorField> sample
 188         (
 189             const volSymmTensorField&
 190         ) const;
 191
 192         //- sample field on surface
 193         virtual tmp<tensorField> sample
 194         (
 195             const volTensorField&
 196         ) const;
 197
 198
 199         //- interpolate field on surface
 200         virtual tmp<scalarField> interpolate
 201         (
 202             const interpolation<scalar>&
 203         ) const;
 204
 205         //- interpolate field on surface
 206         virtual tmp<vectorField> interpolate
 207         (
 208             const interpolation<vector>&
 209         ) const;
 210
 211         //- interpolate field on surface
 212         virtual tmp<sphericalTensorField> interpolate
 213         (
 214             const interpolation<sphericalTensor>&
 215         ) const;
 216
 217         //- interpolate field on surface
 218         virtual tmp<symmTensorField> interpolate
 219         (
 220             const interpolation<symmTensor>&
 221         ) const;
 222
 223         //- interpolate field on surface
 224         virtual tmp<tensorField> interpolate
 225         (
 226             const interpolation<tensor>&
 227         ) const;
 228
 229         //- Write
 230         virtual void print(Ostream&) const;
 231 };
 232
 233
 234 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 235
 236 } // End namespace Foam
 237
 238 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 239
 240 #ifdef NoRepository
 241 #   include "sampledIsoSurfaceCellTemplates.C"
 242 #endif
 243
 244 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 245
 246 #endif
 247
 248 // ************************************************************************* //