src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2009-2010 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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::timeActivatedFileUpdate
  26
  27 Description
  28     Performs a file copy/replacement once a specified time has been reached.
  29
  30     Example usage to update the fvSolution dictionary at various times
  31     throughout the calculation:
  32
  33         fileUpdate1
  34         {
  35             type              timeActivatedFileUpdate;
  36             functionObjectLibs ("libutilityFunctionObjects.so");
  37             outputControl     timeStep;
  38             outputInterval    1;
  39             fileToUpdate      "$FOAM_CASE/system/fvSolution";
  40             timeVsFile
  41             (
  42                 (-1 "$FOAM_CASE/system/fvSolution.0")
  43                 (0.10 "$FOAM_CASE/system/fvSolution.10")
  44                 (0.20 "$FOAM_CASE/system/fvSolution.20")
  45                 (0.35 "$FOAM_CASE/system/fvSolution.35")
  46             );
  47         }
  48
  49
  50 SourceFiles
  51     timeActivatedFileUpdate.C
  52     IOtimeActivatedFileUpdate.H
  53
  54 \*---------------------------------------------------------------------------*/
  55
  56 #ifndef timeActivatedFileUpdate_H
  57 #define timeActivatedFileUpdate_H
  58
  59 #include "pointFieldFwd.H"
  60 #include "Tuple2.H"
  61
  62 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  63
  64 namespace Foam
  65 {
  66
  67 // Forward declaration of classes
  68 class objectRegistry;
  69 class dictionary;
  70 class mapPolyMesh;
  71
  72 /*---------------------------------------------------------------------------*\
  73                   Class timeActivatedFileUpdate Declaration
  74 \*---------------------------------------------------------------------------*/
  75
  76 class timeActivatedFileUpdate
  77 {
  78     // Private data
  79
  80         //- Name of this set of timeActivatedFileUpdate objects
  81         word name_;
  82
  83         //- Owner database
  84         const objectRegistry& obr_;
  85
  86         //- On/off switch
  87         bool active_;
  88
  89         //- Name of file to update
  90         fileName fileToUpdate_;
  91
  92         //- List of times vs filenames
  93         List<Tuple2<scalar, fileName> > timeVsFile_;
  94
  95         //- Index of last file copied
  96         label lastIndex_;
  97
  98
  99     // Private Member Functions
 100
 101         //- Update file
 102         void updateFile();
 103
 104         //- Disallow default bitwise copy construct
 105         timeActivatedFileUpdate(const timeActivatedFileUpdate&);
 106
 107         //- Disallow default bitwise assignment
 108         void operator=(const timeActivatedFileUpdate&);
 109
 110
 111 public:
 112
 113     //- Runtime type information
 114     TypeName("timeActivatedFileUpdate");
 115
 116
 117     // Constructors
 118
 119         //- Construct for given objectRegistry and dictionary.
 120         //  Allow the possibility to load fields from files
 121         timeActivatedFileUpdate
 122         (
 123             const word& name,
 124             const objectRegistry&,
 125             const dictionary&,
 126             const bool loadFromFiles = false
 127         );
 128
 129
 130     //- Destructor
 131     virtual ~timeActivatedFileUpdate();
 132
 133
 134     // Member Functions
 135
 136         //- Return name of the set of timeActivatedFileUpdate
 137         virtual const word& name() const
 138         {
 139             return name_;
 140         }
 141
 142         //- Read the timeActivatedFileUpdate data
 143         virtual void read(const dictionary&);
 144
 145         //- Execute, currently does nothing
 146         virtual void execute();
 147
 148         //- Execute at the final time-loop, currently does nothing
 149         virtual void end();
 150
 151         //- Calculate the timeActivatedFileUpdate and write
 152         virtual void write();
 153
 154         //- Update for changes of mesh
 155         virtual void updateMesh(const mapPolyMesh&)
 156         {}
 157
 158         //- Update for changes of mesh
 159         virtual void movePoints(const pointField&)
 160         {}
 161 };
 162
 163
 164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 165
 166 } // End namespace Foam
 167
 168 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 169
 170 #endif
 171
 172 // ************************************************************************* //