src/sampling/sampledSurface/sampledPlane/sampledPlane.C

   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 \*---------------------------------------------------------------------------*/
  26
  27 #include "sampledPlane.H"
  28 #include "dictionary.H"
  29 #include "polyMesh.H"
  30 #include "volFields.H"
  31
  32 #include "addToRunTimeSelectionTable.H"
  33
  34 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  35
  36 namespace Foam
  37 {
  38     defineTypeNameAndDebug(sampledPlane, 0);
  39     addNamedToRunTimeSelectionTable(sampledSurface, sampledPlane, word, plane);
  40 }
  41
  42 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  43
  44 Foam::sampledPlane::sampledPlane
  45 (
  46     const word& name,
  47     const polyMesh& mesh,
  48     const plane& planeDesc,
  49     const word& zoneName
  50 )
  51 :
  52     sampledSurface(name, mesh),
  53     cuttingPlane(planeDesc),
  54     zoneName_(zoneName),
  55     needsUpdate_(true)
  56 {
  57     if (debug && zoneName_.size())
  58     {
  59         if (mesh.cellZones().findZoneID(zoneName_) < 0)
  60         {
  61             Info<< "cellZone \"" << zoneName_
  62                 << "\" not found - using entire mesh" << endl;
  63         }
  64     }
  65 }
  66
  67
  68 Foam::sampledPlane::sampledPlane
  69 (
  70     const word& name,
  71     const polyMesh& mesh,
  72     const dictionary& dict
  73 )
  74 :
  75     sampledSurface(name, mesh, dict),
  76     cuttingPlane(plane(dict.lookup("basePoint"), dict.lookup("normalVector"))),
  77     zoneName_(word::null),
  78     needsUpdate_(true)
  79 {
  80     // make plane relative to the coordinateSystem (Cartesian)
  81     // allow lookup from global coordinate systems
  82     if (dict.found("coordinateSystem"))
  83     {
  84         coordinateSystem cs(dict, mesh);
  85
  86         point  base = cs.globalPosition(planeDesc().refPoint());
  87         vector norm = cs.globalVector(planeDesc().normal());
  88
  89         // assign the plane description
  90         static_cast<plane&>(*this) = plane(base, norm);
  91     }
  92
  93     dict.readIfPresent("zone", zoneName_);
  94
  95     if (debug && zoneName_.size())
  96     {
  97         if (mesh.cellZones().findZoneID(zoneName_) < 0)
  98         {
  99             Info<< "cellZone \"" << zoneName_
 100                 << "\" not found - using entire mesh" << endl;
 101         }
 102     }
 103
 104 }
 105
 106
 107 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
 108
 109 Foam::sampledPlane::~sampledPlane()
 110 {}
 111
 112
 113 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 114
 115 bool Foam::sampledPlane::needsUpdate() const
 116 {
 117     return needsUpdate_;
 118 }
 119
 120
 121 bool Foam::sampledPlane::expire()
 122 {
 123     // already marked as expired
 124     if (needsUpdate_)
 125     {
 126         return false;
 127     }
 128
 129     sampledSurface::clearGeom();
 130
 131     needsUpdate_ = true;
 132     return true;
 133 }
 134
 135
 136 bool Foam::sampledPlane::update()
 137 {
 138     if (!needsUpdate_)
 139     {
 140         return false;
 141     }
 142
 143     sampledSurface::clearGeom();
 144
 145     label zoneId = -1;
 146     if (zoneName_.size())
 147     {
 148         zoneId = mesh().cellZones().findZoneID(zoneName_);
 149     }
 150
 151     if (zoneId < 0)
 152     {
 153         reCut(mesh());
 154     }
 155     else
 156     {
 157         reCut(mesh(), mesh().cellZones()[zoneId]);
 158     }
 159
 160     if (debug)
 161     {
 162         print(Pout);
 163         Pout << endl;
 164     }
 165
 166     needsUpdate_ = false;
 167     return true;
 168 }
 169
 170
 171 Foam::tmp<Foam::scalarField>
 172 Foam::sampledPlane::sample
 173 (
 174     const volScalarField& vField
 175 ) const
 176 {
 177     return sampleField(vField);
 178 }
 179
 180
 181 Foam::tmp<Foam::vectorField>
 182 Foam::sampledPlane::sample
 183 (
 184     const volVectorField& vField
 185 ) const
 186 {
 187     return sampleField(vField);
 188 }
 189
 190
 191 Foam::tmp<Foam::sphericalTensorField>
 192 Foam::sampledPlane::sample
 193 (
 194     const volSphericalTensorField& vField
 195 ) const
 196 {
 197     return sampleField(vField);
 198 }
 199
 200
 201 Foam::tmp<Foam::symmTensorField>
 202 Foam::sampledPlane::sample
 203 (
 204     const volSymmTensorField& vField
 205 ) const
 206 {
 207     return sampleField(vField);
 208 }
 209
 210
 211 Foam::tmp<Foam::tensorField>
 212 Foam::sampledPlane::sample
 213 (
 214     const volTensorField& vField
 215 ) const
 216 {
 217     return sampleField(vField);
 218 }
 219
 220
 221 Foam::tmp<Foam::scalarField>
 222 Foam::sampledPlane::interpolate
 223 (
 224     const interpolation<scalar>& interpolator
 225 ) const
 226 {
 227     return interpolateField(interpolator);
 228 }
 229
 230
 231 Foam::tmp<Foam::vectorField>
 232 Foam::sampledPlane::interpolate
 233 (
 234     const interpolation<vector>& interpolator
 235 ) const
 236 {
 237     return interpolateField(interpolator);
 238 }
 239
 240 Foam::tmp<Foam::sphericalTensorField>
 241 Foam::sampledPlane::interpolate
 242 (
 243     const interpolation<sphericalTensor>& interpolator
 244 ) const
 245 {
 246     return interpolateField(interpolator);
 247 }
 248
 249
 250 Foam::tmp<Foam::symmTensorField>
 251 Foam::sampledPlane::interpolate
 252 (
 253     const interpolation<symmTensor>& interpolator
 254 ) const
 255 {
 256     return interpolateField(interpolator);
 257 }
 258
 259
 260 Foam::tmp<Foam::tensorField>
 261 Foam::sampledPlane::interpolate
 262 (
 263     const interpolation<tensor>& interpolator
 264 ) const
 265 {
 266     return interpolateField(interpolator);
 267 }
 268
 269
 270 void Foam::sampledPlane::print(Ostream& os) const
 271 {
 272     os  << "sampledPlane: " << name() << " :"
 273         << "  base:" << refPoint()
 274         << "  normal:" << normal()
 275         << "  faces:" << faces().size()
 276         << "  points:" << points().size();
 277 }
 278
 279
 280 // ************************************************************************* //