functionObject.C

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2011-2026 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.
 
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.
 
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
\*---------------------------------------------------------------------------*/
 
#include "functionObject.H"
#include "dictionary.H"
#include "dlLibraryTable.H"
#include "Time.H"
 
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
 
namespace Foam
{
    defineTypeNameAndDebug(functionObject, 0);
    defineRunTimeSelectionTable(functionObject, dictionary);
}
 
bool Foam::functionObject::postProcess(false);
 
 
// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
 
Foam::functionObject::functionObject
(
    const word& name,
    const Time& runTime
)
:
    name_(name),
    time_(runTime),
    log(false),
    executeAtStart_(true)
{}
 
 
Foam::functionObject::functionObject
(
    const word& name,
    const Time& runTime,
    const dictionary& dict
)
:
    functionObject(name, runTime)
{
    read(dict);
}
 
 
// * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * * //
 
Foam::autoPtr<Foam::functionObject> Foam::functionObject::New
(
    const word& name,
    const Time& runTime,
    const dictionary& dict
)
{
    const word type(dict.lookup("type"));
 
    Info<< indentOrNl << "Selecting " << type
        << " with name " << name << endl;
 
    if
    (
        !dictionaryConstructorTablePtr_
     || dictionaryConstructorTablePtr_->find(type)
        == dictionaryConstructorTablePtr_->end()
    )
    {
        if
        (
           !libs.open
            (
                dict,
                "libs",
                dictionaryConstructorTablePtr_
            )
        )
        {
            libs.open("lib" + type.remove(':') + ".so", false);
        }
 
        if (!dictionaryConstructorTablePtr_)
        {
            FatalErrorInFunction
                << "Unknown function type "
                << type << nl << nl
                << "Table of functionObjects is empty"
                << exit(FatalError);
        }
    }
 
    dictionaryConstructorTable::iterator cstrIter =
        dictionaryConstructorTablePtr_->find(type);
 
    if (cstrIter == dictionaryConstructorTablePtr_->end())
    {
        FatalErrorInFunction
            << "Unknown function type "
            << type << nl << nl
            << "Valid functions are : " << nl
            << dictionaryConstructorTablePtr_->sortedToc()
            << exit(FatalError);
    }
 
    printDictionary print(dict);
 
    return autoPtr<functionObject>(cstrIter()(name, runTime, dict));
}
 
 
// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
 
Foam::functionObject::~functionObject()
{}
 
 
// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 
const Foam::word& Foam::functionObject::name() const
{
    return name_;
}
 
 
bool Foam::functionObject::read(const dictionary& dict)
{
    log = dict.lookupOrDefault<Switch>("log", postProcess);
 
    if (!postProcess)
    {
        executeAtStart_ =
            dict.lookupOrDefault<Switch>("executeAtStart", executeAtStart_);
    }
 
    return true;
}
 
 
bool Foam::functionObject::executeAtStart() const
{
    return executeAtStart_;
}
 
 
bool Foam::functionObject::end()
{
    return true;
}
 
 
Foam::scalar Foam::functionObject::timeToNextAction()
{
    return vGreat;
}
 
 
Foam::scalar Foam::functionObject::maxDeltaT() const
{
    return vGreat;
}
 
 
void Foam::functionObject::movePoints(const polyMesh&)
{}
 
 
void Foam::functionObject::topoChange(const polyTopoChangeMap&)
{}
 
 
void Foam::functionObject::mapMesh(const polyMeshMap&)
{}
 
 
void Foam::functionObject::distribute(const polyDistributionMap&)
{}
 
 
// ************************************************************************* //