File size: 6,044 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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2022-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::solver

Description
    Abstract base class for run-time selectable region solvers.

SourceFiles
    solver.C
    solverNew.C

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

#ifndef solver_H
#define solver_H

#include "fvMesh.H"
#include "pimpleNoLoopControl.H"
#include "fvModels.H"
#include "fvConstraints.H"
#include "regionName.H"

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

namespace Foam
{

/*---------------------------------------------------------------------------*\
                        Class solver Declaration
\*---------------------------------------------------------------------------*/

class solver
:
    public regIOobject
{
protected:

    // Protected Data

        //- Region mesh
        fvMesh& mesh_;

        //- Switch for steady-state
        //  Set automatically from the selected ddt scheme
        bool steady;

        //- Switch for local time step transient operation
        //  Set automatically from the selected ddt scheme
        bool LTS;


private:

    // Private Data

        //- Pointer to the demand driven fvModels MeshObject
        mutable Foam::fvModels* fvModelsPtr;

        //- Pointer to the demand driven fvConstraints MeshObject
        mutable Foam::fvConstraints* fvConstraintsPtr;


    // Private Member Functions

        //- Dummy write for regIOobject
        virtual bool writeData(Ostream&) const;


protected:

        //- Read controls
        virtual bool read();


public:

    // Public Data

        //- Region mesh
        const fvMesh& mesh;

        //- Time
        const Time& runTime;

        //- PIMPLE inner-loop controls
        pimpleNoLoopControl pimple;

        //- deltaT increase factor
        static scalar deltaTFactor;


    //- Runtime type information
    TypeName("solver");


    // Declare run-time constructor selection table

        declareRunTimeSelectionTable
        (
            autoPtr,
            solver,
            fvMesh,
            (fvMesh& mesh),
            (mesh)
        );


    // Constructors

        //- Construct from region mesh
        solver(fvMesh& mesh);

        //- Disallow default bitwise copy construction
        solver(const solver&) = delete;


    // Selectors

        //- Select, construct and return the solver
        static autoPtr<solver> New
        (
            const word& solverName,
            fvMesh& mesh
        );

        //- Load the specified solver library
        static void load(const word& solverName);


    //- Destructor
    virtual ~solver();


    // Member Functions

        bool transient() const
        {
            return !steady && !LTS;
        }

        //- Return the fvModels that are created on demand
        Foam::fvModels& fvModels() const;

        //- Return the fvConstraints that are created on demand
        Foam::fvConstraints& fvConstraints() const;

        //- Return the current maximum time-step for stable solution
        virtual scalar maxDeltaT() const = 0;

        //- Called at the start of the time-step, before the PIMPLE loop
        virtual void preSolve() = 0;

        //- Called at the start of the PIMPLE loop to move the mesh
        virtual void moveMesh() = 0;

        //- Corrections that follow mesh motion
        virtual void motionCorrector() = 0;

        //- Called at the start of the PIMPLE loop
        virtual void prePredictor() = 0;

        //- Predict the momentum transport
        virtual void momentumTransportPredictor() = 0;

        //- Predict thermophysical transport
        virtual void thermophysicalTransportPredictor() = 0;

        //- Construct and optionally solve the momentum equation
        virtual void momentumPredictor() = 0;

        //- Construct and solve the thermophysical property equations,
        //  convert to temperature
        //  and update thermophysical and transport properties
        virtual void thermophysicalPredictor() = 0;

        //- Construct and solve the pressure equation in the PISO loop
        virtual void pressureCorrector() = 0;

        //- Correct the momentum transport
        virtual void momentumTransportCorrector() = 0;

        //- Correct the thermophysical transport
        virtual void thermophysicalTransportCorrector() = 0;

        //- Called after the PIMPLE loop at the end of the time-step
        virtual void postSolve() = 0;


    // Member Operators

        //- Disallow default bitwise assignment
        void operator=(const solver&) = delete;
};


template<>
inline const word& regionName(const solver& region)
{
    return regionName(region.mesh);
}


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

} // End namespace Foam

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

#endif

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