src/sampling/probes/probes.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::probes
  27
  28 Description
  29     Set of locations to sample.
  30
  31     Call write() to sample and write files.
  32
  33 SourceFiles
  34     probes.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef probes_H
  39 #define probes_H
  40
  41 #include "HashPtrTable.H"
  42 #include "OFstream.H"
  43 #include "polyMesh.H"
  44 #include "pointField.H"
  45 #include "volFieldsFwd.H"
  46
  47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  48
  49 namespace Foam
  50 {
  51
  52 // Forward declaration of classes
  53 class objectRegistry;
  54 class dictionary;
  55 class fvMesh;
  56 class mapPolyMesh;
  57
  58 /*---------------------------------------------------------------------------*\
  59                           Class probes Declaration
  60 \*---------------------------------------------------------------------------*/
  61
  62 class probes
  63 {
  64     // Private classes
  65
  66         //- Class used for grouping field types
  67         template<class Type>
  68         class fieldGroup
  69         :
  70             public wordList
  71         {
  72         public:
  73             //- Construct null
  74             fieldGroup()
  75             :
  76                 wordList()
  77             {}
  78
  79             //- Construct for a list of field names
  80             fieldGroup(const wordList& fieldNames)
  81             :
  82                 wordList(fieldNames)
  83             {}
  84         };
  85
  86
  87     // Private data
  88
  89         //- Name of this set of probes,
  90         //  Also used as the name of the probes directory.
  91         word name_;
  92
  93         //- Const reference to objectRegistry
  94         const objectRegistry& obr_;
  95
  96         //- Load fields from files (not from objectRegistry)
  97         bool loadFromFiles_;
  98
  99
 100         // Read from dictonary
 101
 102             //- Names of fields to probe
 103             wordList fieldNames_;
 104
 105             //- Locations to probe
 106             vectorField probeLocations_;
 107
 108
 109         // Calculated
 110
 111             //- Categorized scalar/vector/tensor fields
 112             fieldGroup<scalar> scalarFields_;
 113             fieldGroup<vector> vectorFields_;
 114             fieldGroup<sphericalTensor> sphericalTensorFields_;
 115             fieldGroup<symmTensor> symmTensorFields_;
 116             fieldGroup<tensor> tensorFields_;
 117
 118             // Cells to be probed (obtained from the locations)
 119             labelList cellList_;
 120
 121             //- Current open files
 122             HashPtrTable<OFstream> probeFilePtrs_;
 123
 124
 125     // Private Member Functions
 126
 127         //- Find cells containing probes
 128         void findCells(const fvMesh&);
 129
 130         //- classify field types, return true if nFields > 0
 131         bool checkFieldTypes();
 132
 133         //- Find the fields in the list of the given type, return count
 134         template<class Type>
 135         label countFields
 136         (
 137             fieldGroup<Type>& fieldList,
 138             const wordList& fieldTypes
 139         ) const;
 140
 141         //- Sample and write a particular volume field
 142         template<class Type>
 143         void sampleAndWrite
 144         (
 145             const GeometricField<Type, fvPatchField, volMesh>&
 146         );
 147
 148         //- Sample and write all the fields of the given type
 149         template <class Type>
 150         void sampleAndWrite(const fieldGroup<Type>&);
 151
 152         //- Disallow default bitwise copy construct
 153         probes(const probes&);
 154
 155         //- Disallow default bitwise assignment
 156         void operator=(const probes&);
 157
 158
 159 public:
 160
 161     //- Runtime type information
 162     TypeName("probes");
 163
 164
 165     // Constructors
 166
 167         //- Construct for given objectRegistry and dictionary.
 168         //  Allow the possibility to load fields from files
 169         probes
 170         (
 171             const word& name,
 172             const objectRegistry&,
 173             const dictionary&,
 174             const bool loadFromFiles = false
 175         );
 176
 177
 178     // Destructor
 179
 180         virtual ~probes();
 181
 182
 183     // Member Functions
 184
 185         //- Return name of the set of probes
 186         virtual const word& name() const
 187         {
 188             return name_;
 189         }
 190
 191         //- Return names of fields to probe
 192         virtual const wordList& fieldNames() const
 193         {
 194             return fieldNames_;
 195         }
 196
 197         //- Return locations to probe
 198         virtual const vectorField& probeLocations() const
 199         {
 200             return probeLocations_;
 201         }
 202
 203         //- Cells to be probed (obtained from the locations)
 204         const labelList& cells() const
 205         {
 206             return cellList_;
 207         }
 208
 209         //- Execute, currently does nothing
 210         virtual void execute();
 211
 212         //- Execute at the final time-loop, currently does nothing
 213         virtual void end();
 214
 215         //- Sample and write
 216         virtual void write();
 217
 218         //- Read the probes
 219         virtual void read(const dictionary&);
 220
 221         //- Update for changes of mesh
 222         virtual void updateMesh(const mapPolyMesh&)
 223         {}
 224
 225         //- Update for changes of mesh
 226         virtual void movePoints(const pointField&)
 227         {}
 228
 229         //- Update for changes of mesh due to readUpdate
 230         virtual void readUpdate(const polyMesh::readUpdateState state)
 231         {}
 232
 233         //- Sample a volume field at all locations
 234         template<class Type>
 235         tmp<Field<Type> > sample
 236         (
 237             const GeometricField<Type, fvPatchField, volMesh>&
 238         ) const;
 239
 240         //- Sample a single field on all sample locations
 241         template <class Type>
 242         tmp<Field<Type> > sample(const word& fieldName) const;
 243 };
 244
 245
 246 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 247
 248 } // End namespace Foam
 249
 250 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 251
 252 #ifdef NoRepository
 253 #   include "probesTemplates.C"
 254 #endif
 255
 256 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 257
 258 #endif
 259
 260 // ************************************************************************* //