src/sampling/sampledSurface/sampledPlane/sampledPlane.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   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::sampledPlane
  27
  28 Description
  29     A sampledSurface defined by a cuttingPlane. Always triangulated.
  30
  31 SourceFiles
  32     sampledPlane.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef sampledPlane_H
  37 #define sampledPlane_H
  38
  39 #include "sampledSurface.H"
  40 #include "cuttingPlane.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                        Class sampledPlane Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class sampledPlane
  52 :
  53     public sampledSurface,
  54     public cuttingPlane
  55 {
  56     // Private data
  57
  58         //- zone name (if restricted to zones)
  59         word zoneName_;
  60
  61         //- Track if the surface needs an update
  62         mutable bool needsUpdate_;
  63
  64     // Private Member Functions
  65
  66         //- sample field on faces
  67         template <class Type>
  68         tmp<Field<Type> > sampleField
  69         (
  70             const GeometricField<Type, fvPatchField, volMesh>& vField
  71         ) const;
  72
  73
  74         template <class Type>
  75         tmp<Field<Type> >
  76         interpolateField(const interpolation<Type>&) const;
  77
  78
  79 public:
  80
  81     //- Runtime type information
  82     TypeName("sampledPlane");
  83
  84
  85     // Constructors
  86
  87         //- Construct from components
  88         sampledPlane
  89         (
  90             const word& name,
  91             const polyMesh& mesh,
  92             const plane& planeDesc,
  93             const word& zoneName = word::null
  94         );
  95
  96         //- Construct from dictionary
  97         sampledPlane
  98         (
  99             const word& name,
 100             const polyMesh& mesh,
 101             const dictionary& dict
 102         );
 103
 104
 105     // Destructor
 106
 107         virtual ~sampledPlane();
 108
 109
 110     // Member Functions
 111
 112         //- Does the surface need an update?
 113         virtual bool needsUpdate() const;
 114
 115         //- Mark the surface as needing an update.
 116         //  May also free up unneeded data.
 117         //  Return false if surface was already marked as expired.
 118         virtual bool expire();
 119
 120         //- Update the surface as required.
 121         //  Do nothing (and return false) if no update was needed
 122         virtual bool update();
 123
 124
 125         //- Points of surface
 126         virtual const pointField& points() const
 127         {
 128             return cuttingPlane::points();
 129         }
 130
 131         //- Faces of surface
 132         virtual const faceList& faces() const
 133         {
 134             return cuttingPlane::faces();
 135         }
 136
 137         //- For every face original cell in mesh
 138         const labelList& meshCells() const
 139         {
 140             return cuttingPlane::cutCells();
 141         }
 142
 143         //- sample field on surface
 144         virtual tmp<scalarField> sample
 145         (
 146             const volScalarField&
 147         ) const;
 148
 149
 150         //- sample field on surface
 151         virtual tmp<vectorField> sample
 152         (
 153             const volVectorField&
 154         ) const;
 155
 156         //- sample field on surface
 157         virtual tmp<sphericalTensorField> sample
 158         (
 159             const volSphericalTensorField&
 160         ) const;
 161
 162         //- sample field on surface
 163         virtual tmp<symmTensorField> sample
 164         (
 165             const volSymmTensorField&
 166         ) const;
 167
 168         //- sample field on surface
 169         virtual tmp<tensorField> sample
 170         (
 171             const volTensorField&
 172         ) const;
 173
 174
 175         //- interpolate field on surface
 176         virtual tmp<scalarField> interpolate
 177         (
 178             const interpolation<scalar>&
 179         ) const;
 180
 181
 182         //- interpolate field on surface
 183         virtual tmp<vectorField> interpolate
 184         (
 185             const interpolation<vector>&
 186         ) const;
 187
 188         //- interpolate field on surface
 189         virtual tmp<sphericalTensorField> interpolate
 190         (
 191             const interpolation<sphericalTensor>&
 192         ) const;
 193
 194         //- interpolate field on surface
 195         virtual tmp<symmTensorField> interpolate
 196         (
 197             const interpolation<symmTensor>&
 198         ) const;
 199
 200         //- interpolate field on surface
 201         virtual tmp<tensorField> interpolate
 202         (
 203             const interpolation<tensor>&
 204         ) const;
 205
 206         //- Write
 207         virtual void print(Ostream&) const;
 208 };
 209
 210
 211 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 212
 213 } // End namespace Foam
 214
 215 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 216
 217 #ifdef NoRepository
 218 #   include "sampledPlaneTemplates.C"
 219 #endif
 220
 221 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 222
 223 #endif
 224
 225 // ************************************************************************* //