src/sampling/sampledSurface/distanceSurface/distanceSurface.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::distanceSurface
  26
  27 Description
  28     A sampledSurface defined by a distance to a surface.
  29
  30 SourceFiles
  31     distanceSurface.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef distanceSurface_H
  36 #define distanceSurface_H
  37
  38 #include "sampledSurface.H"
  39 #include "searchableSurface.H"
  40 //#include "isoSurfaceCell.H"
  41 #include "isoSurface.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                        Class distanceSurface Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class distanceSurface
  53 :
  54     public sampledSurface
  55 {
  56     // Private data
  57
  58         //- Surface
  59         const autoPtr<searchableSurface> surfPtr_;
  60
  61         //- distance value
  62         const scalar distance_;
  63
  64         //- signed distance
  65         const bool signed_;
  66
  67         //- Whether to coarsen
  68         const Switch regularise_;
  69
  70         //- Whether to recalculate cell values as average of point values
  71         const Switch average_;
  72
  73         //- If restricted to zones, name of this zone or a regular expression
  74         keyType zoneKey_;
  75
  76         //- Track if the surface needs an update
  77         mutable bool needsUpdate_;
  78
  79
  80         //- Distance to cell centres
  81         autoPtr<volScalarField> cellDistancePtr_;
  82
  83         //- Distance to points
  84         scalarField pointDistance_;
  85
  86         //- Constructed iso surface
  87         //autoPtr<isoSurfaceCell> isoSurfPtr_;
  88         autoPtr<isoSurface> isoSurfPtr_;
  89
  90         //- triangles converted to faceList
  91         mutable autoPtr<faceList> facesPtr_;
  92
  93
  94     // Private Member Functions
  95
  96         //- Create iso surface
  97         void createGeometry();
  98
  99         //- sample field on faces
 100         template <class Type>
 101         tmp<Field<Type> > sampleField
 102         (
 103             const GeometricField<Type, fvPatchField, volMesh>& vField
 104         ) const;
 105
 106
 107         template <class Type>
 108         tmp<Field<Type> >
 109         interpolateField(const interpolation<Type>&) const;
 110
 111
 112 public:
 113
 114     //- Runtime type information
 115     TypeName("distanceSurface");
 116
 117
 118     // Constructors
 119
 120         //- Construct from dictionary
 121         distanceSurface
 122         (
 123             const word& name,
 124             const polyMesh& mesh,
 125             const dictionary& dict
 126         );
 127
 128
 129     //- Destructor
 130     virtual ~distanceSurface();
 131
 132
 133     // Member Functions
 134
 135         //- Does the surface need an update?
 136         virtual bool needsUpdate() const;
 137
 138         //- Mark the surface as needing an update.
 139         //  May also free up unneeded data.
 140         //  Return false if surface was already marked as expired.
 141         virtual bool expire();
 142
 143         //- Update the surface as required.
 144         //  Do nothing (and return false) if no update was needed
 145         virtual bool update();
 146
 147         //- Points of surface
 148         virtual const pointField& points() const
 149         {
 150             return surface().points();
 151         }
 152
 153         //- Faces of surface
 154         virtual const faceList& faces() const
 155         {
 156             if (facesPtr_.empty())
 157             {
 158                 const triSurface& s = surface();
 159
 160                 facesPtr_.reset(new faceList(s.size()));
 161
 162                 forAll(s, i)
 163                 {
 164                     facesPtr_()[i] = s[i].triFaceFace();
 165                 }
 166             }
 167             return facesPtr_;
 168         }
 169
 170
 171         //const isoSurfaceCell& surface() const
 172         const isoSurface& surface() const
 173         {
 174             return isoSurfPtr_();
 175         }
 176
 177         //- sample field on surface
 178         virtual tmp<scalarField> sample
 179         (
 180             const volScalarField&
 181         ) const;
 182
 183         //- sample field on surface
 184         virtual tmp<vectorField> sample
 185         (
 186             const volVectorField&
 187         ) const;
 188
 189         //- sample field on surface
 190         virtual tmp<sphericalTensorField> sample
 191         (
 192             const volSphericalTensorField&
 193         ) const;
 194
 195         //- sample field on surface
 196         virtual tmp<symmTensorField> sample
 197         (
 198             const volSymmTensorField&
 199         ) const;
 200
 201         //- sample field on surface
 202         virtual tmp<tensorField> sample
 203         (
 204             const volTensorField&
 205         ) const;
 206
 207
 208         //- interpolate field on surface
 209         virtual tmp<scalarField> interpolate
 210         (
 211             const interpolation<scalar>&
 212         ) const;
 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 "distanceSurfaceTemplates.C"
 251 #endif
 252
 253 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 254
 255 #endif
 256
 257 // ************************************************************************* //