src/finiteVolume/cfdTools/general/solutionControl/simpleControl/simpleControlI.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011-2011 OpenCFD Ltd.
   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 "Time.H"
  27
  28 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  29
  30 inline bool Foam::simpleControl::loop()
  31 {
  32     read();
  33
  34     Time& time = const_cast<Time&>(mesh_.time());
  35
  36     if (initialised_)
  37     {
  38         if (criteriaSatisfied())
  39         {
  40             Info<< nl << algorithmName_ << " solution converged in "
  41                 << time.timeName() << " iterations" << nl << endl;
  42
  43             // Set to finalise calculation
  44             time.writeAndEnd();
  45         }
  46     }
  47     else
  48     {
  49         initialised_ = true;
  50     }
  51
  52     return time.loop();
  53 }
  54
  55
  56 // ************************************************************************* //