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