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 | Copyright (C) 2011-2013 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 InNamespace
25  Foam::fvc
26 
27 Description
28  Calculate the field for explicit evaluation of implicit and explicit
29  sources.
30 
31 SourceFiles
32  fvcSup.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef fvcSup_H
37 #define fvcSup_H
38 
39 #include "volFieldsFwd.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Namespace fvc functions Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 namespace fvc
51 {
52  // Explicit source
53 
54  template<class Type>
55  tmp<GeometricField<Type, fvPatchField, volMesh> > Su
56  (
57  const GeometricField<Type, fvPatchField, volMesh>&,
58  const GeometricField<Type, fvPatchField, volMesh>&
59  );
60 
61  template<class Type>
62  tmp<GeometricField<Type, fvPatchField, volMesh> > Su
63  (
64  const tmp<GeometricField<Type, fvPatchField, volMesh> >&,
65  const GeometricField<Type, fvPatchField, volMesh>&
66  );
67 
68 
69  // Implicit source
70 
71  template<class Type>
72  tmp<GeometricField<Type, fvPatchField, volMesh> > Sp
73  (
74  const volScalarField&,
75  const GeometricField<Type, fvPatchField, volMesh>&
76  );
77 
78  template<class Type>
79  tmp<GeometricField<Type, fvPatchField, volMesh> > Sp
80  (
81  const tmp<volScalarField>&,
82  const GeometricField<Type, fvPatchField, volMesh>&
83  );
84 
85 
86  template<class Type>
87  tmp<GeometricField<Type, fvPatchField, volMesh> > Sp
88  (
89  const dimensionedScalar&,
90  const GeometricField<Type, fvPatchField, volMesh>&
91  );
92 
93 
94  // Implicit/Explicit source depending on sign of coefficient
95 
96  template<class Type>
97  tmp<GeometricField<Type, fvPatchField, volMesh> > SuSp
98  (
99  const volScalarField&,
100  const GeometricField<Type, fvPatchField, volMesh>&
101  );
102 
103  template<class Type>
104  tmp<GeometricField<Type, fvPatchField, volMesh> > SuSp
105  (
106  const tmp<volScalarField>&,
107  const GeometricField<Type, fvPatchField, volMesh>&
108  );
109 }
110 
111 
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 
114 } // End namespace Foam
115 
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 
118 #ifdef NoRepository
119 # include "fvcSup.C"
120 #endif
121 
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123 
124 #endif
125 
126 // ************************************************************************* //
tmp< GeometricField< Type, fvPatchField, volMesh > > Sp(const volScalarField &sp, const GeometricField< Type, fvPatchField, volMesh > &vf)
Definition: fvcSup.C:67
Namespace for OpenFOAM.
tmp< GeometricField< Type, fvPatchField, volMesh > > Su(const GeometricField< Type, fvPatchField, volMesh > &su, const GeometricField< Type, fvPatchField, volMesh > &vf)
Definition: fvcSup.C:44
GeometricField< scalar, fvPatchField, volMesh > volScalarField
Definition: volFieldsFwd.H:52
tmp< GeometricField< Type, fvPatchField, volMesh > > SuSp(const volScalarField &sp, const GeometricField< Type, fvPatchField, volMesh > &vf)
Definition: fvcSup.C:102
dimensioned< scalar > dimensionedScalar
Dimensioned scalar obtained from generic dimensioned type.