File size: 5,459 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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  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::pimpleNoLoopControl

Description
    Pimple no-loop control class. Implements various option flags, but leaves
    loop controls to the derivation or owner. Can be derived into a "full"
    pimple control or can be owned by a multi-region pimple class.

SourceFiles
    pimpleNoLoopControlI.H
    pimpleNoLoopControl.C

\*---------------------------------------------------------------------------*/

#ifndef pimpleNoLoopControl_H
#define pimpleNoLoopControl_H

#include "pisoControl.H"
#include "singleRegionConvergenceControl.H"
#include "singleRegionCorrectorConvergenceControl.H"

#undef PISO_CONTROL
#define PIMPLE_CONTROL

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{

class pimpleLoop;

/*---------------------------------------------------------------------------*\
                     Class pimpleNoLoopControl Declaration
\*---------------------------------------------------------------------------*/

class pimpleNoLoopControl
:
    // private autoPtr<printDictionary>,
    public pisoControl,
    public singleRegionConvergenceControl,
    public singleRegionCorrectorConvergenceControl
{
    friend class pimpleSingleRegionControl;
    friend class pimpleMultiRegionControl;

    // Private data

        pimpleLoop* pimpleLoopPtr_;


protected:

    // Protected data

        //- Switch to move the mesh at the start of every PIMPLE outer corrector
        //  rather than the first corrector only which is the default
        bool moveMeshOuterCorrectors_;

        //- Switch to indicate whether to update the density in SIMPLE mode
        //  rather than PISO mode
        bool simpleRho_;

        //- Switch to control whether transport models are predicted
        //  just on the first pimple iteration, or on every pimple iteration
        bool transportPredictionFirst_;

        //- Switch to control whether transport models are corrected
        //  just on the final pimple iteration, or on every pimple iteration
        bool transportCorrectionFinal_;


    // Protected Member Functions

        //- Read controls
        virtual bool read();


public:

    // Static Data Members

        //- Run-time type information
        TypeName("pimpleNoLoopControl");


    // Constructors

        //- Construct from a mesh, the name of the algorithm, and a reference
        //  to the pimple loop
        pimpleNoLoopControl
        (
            const fvMesh& mesh,
            const word& algorithmName="PIMPLE"
        );


    //- Destructor
    virtual ~pimpleNoLoopControl();


    // Member Functions

        // Access

            using singleRegionSolutionControl::dict;

            //- Return the solution dictionary
            static const dictionary& dict
            (
                const fvMesh& mesh,
                const word& algorithmName="PIMPLE"
            );

            //- Switch to move the mesh at the start of every PIMPLE
            //  outer corrected rather than the first corrector only
            //  which is the default
            inline bool moveMeshOuterCorrectors() const;

            //- Switch to indicate whether to update the density in simple mode
            inline bool simpleRho() const;

            //- Flag to indicate whether to predict the transport models
            inline bool predictTransport() const;

            //- Flag to indicate whether to correct the transport models
            inline bool correctTransport() const;

            //- Maximum number of correctors
            inline label nCorr() const;

            //- Flag to indicate the first iteration
            inline bool firstIter() const;

            //- Flag to indicate the final iteration
            inline bool finalIter() const;


        // Evolution

            //- Piso loop within outer loop
            bool correct();

            //- Non-orthogonal corrector loop
            bool correctNonOrthogonal();
};


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#include "pimpleNoLoopControlI.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //