OpenFOAM-dev / data /src /finiteVolume /cfdTools /general /solutionControl /simpleControl /simpleControl.H
| /*---------------------------------------------------------------------------*\ | |
| ========= | | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | |
| \\ / O peration | Website: https://openfoam.org | |
| \\ / A nd | Copyright (C) 2018-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/>. | |
| Class | |
| Foam::simpleControl | |
| Description | |
| Simple control class. Provides time-loop control methods which exit the | |
| simulation once convergence criteria have been reached. Example usage: | |
| \verbatim | |
| simpleControl simple(mesh); | |
| while (simple.loop(runTime)) | |
| { | |
| Info<< "Time = " << runTime.userTimeName() << nl << endl; | |
| // solve ... | |
| } | |
| \endverbatim | |
| SourceFiles | |
| simpleControl.C | |
| \*---------------------------------------------------------------------------*/ | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| namespace Foam | |
| { | |
| /*---------------------------------------------------------------------------*\ | |
| Class simpleControl Declaration | |
| \*---------------------------------------------------------------------------*/ | |
| class simpleControl | |
| : | |
| public fluidSolutionControl, | |
| public singleRegionConvergenceControl | |
| { | |
| protected: | |
| // Protected Member Functions | |
| //- Read controls | |
| virtual bool read(); | |
| public: | |
| // Static Data Members | |
| //- Run-time type information | |
| TypeName("simpleControl"); | |
| // Constructors | |
| //- Construct from a mesh and the name of the algorithm | |
| simpleControl(const fvMesh& mesh, const word& algorithmName="SIMPLE"); | |
| //- Destructor | |
| virtual ~simpleControl(); | |
| // Member Functions | |
| // Access | |
| using singleRegionSolutionControl::dict; | |
| //- Return the solution dictionary | |
| static const dictionary& dict | |
| ( | |
| const fvMesh& mesh, | |
| const word& algorithmName="SIMPLE" | |
| ); | |
| // Evolution | |
| //- Time run loop | |
| bool run(Time& time); | |
| //- Time loop loop | |
| bool loop(Time& time); | |
| }; | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| } // End namespace Foam | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| // ************************************************************************* // | |