src/postProcessing/foamCalcFunctions/field/magSqr/magSqr.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-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::calcTypes::magSqr
  27
  28 Description
  29     Calculates and writes the magnitude-sqaured of a field for each time
  30
  31 SourceFiles
  32     magSqr.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef magSqr_H
  37 #define magSqr_H
  38
  39 #include "calcType.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 namespace calcTypes
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                           Class magSqr Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class magSqr
  54 :
  55     public calcType
  56 {
  57     // Private Member Functions
  58
  59         //- Disallow default bitwise copy construct
  60         magSqr(const magSqr&);
  61
  62         //- Disallow default bitwise assignment
  63         void operator=(const magSqr&);
  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 component fields
  96             template<class Type>
  97             void writeMagSqrField
  98             (
  99                 const IOobject& header,
 100                 const fvMesh& mesh,
 101                 bool& processed
 102             );
 103
 104
 105 public:
 106
 107     //- Runtime type information
 108     TypeName("magSqr");
 109
 110
 111     // Constructors
 112
 113         //- Construct null
 114         magSqr();
 115
 116
 117     // Destructor
 118
 119         virtual ~magSqr();
 120 };
 121
 122
 123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 124
 125 } // End namespace calcTypes
 126 } // End namespace Foam
 127
 128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 129
 130 #ifdef NoRepository
 131 #   include "writeMagSqrField.C"
 132 #endif
 133
 134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 135
 136 #endif
 137
 138 // ************************************************************************* //