src/postProcessing/functionObjects/systemCall/systemCall.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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::systemCall
  27
  28 Description
  29     Executes system calls, entered in the form of a string list
  30
  31 SourceFiles
  32     systemCall.C
  33     IOsystemCall.H
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef systemCall_H
  38 #define systemCall_H
  39
  40 #include "stringList.H"
  41 #include "pointFieldFwd.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 // Forward declaration of classes
  49 class objectRegistry;
  50 class dictionary;
  51 class mapPolyMesh;
  52
  53 /*---------------------------------------------------------------------------*\
  54                        Class systemCall Declaration
  55 \*---------------------------------------------------------------------------*/
  56
  57 class systemCall
  58 {
  59 protected:
  60
  61     // Private data
  62
  63         //- Name of this set of system calls
  64         word name_;
  65
  66         //- List of calls to execute - every step
  67         stringList executeCalls_;
  68
  69         //- List of calls to execute when exiting the time-loop
  70         stringList endCalls_;
  71
  72         //- List of calls to execute - write steps
  73         stringList writeCalls_;
  74
  75
  76     // Private Member Functions
  77
  78         //- Disallow default bitwise copy construct
  79         systemCall(const systemCall&);
  80
  81         //- Disallow default bitwise assignment
  82         void operator=(const systemCall&);
  83
  84
  85 public:
  86
  87     //- Runtime type information
  88     TypeName("systemCall");
  89
  90
  91     // Constructors
  92
  93         //- Construct for given objectRegistry and dictionary.
  94         //  Allow the possibility to load fields from files
  95         systemCall
  96         (
  97             const word& name,
  98             const objectRegistry& unused,
  99             const dictionary&,
 100             const bool loadFromFilesUnused = false
 101         );
 102
 103
 104     // Destructor
 105
 106         virtual ~systemCall();
 107
 108
 109     // Member Functions
 110
 111         //- Return name of the system call set
 112         virtual const word& name() const
 113         {
 114             return name_;
 115         }
 116
 117         //- Read the system calls
 118         virtual void read(const dictionary&);
 119
 120         //- Execute the "executeCalls" at each time-step
 121         virtual void execute();
 122
 123         //- Execute the "endCalls" at the final time-loop
 124         virtual void end();
 125
 126         //- Write, execute the "writeCalls"
 127         virtual void write();
 128
 129         //- Update for changes of mesh
 130         virtual void updateMesh(const mapPolyMesh&)
 131         {}
 132
 133         //- Update for changes of mesh
 134         virtual void movePoints(const pointField&)
 135         {}
 136 };
 137
 138
 139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 140
 141 } // End namespace Foam
 142
 143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 144
 145 #endif
 146
 147 // ************************************************************************* //