src/OpenFOAM/db/functionObjects/OutputFilterFunctionObject/OutputFilterFunctionObject.C

   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 \*---------------------------------------------------------------------------*/
  26
  27 #include "OutputFilterFunctionObject.H"
  28 #include "IOOutputFilter.H"
  29 #include "polyMesh.H"
  30 #include "addToRunTimeSelectionTable.H"
  31
  32 // * * * * * * * * * * * * * * * Private Members * * * * * * * * * * * * * * //
  33
  34 template<class OutputFilter>
  35 void Foam::OutputFilterFunctionObject<OutputFilter>::readDict()
  36 {
  37     dict_.readIfPresent("region", regionName_);
  38     dict_.readIfPresent("dictionary", dictName_);
  39     dict_.readIfPresent("enabled", enabled_);
  40 }
  41
  42
  43 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  44
  45 template<class OutputFilter>
  46 Foam::OutputFilterFunctionObject<OutputFilter>::OutputFilterFunctionObject
  47 (
  48     const word& name,
  49     const Time& t,
  50     const dictionary& dict
  51 )
  52 :
  53     functionObject(name),
  54     time_(t),
  55     dict_(dict),
  56     regionName_(polyMesh::defaultRegion),
  57     dictName_(),
  58     enabled_(true),
  59     outputControl_(t, dict)
  60 {
  61     readDict();
  62 }
  63
  64
  65 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  66
  67 template<class OutputFilter>
  68 void Foam::OutputFilterFunctionObject<OutputFilter>::on()
  69 {
  70     enabled_ = true;
  71 }
  72
  73
  74 template<class OutputFilter>
  75 void Foam::OutputFilterFunctionObject<OutputFilter>::off()
  76 {
  77     enabled_ = false;
  78 }
  79
  80
  81 template<class OutputFilter>
  82 bool Foam::OutputFilterFunctionObject<OutputFilter>::start()
  83 {
  84     readDict();
  85
  86     if (enabled_)
  87     {
  88         if (dictName_.size())
  89         {
  90             ptr_.reset
  91             (
  92                 new IOOutputFilter<OutputFilter>
  93                 (
  94                     name(),
  95                     time_.lookupObject<objectRegistry>(regionName_),
  96                     dictName_
  97                 )
  98             );
  99         }
 100         else
 101         {
 102             ptr_.reset
 103             (
 104                 new OutputFilter
 105                 (
 106                     name(),
 107                     time_.lookupObject<objectRegistry>(regionName_),
 108                     dict_
 109                 )
 110             );
 111         }
 112     }
 113
 114     return true;
 115 }
 116
 117
 118 template<class OutputFilter>
 119 bool Foam::OutputFilterFunctionObject<OutputFilter>::execute()
 120 {
 121     if (enabled_)
 122     {
 123         ptr_->execute();
 124
 125         if (enabled_ && outputControl_.output())
 126         {
 127             ptr_->write();
 128         }
 129     }
 130
 131     return true;
 132 }
 133
 134
 135 template<class OutputFilter>
 136 bool Foam::OutputFilterFunctionObject<OutputFilter>::end()
 137 {
 138     if (enabled_)
 139     {
 140         ptr_->end();
 141
 142         if (enabled_ && outputControl_.output())
 143         {
 144             ptr_->write();
 145         }
 146     }
 147
 148     return true;
 149 }
 150
 151
 152 template<class OutputFilter>
 153 bool Foam::OutputFilterFunctionObject<OutputFilter>::read
 154 (
 155     const dictionary& dict
 156 )
 157 {
 158     if (dict != dict_)
 159     {
 160         dict_ = dict;
 161         outputControl_.read(dict);
 162
 163         return start();
 164     }
 165     else
 166     {
 167         return false;
 168     }
 169 }
 170
 171
 172 // ************************************************************************* //