src/sampling/sampledSurface/sampledSurfaces/sampledSurfaces.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::sampledSurfaces
  26
  27 Description
  28     Set of surfaces to sample.
  29
  30     The write() method is used to sample and write files.
  31
  32 SourceFiles
  33     sampledSurfaces.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef sampledSurfaces_H
  38 #define sampledSurfaces_H
  39
  40 #include "sampledSurface.H"
  41 #include "surfaceWriter.H"
  42 #include "volFieldsFwd.H"
  43 #include "wordReList.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 class fvMesh;
  51 class dictionary;
  52
  53 /*---------------------------------------------------------------------------*\
  54                        Class sampledSurfaces Declaration
  55 \*---------------------------------------------------------------------------*/
  56
  57 class sampledSurfaces
  58 :
  59     public PtrList<sampledSurface>
  60 {
  61     // Private classes
  62
  63         //- Class used for grouping field types
  64         template<class Type>
  65         class fieldGroup
  66         :
  67             public DynamicList<word>
  68         {
  69         public:
  70
  71             //- Construct null
  72             fieldGroup()
  73             :
  74                 DynamicList<word>(0)
  75             {}
  76         };
  77
  78
  79         //- Class used for surface merging information
  80         class mergeInfo
  81         {
  82         public:
  83             pointField points;
  84             faceList   faces;
  85             labelList  pointsMap;
  86
  87             //- Clear all storage
  88             void clear()
  89             {
  90                 points.clear();
  91                 faces.clear();
  92                 pointsMap.clear();
  93             }
  94         };
  95
  96
  97     // Static data members
  98
  99         //- output verbosity
 100         static bool verbose_;
 101
 102         //- Tolerance for merging points (fraction of mesh bounding box)
 103         static scalar mergeTol_;
 104
 105     // Private data
 106
 107         //- Name of this set of surfaces,
 108         //  Also used as the name of the sampledSurfaces directory.
 109         const word name_;
 110
 111         //- Const reference to fvMesh
 112         const fvMesh& mesh_;
 113
 114         //- Load fields from files (not from objectRegistry)
 115         const bool loadFromFiles_;
 116
 117         //- output path
 118         fileName outputPath_;
 119
 120
 121         // Read from dictonary
 122
 123             //- Names of fields to sample
 124             wordReList fieldSelection_;
 125
 126             //- Interpolation scheme to use
 127             word interpolationScheme_;
 128
 129         // surfaces
 130
 131             //- Information for merging surfaces
 132             List<mergeInfo> mergeList_;
 133
 134
 135         // Calculated
 136
 137             //- Surface formatter
 138             autoPtr<surfaceWriter> formatter_;
 139
 140             //- Categorized scalar/vector/tensor fields
 141             fieldGroup<scalar> scalarFields_;
 142             fieldGroup<vector> vectorFields_;
 143             fieldGroup<sphericalTensor> sphericalTensorFields_;
 144             fieldGroup<symmTensor> symmTensorFields_;
 145             fieldGroup<tensor> tensorFields_;
 146
 147
 148     // Private Member Functions
 149
 150         //- Clear old field groups
 151         void clearFieldGroups();
 152
 153         //- Append fieldName to the appropriate group
 154         label appendFieldGroup(const word& fieldName, const word& fieldType);
 155
 156         //- Classify field types, returns the number of fields
 157         label classifyFields();
 158
 159         //- Write geometry only
 160         void writeGeometry() const;
 161
 162         //- Sample and write a particular volume field
 163         template<class Type>
 164         void sampleAndWrite(const GeometricField<Type, fvPatchField, volMesh>&);
 165
 166         //- Sample and write all the fields of the given type
 167         template<class Type>
 168         void sampleAndWrite(fieldGroup<Type>&);
 169
 170         //- Disallow default bitwise copy construct and assignment
 171         sampledSurfaces(const sampledSurfaces&);
 172         void operator=(const sampledSurfaces&);
 173
 174
 175 public:
 176
 177     //- Runtime type information
 178     TypeName("surfaces");
 179
 180
 181     // Constructors
 182
 183         //- Construct for given objectRegistry and dictionary
 184         //  allow the possibility to load fields from files
 185         sampledSurfaces
 186         (
 187             const word& name,
 188             const objectRegistry&,
 189             const dictionary&,
 190             const bool loadFromFiles = false
 191         );
 192
 193
 194     //- Destructor
 195     virtual ~sampledSurfaces();
 196
 197
 198     // Member Functions
 199
 200         //- Does any of the surfaces need an update?
 201         virtual bool needsUpdate() const;
 202
 203         //- Mark the surfaces as needing an update.
 204         //  May also free up unneeded data.
 205         //  Return false if all surfaces were already marked as expired.
 206         virtual bool expire();
 207
 208         //- Update the surfaces as required and merge surface points (parallel).
 209         //  Return false if no surfaces required an update.
 210         virtual bool update();
 211
 212
 213         //- Return name of the set of surfaces
 214         virtual const word& name() const
 215         {
 216             return name_;
 217         }
 218
 219         //- set verbosity level
 220         void verbose(const bool verbosity = true);
 221
 222         //- Execute, currently does nothing
 223         virtual void execute();
 224
 225         //- Execute at the final time-loop, currently does nothing
 226         virtual void end();
 227
 228         //- Sample and write
 229         virtual void write();
 230
 231         //- Read the sampledSurfaces dictionary
 232         virtual void read(const dictionary&);
 233
 234         //- Update for changes of mesh - expires the surfaces
 235         virtual void updateMesh(const mapPolyMesh&);
 236
 237         //- Update for mesh point-motion - expires the surfaces
 238         virtual void movePoints(const pointField&);
 239
 240         //- Update for changes of mesh due to readUpdate - expires the surfaces
 241         virtual void readUpdate(const polyMesh::readUpdateState state);
 242
 243 };
 244
 245
 246 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 247
 248 } // End namespace Foam
 249
 250 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 251
 252 #ifdef NoRepository
 253 #   include "sampledSurfacesTemplates.C"
 254 #endif
 255
 256 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 257
 258 #endif
 259
 260 // ************************************************************************* //