src/sampling/sampledSurface/isoSurface/sampledIsoSurface.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::sampledIsoSurface
  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     sampledIsoSurface.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef sampledIsoSurface_H
  39 #define sampledIsoSurface_H
  40
  41 #include "isoSurface.H"
  42 #include "sampledSurface.H"
  43 #include "ZoneIDs.H"
  44 #include "fvMeshSubset.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52                        Class sampledIsoSurface Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class sampledIsoSurface
  56 :
  57     public sampledSurface
  58 {
  59     // Private data
  60
  61         //- Field to get isoSurface of
  62         const word isoField_;
  63
  64         //- iso value
  65         const scalar isoVal_;
  66
  67         //- Merge tolerance
  68         const scalar mergeTol_;
  69
  70         //- Whether to coarse
  71         const Switch regularise_;
  72
  73         //- Whether to recalculate cell values as average of point values
  74         const Switch average_;
  75
  76         //- zone name/index (if restricted to zones)
  77         mutable cellZoneID zoneID_;
  78
  79         //- for zones: patch to put exposed faces into
  80         mutable word exposedPatchName_;
  81
  82         mutable autoPtr<isoSurface> surfPtr_;
  83
  84         //- triangles converted to faceList
  85         mutable autoPtr<faceList> facesPtr_;
  86
  87
  88         // Recreated for every isoSurface
  89
  90             //- Time at last call, also track if surface needs an update
  91             mutable label prevTimeIndex_;
  92
  93             //- Cached volfield
  94             mutable autoPtr<volScalarField> storedVolFieldPtr_;
  95             mutable const volScalarField* volFieldPtr_;
  96
  97             //- Cached pointfield
  98             mutable autoPtr<pointScalarField> storedPointFieldPtr_;
  99             mutable const pointScalarField* pointFieldPtr_;
 100
 101             // And on subsetted mesh
 102
 103                 //- Cached submesh
 104                 mutable autoPtr<fvMeshSubset> subMeshPtr_;
 105
 106                 //- Cached volfield
 107                 mutable autoPtr<volScalarField> storedVolSubFieldPtr_;
 108                 mutable const volScalarField* volSubFieldPtr_;
 109
 110                 //- Cached pointfield
 111                 mutable autoPtr<pointScalarField> storedPointSubFieldPtr_;
 112                 mutable const pointScalarField* pointSubFieldPtr_;
 113
 114
 115
 116     // Private Member Functions
 117
 118         //- Get fields needed to recreate iso surface.
 119         void getIsoFields() const;
 120
 121         tmp<volScalarField> average
 122         (
 123             const fvMesh&,
 124             const pointScalarField&
 125         ) const;
 126
 127         tmp<pointScalarField> average
 128         (
 129             const pointMesh&,
 130             const volScalarField& fld
 131         ) const;
 132
 133         //- Create iso surface (if time has changed)
 134         //  Do nothing (and return false) if no update was needed
 135         bool updateGeometry() const;
 136
 137         //- sample field on faces
 138         template <class Type>
 139         tmp<Field<Type> > sampleField
 140         (
 141             const GeometricField<Type, fvPatchField, volMesh>& vField
 142         ) const;
 143
 144
 145         template <class Type>
 146         tmp<Field<Type> >
 147         interpolateField(const interpolation<Type>&) const;
 148
 149
 150 public:
 151
 152     //- Runtime type information
 153     TypeName("sampledIsoSurface");
 154
 155
 156     // Constructors
 157
 158         //- Construct from dictionary
 159         sampledIsoSurface
 160         (
 161             const word& name,
 162             const polyMesh& mesh,
 163             const dictionary& dict
 164         );
 165
 166
 167     // Destructor
 168
 169         virtual ~sampledIsoSurface();
 170
 171
 172     // Member Functions
 173
 174         //- Does the surface need an update?
 175         virtual bool needsUpdate() const;
 176
 177         //- Mark the surface as needing an update.
 178         //  May also free up unneeded data.
 179         //  Return false if surface was already marked as expired.
 180         virtual bool expire();
 181
 182         //- Update the surface as required.
 183         //  Do nothing (and return false) if no update was needed
 184         virtual bool update();
 185
 186
 187         //- Points of surface
 188         virtual const pointField& points() const
 189         {
 190             return surface().points();
 191         }
 192
 193         //- Faces of surface
 194         virtual const faceList& faces() const
 195         {
 196             if (facesPtr_.empty())
 197             {
 198                 const triSurface& s = surface();
 199
 200                 facesPtr_.reset(new faceList(s.size()));
 201
 202                 forAll(s, i)
 203                 {
 204                     facesPtr_()[i] = s[i].triFaceFace();
 205                 }
 206             }
 207             return facesPtr_;
 208         }
 209
 210
 211         const isoSurface& surface() const
 212         {
 213             return surfPtr_();
 214         }
 215
 216         //- Lookup or read isoField. Sets volFieldPtr_ and pointFieldPtr_.
 217         void getIsoField();
 218
 219
 220         //- sample field on surface
 221         virtual tmp<scalarField> sample
 222         (
 223             const volScalarField&
 224         ) const;
 225
 226         //- sample field on surface
 227         virtual tmp<vectorField> sample
 228         (
 229             const volVectorField&
 230         ) const;
 231
 232         //- sample field on surface
 233         virtual tmp<sphericalTensorField> sample
 234         (
 235             const volSphericalTensorField&
 236         ) const;
 237
 238         //- sample field on surface
 239         virtual tmp<symmTensorField> sample
 240         (
 241             const volSymmTensorField&
 242         ) const;
 243
 244         //- sample field on surface
 245         virtual tmp<tensorField> sample
 246         (
 247             const volTensorField&
 248         ) const;
 249
 250
 251         //- interpolate field on surface
 252         virtual tmp<scalarField> interpolate
 253         (
 254             const interpolation<scalar>&
 255         ) const;
 256
 257         //- interpolate field on surface
 258         virtual tmp<vectorField> interpolate
 259         (
 260             const interpolation<vector>&
 261         ) const;
 262
 263         //- interpolate field on surface
 264         virtual tmp<sphericalTensorField> interpolate
 265         (
 266             const interpolation<sphericalTensor>&
 267         ) const;
 268
 269         //- interpolate field on surface
 270         virtual tmp<symmTensorField> interpolate
 271         (
 272             const interpolation<symmTensor>&
 273         ) const;
 274
 275         //- interpolate field on surface
 276         virtual tmp<tensorField> interpolate
 277         (
 278             const interpolation<tensor>&
 279         ) const;
 280
 281         //- Write
 282         virtual void print(Ostream&) const;
 283 };
 284
 285
 286 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 287
 288 } // End namespace Foam
 289
 290 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 291
 292 #ifdef NoRepository
 293 #   include "sampledIsoSurfaceTemplates.C"
 294 #endif
 295
 296 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 297
 298 #endif
 299
 300 // ************************************************************************* //