src/postProcessing/foamCalcFunctions/field/componentsTurbo/componentsTurbo.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::calcTypes::componentsTurbo
  26
  27 Description
  28     Writes turbo scalar fields corresponding to radial, tangential and z
  29     components of the supplied vector field (name) (usually a velocity field)
  30     for each time.
  31
  32     Caveat: the current implementation expect the vector field to be centered
  33             around the z-axis.
  34
  35 Author
  36     Martin Beaudoin, Hydro-Quebec, 2012.  All rights reserved
  37
  38 SourceFiles
  39     componentsTurbo.C
  40
  41 \*---------------------------------------------------------------------------*/
  42
  43 #ifndef componentsTurbo_H
  44 #define componentsTurbo_H
  45
  46 #include "calcType.H"
  47
  48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  49
  50 namespace Foam
  51 {
  52
  53 namespace calcTypes
  54 {
  55
  56 /*---------------------------------------------------------------------------*\
  57                          Class componentsTurbo Declaration
  58 \*---------------------------------------------------------------------------*/
  59
  60 class componentsTurbo
  61 :
  62     public calcType
  63 {
  64     // Private Member Functions
  65
  66         //- Disallow default bitwise copy construct
  67         componentsTurbo(const componentsTurbo&);
  68
  69         //- Disallow default bitwise assignment
  70         void operator=(const componentsTurbo&);
  71
  72
  73 protected:
  74
  75     // Member Functions
  76
  77         // Calculation routines
  78
  79             //- Initialise - typically setting static variables,
  80             //  e.g. command line arguments
  81             virtual void init();
  82
  83             //- Pre-time loop calculations
  84             virtual void preCalc
  85             (
  86                 const argList& args,
  87                 const Time& runTime,
  88                 const fvMesh& mesh
  89             );
  90
  91             //- Time loop calculations
  92             virtual void calc
  93             (
  94                 const argList& args,
  95                 const Time& runTime,
  96                 const fvMesh& mesh
  97             );
  98
  99
 100         // I-O
 101
 102             //- Write component fields
 103             template<class Type>
 104             void writeComponentFields
 105             (
 106                 const IOobject& header,
 107                 const fvMesh& mesh,
 108                 bool& processed
 109             );
 110
 111
 112 public:
 113
 114     //- Runtime type information
 115     TypeName("componentsTurbo");
 116
 117
 118     // Constructors
 119
 120         //- Construct null
 121         componentsTurbo();
 122
 123
 124     // Destructor
 125
 126         virtual ~componentsTurbo();
 127 };
 128
 129
 130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 131
 132 } // End namespace calcTypes
 133 } // End namespace Foam
 134
 135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 136
 137 #ifdef NoRepository
 138 #   include "writeComponentTurboFields.C"
 139 #endif
 140
 141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 142
 143 #endif
 144
 145 // ************************************************************************* //