src/finiteVolume/cfdTools/general/solutionControl/pimpleControl/pimpleControl.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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 Class
  25     Foam::pimpleControl
  26
  27 Description
  28     PIMPLE control class to supply convergence information/checks for
  29     the PIMPLE loop.
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef pimpleControl_H
  34 #define pimpleControl_H
  35
  36 #include "solutionControl.H"
  37
  38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  39
  40 namespace Foam
  41 {
  42
  43 /*---------------------------------------------------------------------------*\
  44                         Class pimpleControl Declaration
  45 \*---------------------------------------------------------------------------*/
  46
  47 class pimpleControl
  48 :
  49     public solutionControl
  50 {
  51 protected:
  52
  53     // Protected data
  54
  55         // Solution controls
  56
  57             //- Maximum number of PIMPLE correctors
  58             label nOuterCorr_;
  59
  60             //- Maximum number of PISO correctors
  61             label nCorr_;
  62
  63             //- Current PIMPLE corrector
  64             label corr_;
  65
  66             //- Flag to indicate whether to only solve turbulence on final iter
  67             bool turbOnFinalIterOnly_;
  68
  69
  70     // Protected Member Functions
  71
  72         //- Read constrols from fvSolution dictionary
  73         virtual void read();
  74
  75         //- Return true if all convergence checks are satified
  76         virtual bool criteriaSatisfied();
  77
  78         //- Disallow default bitwise copy construct
  79         pimpleControl(const pimpleControl&);
  80
  81         //- Disallow default bitwise assignment
  82         void operator=(const pimpleControl&);
  83
  84
  85 public:
  86
  87
  88     // Static Data Members
  89
  90         //- Run-time type information
  91         TypeName("pimpleControl");
  92
  93
  94     // Constructors
  95
  96         //- Construct from mesh
  97         pimpleControl(fvMesh& mesh);
  98
  99
 100     //- Destructor
 101     virtual ~pimpleControl();
 102
 103
 104     // Member Functions
 105
 106         // Access
 107
 108             //- Current corrector index
 109             inline label corr() const;
 110
 111             //- Maximum number of PIMPLE correctors
 112             inline label nOuterCorr() const;
 113
 114             //- Maximum number of PISO correctors
 115             inline label nCorr() const;
 116
 117
 118         // Solution control
 119
 120             //- Loop start
 121             inline bool start();
 122
 123             //- Loop loop
 124             inline bool loop();
 125
 126             //- Helper function to identify final PIMPLE (outer) iteration
 127             inline bool finalIter() const;
 128
 129             //- Helper function to identify final inner iteration
 130             inline bool finalInnerIter
 131             (
 132                 const label corr,
 133                 const label nonOrth
 134             ) const;
 135
 136             //- Helper function to identify whether to solve for turbulence
 137             inline bool turbCorr() const;
 138
 139
 140     // Member Operators
 141
 142         void operator++(int);
 143 };
 144
 145
 146 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 147
 148 } // End namespace Foam
 149
 150 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 151
 152 #include "pimpleControlI.H"
 153
 154 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 155
 156 #endif
 157
 158 // ************************************************************************* //