solutionControl.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) 2018-2024 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 "solutionControl.H"
 
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
 
namespace Foam
{
    defineTypeNameAndDebug(solutionControl, 0);
}
 
 
// * * * * * * * * * * * * Protected Member Functions  * * * * * * * * * * * //
 
bool Foam::solutionControl::read()
{
    return true;
}
 
 
bool Foam::solutionControl::writeData(Ostream&) const
{
    NotImplemented;
    return false;
}
 
 
// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
 
Foam::solutionControl::solutionControl
(
    const objectRegistry& registry,
    const word& algorithmName
)
:
    regIOobject
    (
        IOobject
        (
            typeName,
            registry.time().name(),
            registry,
            IOobject::NO_READ,
            IOobject::NO_WRITE
        )
    ),
    registry_(registry),
    algorithmName_(algorithmName),
    algorithmSpaceStr_(algorithmName.size(), ' '),
    finalIter_(false)
{}
 
 
// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
 
Foam::solutionControl::~solutionControl()
{}
 
 
// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 
bool Foam::solutionControl::finalIteration(const objectRegistry& registry)
{
    if (registry.foundType<solutionControl>())
    {
        return registry.lookupType<solutionControl>().finalIter_;
    }
    else
    {
        return false;
    }
}
 
 
// ************************************************************************* //