src/OpenFOAM/db/functionObjects/functionObject/functionObject.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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 \*---------------------------------------------------------------------------*/
  25
  26 #include "functionObject.H"
  27 #include "dictionary.H"
  28 #include "dlLibraryTable.H"
  29 #include "Time.H"
  30
  31 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  32
  33 defineRunTimeSelectionTable(Foam::functionObject, dictionary);
  34 int Foam::functionObject::debug(Foam::debug::debugSwitch("functionObject", 0));
  35
  36
  37 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  38
  39 Foam::functionObject::functionObject(const word& name)
  40 :
  41     name_(name)
  42 {}
  43
  44
  45 // * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * * //
  46
  47 Foam::autoPtr<Foam::functionObject> Foam::functionObject::New
  48 (
  49     const word& name,
  50     const Time& t,
  51     const dictionary& functionDict
  52 )
  53 {
  54     const word functionType(functionDict.lookup("type"));
  55
  56     if (debug)
  57     {
  58         Info<< "Selecting function " << functionType << endl;
  59     }
  60
  61     const_cast<Time&>(t).libs().open
  62     (
  63         functionDict,
  64         "functionObjectLibs",
  65         dictionaryConstructorTablePtr_
  66     );
  67
  68     if (!dictionaryConstructorTablePtr_)
  69     {
  70         FatalErrorIn
  71         (
  72             "functionObject::New"
  73             "(const word& name, const Time&, const dictionary&)"
  74         )   << "Unknown function type "
  75             << functionType << nl << nl
  76             << "Table of functionObjects is empty" << endl
  77             << exit(FatalError);
  78     }
  79
  80     dictionaryConstructorTable::iterator cstrIter =
  81         dictionaryConstructorTablePtr_->find(functionType);
  82
  83     if (cstrIter == dictionaryConstructorTablePtr_->end())
  84     {
  85         FatalErrorIn
  86         (
  87             "functionObject::New"
  88             "(const word& name, const Time&, const dictionary&)"
  89         )   << "Unknown function type "
  90             << functionType << nl << nl
  91             << "Valid functions are : " << nl
  92             << dictionaryConstructorTablePtr_->sortedToc() << endl
  93             << exit(FatalError);
  94     }
  95
  96     return autoPtr<functionObject>(cstrIter()(name, t, functionDict));
  97 }
  98
  99
 100 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
 101
 102 Foam::functionObject::~functionObject()
 103 {}
 104
 105
 106 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 107
 108 const Foam::word& Foam::functionObject::name() const
 109 {
 110     return name_;
 111 }
 112
 113
 114 bool Foam::functionObject::end()
 115 {
 116     return execute(false);
 117 }
 118
 119
 120 Foam::autoPtr<Foam::functionObject> Foam::functionObject::iNew::operator()
 121 (
 122     const word& name,
 123     Istream& is
 124 ) const
 125 {
 126     dictionary dict(is);
 127     return functionObject::New(name, time_, dict);
 128 }
 129
 130
 131 // ************************************************************************* //