DOC: API documentation fixes
[freefoam.git] / src / finiteVolume / fvMatrices / solvers / MULES / MULES.H
blobb5c785ec0d4fea628e33e50257332557e3c8f8bf
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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.
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.
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/>.
24 Namespace
25     Foam::MULES
27 Description
28     Multidimensional universal limiter with explicit solution.
30     Solve a convective-only transport equation using an explicit universal
31     multi-dimensional limiter.
33     Parameters are the variable to solve, the normal convective flux and the
34     actual explicit flux of the variable which is also used to return limited
35     flux used in the bounded-solution.
37 SourceFiles
38     MULES.C
40 \*---------------------------------------------------------------------------*/
42 #ifndef MULES_H
43 #define MULES_H
45 #include <finiteVolume/volFields.H>
46 #include <finiteVolume/surfaceFieldsFwd.H>
47 #include <OpenFOAM/primitiveFieldsFwd.H>
48 #include <OpenFOAM/zeroField.H>
49 #include <OpenFOAM/geometricOneField.H>
51 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
53 namespace Foam
56 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
58 namespace MULES
61 template<class RhoType, class SpType, class SuType>
62 void explicitSolve
64     const RhoType& rho,
65     volScalarField& psi,
66     const surfaceScalarField& phiBD,
67     surfaceScalarField& phiPsi,
68     const SpType& Sp,
69     const SuType& Su,
70     const scalar psiMax,
71     const scalar psiMin
74 void explicitSolve
76     volScalarField& psi,
77     const surfaceScalarField& phiBD,
78     surfaceScalarField& phiPsi,
79     const scalar psiMax,
80     const scalar psiMin
83 template<class RhoType, class SpType, class SuType>
84 void implicitSolve
86     const RhoType& rho,
87     volScalarField& gamma,
88     const surfaceScalarField& phi,
89     surfaceScalarField& phiCorr,
90     const SpType& Sp,
91     const SuType& Su,
92     const scalar psiMax,
93     const scalar psiMin
96 void implicitSolve
98     volScalarField& gamma,
99     const surfaceScalarField& phi,
100     surfaceScalarField& phiCorr,
101     const scalar psiMax,
102     const scalar psiMin
105 template<class RhoType, class SpType, class SuType>
106 void limiter
108     scalarField& allLambda,
109     const RhoType& rho,
110     const volScalarField& psi,
111     const surfaceScalarField& phiBD,
112     const surfaceScalarField& phiCorr,
113     const SpType& Sp,
114     const SuType& Su,
115     const scalar psiMax,
116     const scalar psiMin,
117     const label nLimiterIter
120 } // End namespace MULES
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
124 } // End namespace Foam
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
128 #ifdef NoRepository
129 #   include <finiteVolume/MULESTemplates.C>
130 #endif
132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 #endif
136 // ************************ vim: set sw=4 sts=4 et: ************************ //