src/postProcessing/functionObjects/field/fieldValues/cellSource/cellSource.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2009-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::fieldValues::cellSource
  27
  28 Description
  29     Cell source variant of field value function object. Values of user-
  30     specified fields reported for collections of cells.
  31
  32     cellObj1                        // Name also used to identify output folder
  33     {
  34         type            cellSource;
  35         functionObjectLibs ("libfieldValueFunctionObjects.so");
  36         enabled         true;
  37         outputControl   outputTime;
  38         log             true;       // log to screen?
  39         valueOutput     true;       // Write values at run-time output times?
  40         source          cellZone;   // Type of cell source
  41         sourceName      c0;
  42         operation       volAverage; // none, sum, volAverage, volIntegrate
  43         fields
  44         (
  45             p
  46             U
  47         );
  48     }
  49
  50 SourceFiles
  51     cellSource.C
  52
  53 \*---------------------------------------------------------------------------*/
  54
  55 #ifndef cellSource_H
  56 #define cellSource_H
  57
  58 #include "NamedEnum.H"
  59 #include "fieldValue.H"
  60 #include "labelList.H"
  61 #include "volFieldsFwd.H"
  62
  63 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  64
  65 namespace Foam
  66 {
  67 namespace fieldValues
  68 {
  69
  70 /*---------------------------------------------------------------------------*\
  71                          Class cellSource Declaration
  72 \*---------------------------------------------------------------------------*/
  73
  74 class cellSource
  75 :
  76     public fieldValue
  77 {
  78
  79 public:
  80
  81     // Public data types
  82
  83         //- Source type enumeration
  84         enum sourceType
  85         {
  86             stCellZone
  87         };
  88
  89         //- Source type names
  90         static const NamedEnum<sourceType, 1> sourceTypeNames_;
  91
  92
  93         //- Operation type enumeration
  94         enum operationType
  95         {
  96             opNone,
  97             opSum,
  98             opVolAverage,
  99             opVolIntegrate
 100         };
 101
 102         //- Operation type names
 103         static const NamedEnum<operationType, 4> operationTypeNames_;
 104
 105
 106 private:
 107
 108     // Private member functions
 109
 110         //- Set cells to evaluate based on a cell zone
 111         void setCellZoneCells();
 112
 113         //- Set cells to evaluate based on a patch
 114         void setPatchCells();
 115
 116
 117 protected:
 118
 119     // Protected data
 120
 121         //- Source type
 122         sourceType source_;
 123
 124         //- Operation to apply to values
 125         operationType operation_;
 126
 127         //- Local list of cell IDs
 128         labelList cellId_;
 129
 130
 131     // Protected member functions
 132
 133         //- Initialise, e.g. cell addressing
 134         void initialise();
 135
 136         //- Insert field values into values list
 137         template<class Type>
 138         bool setFieldValues
 139         (
 140             const word& fieldName,
 141             List<Type>& values
 142         ) const;
 143
 144         //- Apply the 'operation' to the values
 145         template<class Type>
 146         Type processValues(const List<Type>& values) const;
 147
 148         //- Output file header information
 149         virtual void writeFileHeader();
 150
 151
 152 public:
 153
 154     //- Run-time type information
 155     TypeName("cellSource");
 156
 157
 158     //- Construct from components
 159     cellSource
 160     (
 161         const word& name,
 162         const objectRegistry& obr,
 163         const dictionary& dict,
 164         const bool loadFromFiles = false
 165     );
 166
 167
 168     //- Destructor
 169     virtual ~cellSource();
 170
 171
 172     // Public member functions
 173
 174         // Access
 175
 176             //- Return the source type
 177             inline const sourceType& source() const;
 178
 179             //- Return the local list of cell IDs
 180             inline const labelList& cellId() const;
 181
 182
 183         // Function object functions
 184
 185             //- Read from dictionary
 186             virtual void read(const dictionary&);
 187
 188             //- Calculate and write
 189             virtual void write();
 190
 191             //- Templated helper function to output field values
 192             template<class Type>
 193             bool writeValues(const word& fieldName);
 194
 195             //- Filter a field according to cellIds
 196             template<class Type>
 197             tmp<Field<Type> > filterField(const Field<Type>& field) const;
 198 };
 199
 200
 201 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 202
 203 } // End namespace fieldValues
 204 } // End namespace Foam
 205
 206 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 207
 208 #include "cellSourceI.H"
 209
 210 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 211
 212 #ifdef NoRepository
 213     #include "cellSourceTemplates.C"
 214 #endif
 215
 216 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 217
 218 #endif
 219
 220 // ************************************************************************* //