File size: 4,686 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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::pimpleMultiRegionControl
Description
Pimple multi-region control class. As Foam::pimpleControl, but for a multi-
region simulation comprising pimple and solid regions. More region types
could be added.
SourceFiles
pimpleMultiRegionControlI.H
pimpleMultiRegionControl.C
\*---------------------------------------------------------------------------*/
#ifndef pimpleMultiRegionControl_H
#define pimpleMultiRegionControl_H
#include "solver.H"
#include "multiRegionSolutionControl.H"
#include "pimpleLoop.H"
#include "convergenceControl.H"
#include "correctorConvergenceControl.H"
#include "pimpleNoLoopControl.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class pimpleMultiRegionControl Declaration
\*---------------------------------------------------------------------------*/
class pimpleMultiRegionControl
:
public multiRegionSolutionControl,
private autoPtr<printDictionary>,
public pimpleLoop,
public convergenceControl,
public correctorConvergenceControl
{
// Private data
//- The per-region pimple controls
UPtrList<pimpleNoLoopControl> pimpleControls_;
//- Maximum number of energy correctors
label nEcorr_;
//- Current energy corrector
label Ecorr_;
protected:
// Protected Member Functions
//- Read controls
virtual bool read();
public:
// Static Data Members
//- Run-time type information
TypeName("pimpleMultiRegionControl");
// Constructors
//- Construct from time and the list of solvers
pimpleMultiRegionControl
(
const Time& runTime,
PtrList<solver>& solvers,
const word& algorithmName = "PIMPLE"
);
//- Destructor
virtual ~pimpleMultiRegionControl();
// Member Functions
// Access
//- Access the i-th pimple control
inline pimpleNoLoopControl& pimple(const label i);
// Evolution
//- Return true if residual controls are present
virtual bool hasResidualControls() const;
//- Return true if corrector residual controls are present
virtual bool hasCorrResidualControls() const;
//- Return true if all convergence checks are satisfied
virtual convergenceData criteriaSatisfied() const;
//- Return true if all correction convergence checks are satisfied
virtual bool corrCriteriaSatisfied() const;
//- Reset the solve index in the correction residual control data
virtual void resetCorrSolveIndex();
//- Update the solve index in the correction residual control data
virtual void updateCorrSolveIndex();
//- Pimple loop
bool loop();
//- Energy corrector loop
bool correctEnergy();
//- Time run loop
bool run(Time& time);
//- Time loop loop
bool loop(Time& time);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "pimpleMultiRegionControlI.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|