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