IMULES.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2013-2016 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Global
25  IMULES
26 
27 Description
28  IMULES: Multidimensional universal limiter for implicit solution.
29 
30  Solve a convective-only transport equation using an explicit universal
31  multi-dimensional limiter applied to an implicit formulation requiring
32  iteration to guarantee boundedness. The number of iterations required
33  to obtain boundedness increases with the Courant number of the simulation.
34 
35  It may be more efficient to use CMULES.
36 
37 SourceFiles
38  IMULES.C
39  IMULESTemplates.C
40 
41 \*---------------------------------------------------------------------------*/
42 
43 #ifndef IMULES_H
44 #define IMULES_H
45 
46 #include "MULES.H"
47 
48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
49 
50 namespace Foam
51 {
52 namespace MULES
53 {
54 
55 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
56 
57 template<class RhoType, class SpType, class SuType>
58 void implicitSolve
59 (
60  const RhoType& rho,
61  volScalarField& gamma,
62  const surfaceScalarField& phi,
63  surfaceScalarField& phiCorr,
64  const SpType& Sp,
65  const SuType& Su,
66  const scalar psiMax,
67  const scalar psiMin
68 );
69 
70 void implicitSolve
71 (
72  volScalarField& gamma,
73  const surfaceScalarField& phi,
74  surfaceScalarField& phiCorr,
75  const scalar psiMax,
76  const scalar psiMin
77 );
78 
79 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
80 
81 } // End namespace MULES
82 } // End namespace Foam
83 
84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
85 
86 #ifdef NoRepository
87  #include "IMULESTemplates.C"
88 #endif
89 
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91 
92 #endif
93 
94 // ************************************************************************* //
surfaceScalarField & phi
tmp< GeometricField< Type, fvPatchField, volMesh > > Sp(const volScalarField &sp, const GeometricField< Type, fvPatchField, volMesh > &vf)
Definition: fvcSup.C:67
GeometricField< scalar, fvPatchField, volMesh > volScalarField
Definition: volFieldsFwd.H:52
void implicitSolve(const RhoType &rho, volScalarField &gamma, const surfaceScalarField &phi, surfaceScalarField &phiCorr, const SpType &Sp, const SuType &Su, const scalar psiMax, const scalar psiMin)
MULES: Multidimensional universal limiter for explicit solution.
GeometricField< scalar, fvsPatchField, surfaceMesh > surfaceScalarField
tmp< GeometricField< Type, fvPatchField, volMesh > > Su(const GeometricField< Type, fvPatchField, volMesh > &su, const GeometricField< Type, fvPatchField, volMesh > &vf)
Definition: fvcSup.C:44
Namespace for OpenFOAM.