fvcSup.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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011-2016 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26InNamespace
27 Foam::fvc
28
29Description
30 Calculate the field for explicit evaluation of implicit and explicit
31 sources.
32
33SourceFiles
34 fvcSup.C
35
36\*---------------------------------------------------------------------------*/
37
38#ifndef fvcSup_H
39#define fvcSup_H
40
41#include "volFieldsFwd.H"
42
43// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44
45namespace Foam
46{
47
48/*---------------------------------------------------------------------------*\
49 Namespace fvc functions Declaration
50\*---------------------------------------------------------------------------*/
51
52namespace fvc
53{
54 // Explicit source
55
56 template<class Type>
57 tmp<GeometricField<Type, fvPatchField, volMesh>> Su
58 (
59 const GeometricField<Type, fvPatchField, volMesh>&,
60 const GeometricField<Type, fvPatchField, volMesh>&
61 );
62
63 template<class Type>
64 tmp<GeometricField<Type, fvPatchField, volMesh>> Su
65 (
66 const tmp<GeometricField<Type, fvPatchField, volMesh>>&,
67 const GeometricField<Type, fvPatchField, volMesh>&
68 );
69
70
71 // Implicit source
72
73 template<class Type>
74 tmp<GeometricField<Type, fvPatchField, volMesh>> Sp
75 (
76 const volScalarField&,
77 const GeometricField<Type, fvPatchField, volMesh>&
78 );
79
80 template<class Type>
81 tmp<GeometricField<Type, fvPatchField, volMesh>> Sp
82 (
83 const tmp<volScalarField>&,
84 const GeometricField<Type, fvPatchField, volMesh>&
85 );
86
87
88 template<class Type>
89 tmp<GeometricField<Type, fvPatchField, volMesh>> Sp
90 (
91 const dimensionedScalar&,
92 const GeometricField<Type, fvPatchField, volMesh>&
93 );
94
95
96 // Implicit/Explicit source depending on sign of coefficient
97
98 template<class Type>
99 tmp<GeometricField<Type, fvPatchField, volMesh>> SuSp
100 (
101 const volScalarField&,
102 const GeometricField<Type, fvPatchField, volMesh>&
103 );
104
105 template<class Type>
106 tmp<GeometricField<Type, fvPatchField, volMesh>> SuSp
107 (
108 const tmp<volScalarField>&,
109 const GeometricField<Type, fvPatchField, volMesh>&
110 );
111}
112
113
114// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115
116} // End namespace Foam
117
118// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119
120#ifdef NoRepository
121 #include "fvcSup.C"
122#endif
123
124// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125
126#endif
127
128// ************************************************************************* //
zeroField Su
Definition: alphaSuSp.H:1
zeroField Sp
Definition: alphaSuSp.H:2
tmp< GeometricField< Type, fvPatchField, volMesh > > SuSp(const volScalarField &sp, const GeometricField< Type, fvPatchField, volMesh > &vf)
Definition: fvcSup.C:104
Namespace for OpenFOAM.
dimensioned< scalar > dimensionedScalar
Dimensioned scalar obtained from generic dimensioned type.
GeometricField< scalar, fvPatchField, volMesh > volScalarField
Definition: volFieldsFwd.H:82