src/foam/db/functionObjects/functionObject/functionObject.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 \*---------------------------------------------------------------------------*/
  25
  26 #include "functionObject.H"
  27 #include "dictionary.H"
  28 #include "dlLibraryTable.H"
  29
  30 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  31
  32 defineRunTimeSelectionTable(Foam::functionObject, dictionary);
  33
  34 Foam::debug::debugSwitch
  35 Foam::functionObject::debug
  36 (
  37     "functionObject",
  38     0
  39 );
  40
  41
  42 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  43
  44 Foam::functionObject::functionObject(const word& name)
  45 :
  46     name_(name)
  47 {}
  48
  49
  50 // * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * * //
  51
  52 Foam::autoPtr<Foam::functionObject> Foam::functionObject::New
  53 (
  54     const word& name,
  55     const Time& t,
  56     const dictionary& functionDict
  57 )
  58 {
  59     word functionType(functionDict.lookup("type"));
  60
  61     if (debug)
  62     {
  63         Info<< "Selecting function " << functionType << endl;
  64     }
  65
  66     dlLibraryTable::open
  67     (
  68         functionDict,
  69         "functionObjectLibs",
  70         dictionaryConstructorTablePtr_
  71     );
  72
  73     if (!dictionaryConstructorTablePtr_)
  74     {
  75         FatalErrorIn
  76         (
  77             "functionObject::New"
  78             "(const word& name, const Time&, const dictionary&)"
  79         )   << "Unknown function type "
  80             << functionType << nl << nl
  81             << "Table of functionObjects is empty" << endl
  82             << exit(FatalError);
  83     }
  84
  85     dictionaryConstructorTable::iterator cstrIter =
  86         dictionaryConstructorTablePtr_->find(functionType);
  87
  88     if (cstrIter == dictionaryConstructorTablePtr_->end())
  89     {
  90         FatalErrorIn
  91         (
  92             "functionObject::New"
  93             "(const word& name, const Time&, const dictionary&)"
  94         )   << "Unknown function type "
  95             << functionType << nl << nl
  96             << "Valid functions are : " << nl
  97             << dictionaryConstructorTablePtr_->sortedToc() << endl
  98             << exit(FatalError);
  99     }
 100
 101     return autoPtr<functionObject>(cstrIter()(name, t, functionDict));
 102 }
 103
 104
 105 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
 106
 107 Foam::functionObject::~functionObject()
 108 {}
 109
 110
 111 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 112
 113 const Foam::word& Foam::functionObject::name() const
 114 {
 115     return name_;
 116 }
 117
 118
 119 bool Foam::functionObject::end()
 120 {
 121     return execute();
 122 }
 123
 124
 125 Foam::autoPtr<Foam::functionObject> Foam::functionObject::iNew::operator()
 126 (
 127     const word& name,
 128     Istream& is
 129 ) const
 130 {
 131     dictionary dict(is);
 132     return functionObject::New(name, time_, dict);
 133 }
 134
 135
 136 // ************************************************************************* //