src/postProcessing/foamCalcFunctions/field/magGrad/magGrad.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::magGrad
  26
  27 Description
  28     Writes scalar fields corresponding to the magnitude ot the gradient
  29     of the supplied field (name) for each time.
  30
  31 SourceFiles
  32     magGrad.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef magGrad_H
  37 #define magGrad_H
  38
  39 #include "calcType.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 namespace calcTypes
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                           Class magGrad Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class magGrad
  54 :
  55     public calcType
  56 {
  57     // Private Member Functions
  58
  59         //- Disallow default bitwise copy construct
  60         magGrad(const magGrad&);
  61
  62         //- Disallow default bitwise assignment
  63         void operator=(const magGrad&);
  64
  65
  66 protected:
  67
  68     // Member Functions
  69
  70         // Calculation routines
  71
  72             //- Initialise - typically setting static variables,
  73             //  e.g. command line arguments
  74             virtual void init();
  75
  76             //- Pre-time loop calculations
  77             virtual void preCalc
  78             (
  79                 const argList& args,
  80                 const Time& runTime,
  81                 const fvMesh& mesh
  82             );
  83
  84             //- Time loop calculations
  85             virtual void calc
  86             (
  87                 const argList& args,
  88                 const Time& runTime,
  89                 const fvMesh& mesh
  90             );
  91
  92
  93         // I-O
  94
  95             //- Write magGrad fields
  96             template<class Type>
  97             void writeMagGradField
  98             (
  99                 const IOobject& header,
 100                 const fvMesh& mesh,
 101                 bool& processed
 102             );
 103
 104
 105 public:
 106
 107     //- Runtime type information
 108     TypeName("magGrad");
 109
 110
 111     // Constructors
 112
 113         //- Construct null
 114         magGrad();
 115
 116
 117     // Destructor
 118
 119         virtual ~magGrad();
 120 };
 121
 122
 123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 124
 125 } // End namespace calcTypes
 126 } // End namespace Foam
 127
 128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 129
 130 #ifdef NoRepository
 131 #   include "writeMagGradField.C"
 132 #endif
 133
 134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 135
 136 #endif
 137
 138 // ************************************************************************* //