pisoControl.H
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2015-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::pisoControl
Description
Specialization of the pimpleControl class for PISO control.
\*---------------------------------------------------------------------------*/
#ifndef pisoControl_H
#define pisoControl_H
#include "pimpleControl.H"
//- Declare that pisoControl will be used
#define PISO_CONTROL
#undef PIMPLE_CONTROL //#undef 是在后面取消以前定义的宏定义
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam //名称空间
{
/*---------------------------------------------------------------------------*\
Class pisoControl Declaration
\*---------------------------------------------------------------------------*/
class pisoControl //类名
:
public pimpleControl //???
{
// Private member functions //私有数据,隐藏
//- Disallow default bitwise copy construct(不允许默认按位复制构造)
pisoControl(const pisoControl&); //const:变量不允许被改变
//- Disallow default bitwise assignment
void operator=(const pisoControl&);
public:
// Static Data Members
//- Run-time type information
TypeName("pisoControl");
// Constructors
//- Construct from mesh and the name of control sub-dictionary
pisoControl(fvMesh& mesh, const word& dictName="PISO");
//- Destructor
virtual ~pisoControl();
// Member Functions
// Solution control
//- Return true if in the final inner (PISO) iteration
inline bool finalInnerIter() const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "pisoControlI.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif // #endif用于结束条件编译
// ************************************************************************* //