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