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