File size: 4,850 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
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2022-2025 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::solvers::basicFluidSolver

Description
    Base solver module for fluid solvers.

    Provides Courant number time-step control and continuity checking.

    Reference:
    \verbatim
        Greenshields, C. J., & Weller, H. G. (2022).
        Notes on Computational Fluid Dynamics: General Principles.
        CFD Direct Ltd.: Reading, UK.
    \endverbatim

SourceFiles
    basicFluidSolver.C

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

#ifndef basicFluidSolver_H
#define basicFluidSolver_H

#include "solver.H"

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

namespace Foam
{
namespace solvers
{

/*---------------------------------------------------------------------------*\
                          Class basicFluidSolver Declaration
\*---------------------------------------------------------------------------*/

class basicFluidSolver
:
    public solver
{
    // Control parameters

        //- Maximum allowed Courant number
        scalar maxCo;

        //- Maximum time-step
        scalar maxDeltaT_;

        //- Switch to check the mesh Courant number after mesh change
        bool checkMeshCourantNo;


    // Continuity properties

        //- Current cumulative continuity error
        scalar cumulativeContErr;


    // Private Member Functions

        //- Correct the cached Courant numbers
        template<class RhoType>
        inline void correctCoNum
        (
            const RhoType& rho,
            const surfaceScalarField& phi
        );


protected:

        //- Return true if the solver's dependencies have been modified
        virtual bool dependenciesModified() const;

        //- Read controls
        virtual bool read();

        //- Switch to correct the flux after mesh change
        bool correctPhi;

        //- Current maximum Courant number for time-step control
        scalar CoNum_;

        //- Check mesh Courant numbers for moving mesh cases
        void meshCourantNo() const;

        //- Correct the cached Courant numbers
        void correctCoNum(const surfaceScalarField& phi);

        //- Correct the cached Courant numbers
        void correctCoNum
        (
            const volScalarField& rho,
            const surfaceScalarField& phi
        );

        //- Calculate and print the continuity errors
        void continuityErrors
        (
            const surfaceScalarField& phi
        );

        //- Calculate and print the continuity errors
        void continuityErrors
        (
            const volScalarField& rho,
            const volScalarField& thermoRho,
            const surfaceScalarField& phi
        );


public:

    // Public Data

        //- Current maximum Courant number for time-step control
        const scalar& CoNum;


public:

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


    // Constructors

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

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


    //- Destructor
    virtual ~basicFluidSolver();


    // Member Functions

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


    // Member Operators

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


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

} // End namespace solvers
} // End namespace Foam

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

#endif

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