1944b09bb5
Now solvers return solver performance information for all components with backward compatibility provided by the "max" function which created the scalar solverPerformance from the maximum component residuals from the SolverPerformance<Type>. The residuals functionObject has been upgraded to support SolverPerformance<Type> so that now the initial residuals for all (valid) components are tabulated, e.g. for the cavity tutorial case the residuals for p, Ux and Uy are listed vs time. Currently the residualControl option of pimpleControl and simpleControl is supported in backward compatibility mode (only the maximum component residual is considered) but in the future this will be upgraded to support convergence control for the components individually. This development started from patches provided by Bruno Santos, See http://www.openfoam.org/mantisbt/view.php?id=1824
158 lines
4.2 KiB
C
158 lines
4.2 KiB
C
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2011-2015 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 "simpleControl.H"
|
|
#include "Time.H"
|
|
|
|
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
defineTypeNameAndDebug(simpleControl, 0);
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
|
|
|
|
void Foam::simpleControl::read()
|
|
{
|
|
solutionControl::read(true);
|
|
}
|
|
|
|
|
|
bool Foam::simpleControl::criteriaSatisfied()
|
|
{
|
|
if (residualControl_.empty())
|
|
{
|
|
return false;
|
|
}
|
|
|
|
bool achieved = true;
|
|
bool checked = false; // safety that some checks were indeed performed
|
|
|
|
const dictionary& solverDict = mesh_.solverPerformanceDict();
|
|
forAllConstIter(dictionary, solverDict, iter)
|
|
{
|
|
const word& variableName = iter().keyword();
|
|
const label fieldI = applyToField(variableName);
|
|
if (fieldI != -1)
|
|
{
|
|
scalar lastResidual = 0;
|
|
const scalar residual =
|
|
maxResidual(variableName, iter().stream(), lastResidual);
|
|
|
|
checked = true;
|
|
|
|
bool absCheck = residual < residualControl_[fieldI].absTol;
|
|
achieved = achieved && absCheck;
|
|
|
|
if (debug)
|
|
{
|
|
Info<< algorithmName_ << " solution statistics:" << endl;
|
|
|
|
Info<< " " << variableName << ": tolerance = " << residual
|
|
<< " (" << residualControl_[fieldI].absTol << ")"
|
|
<< endl;
|
|
}
|
|
}
|
|
}
|
|
|
|
return checked && achieved;
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
|
|
|
|
Foam::simpleControl::simpleControl(fvMesh& mesh)
|
|
:
|
|
solutionControl(mesh, "SIMPLE"),
|
|
initialised_(false)
|
|
{
|
|
read();
|
|
|
|
Info<< nl;
|
|
|
|
if (residualControl_.empty())
|
|
{
|
|
Info<< algorithmName_ << ": no convergence criteria found. "
|
|
<< "Calculations will run for " << mesh_.time().endTime().value()
|
|
<< " steps." << nl << endl;
|
|
}
|
|
else
|
|
{
|
|
Info<< algorithmName_ << ": convergence criteria" << nl;
|
|
forAll(residualControl_, i)
|
|
{
|
|
Info<< " field " << residualControl_[i].name << token::TAB
|
|
<< " tolerance " << residualControl_[i].absTol
|
|
<< nl;
|
|
}
|
|
Info<< endl;
|
|
}
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
|
|
|
|
Foam::simpleControl::~simpleControl()
|
|
{}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
|
|
|
|
bool Foam::simpleControl::loop()
|
|
{
|
|
read();
|
|
|
|
Time& time = const_cast<Time&>(mesh_.time());
|
|
|
|
if (initialised_)
|
|
{
|
|
if (criteriaSatisfied())
|
|
{
|
|
Info<< nl << algorithmName_ << " solution converged in "
|
|
<< time.timeName() << " iterations" << nl << endl;
|
|
|
|
// Set to finalise calculation
|
|
time.writeAndEnd();
|
|
}
|
|
else
|
|
{
|
|
storePrevIterFields();
|
|
}
|
|
}
|
|
else
|
|
{
|
|
initialised_ = true;
|
|
storePrevIterFields();
|
|
}
|
|
|
|
|
|
return time.loop();
|
|
}
|
|
|
|
|
|
// ************************************************************************* //
|