mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
167 lines
4.6 KiB
C++
167 lines
4.6 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2011-2016 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::pimpleControl
|
|
|
|
Description
|
|
PIMPLE control class to supply convergence information/checks for
|
|
the PIMPLE loop.
|
|
|
|
May also be used to for PISO-based algorithms as PISO controls are a
|
|
sub-set of PIMPLE controls.
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef pimpleControl_H
|
|
#define pimpleControl_H
|
|
|
|
#include "solutionControl.H"
|
|
|
|
//- Declare that pimpleControl will be used
|
|
#define PIMPLE_CONTROL
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class pimpleControl Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class pimpleControl
|
|
:
|
|
public solutionControl
|
|
{
|
|
// Private member functions
|
|
|
|
//- Disallow default bitwise copy construct
|
|
pimpleControl(const pimpleControl&);
|
|
|
|
//- Disallow default bitwise assignment
|
|
void operator=(const pimpleControl&);
|
|
|
|
|
|
protected:
|
|
|
|
// Protected data
|
|
|
|
// Solution controls
|
|
|
|
//- Maximum number of PIMPLE correctors
|
|
label nCorrPIMPLE_;
|
|
|
|
//- Maximum number of PISO correctors
|
|
label nCorrPISO_;
|
|
|
|
//- Current PISO corrector
|
|
label corrPISO_;
|
|
|
|
//- Flag to indicate whether to only solve turbulence on final iter
|
|
bool turbOnFinalIterOnly_;
|
|
|
|
//- Converged flag
|
|
bool converged_;
|
|
|
|
|
|
// Protected Member Functions
|
|
|
|
//- Read controls from fvSolution dictionary
|
|
virtual void read();
|
|
|
|
//- Return true if all convergence checks are satisfied
|
|
virtual bool criteriaSatisfied();
|
|
|
|
|
|
public:
|
|
|
|
// Static Data Members
|
|
|
|
//- Run-time type information
|
|
TypeName("pimpleControl");
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Construct from mesh and the name of control sub-dictionary
|
|
pimpleControl(fvMesh& mesh, const word& dictName="PIMPLE");
|
|
|
|
|
|
//- Destructor
|
|
virtual ~pimpleControl();
|
|
|
|
|
|
// Member Functions
|
|
|
|
// Access
|
|
|
|
//- Maximum number of PIMPLE correctors
|
|
inline label nCorrPIMPLE() const;
|
|
|
|
//- Maximum number of PISO correctors
|
|
inline label nCorrPISO() const;
|
|
|
|
//- Current PISO corrector index
|
|
inline label corrPISO() const;
|
|
|
|
|
|
// Solution control
|
|
|
|
//- PIMPLE loop
|
|
virtual bool loop();
|
|
|
|
//- Pressure corrector loop
|
|
inline bool correct();
|
|
|
|
//- Helper function to identify when to store the intial residuals
|
|
inline bool storeInitialResiduals() const;
|
|
|
|
//- Helper function to identify first PIMPLE (outer) iteration
|
|
inline bool firstIter() const;
|
|
|
|
//- Helper function to identify final PIMPLE (outer) iteration
|
|
inline bool finalIter() const;
|
|
|
|
//- Helper function to identify final inner iteration
|
|
inline bool finalInnerIter() const;
|
|
|
|
//- Helper function to identify whether to solve for turbulence
|
|
inline bool turbCorr() const;
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#include "pimpleControlI.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|