fvmSup.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 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::fvm
26 
27 Description
28  Calculate the matrix for implicit and explicit sources.
29 
30 SourceFiles
31  fvmSup.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef fvmSup_H
36 #define fvmSup_H
37 
38 #include "volFieldsFwd.H"
39 #include "fvMatrix.H"
40 #include "zeroField.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Namespace fvm functions Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 namespace fvm
52 {
53  // Explicit source
54 
55  template<class Type>
56  tmp<fvMatrix<Type> > Su
57  (
58  const DimensionedField<Type, volMesh>&,
59  const GeometricField<Type, fvPatchField, volMesh>&
60  );
61 
62  template<class Type>
63  tmp<fvMatrix<Type> > Su
64  (
65  const tmp<DimensionedField<Type, volMesh> >&,
66  const GeometricField<Type, fvPatchField, volMesh>&
67  );
68 
69  template<class Type>
70  tmp<fvMatrix<Type> > Su
71  (
72  const tmp<GeometricField<Type, fvPatchField, volMesh> >&,
73  const GeometricField<Type, fvPatchField, volMesh>&
74  );
75 
76  template<class Type>
77  zeroField Su
78  (
79  const zero&,
80  const GeometricField<Type, fvPatchField, volMesh>&
81  );
82 
83 
84  // Implicit source
85 
86  template<class Type>
87  tmp<fvMatrix<Type> > Sp
88  (
89  const DimensionedField<scalar, volMesh>&,
90  const GeometricField<Type, fvPatchField, volMesh>&
91  );
92 
93  template<class Type>
94  tmp<fvMatrix<Type> > Sp
95  (
96  const tmp<DimensionedField<scalar, volMesh> >&,
97  const GeometricField<Type, fvPatchField, volMesh>&
98  );
99 
100  template<class Type>
101  tmp<fvMatrix<Type> > Sp
102  (
103  const tmp<volScalarField>&,
104  const GeometricField<Type, fvPatchField, volMesh>&
105  );
106 
107 
108  template<class Type>
109  tmp<fvMatrix<Type> > Sp
110  (
111  const dimensionedScalar&,
112  const GeometricField<Type, fvPatchField, volMesh>&
113  );
114 
115 
116  template<class Type>
117  zeroField Sp
118  (
119  const zero&,
120  const GeometricField<Type, fvPatchField, volMesh>&
121  );
122 
123 
124  // Implicit/Explicit source depending on sign of coefficient
125 
126  template<class Type>
127  tmp<fvMatrix<Type> > SuSp
128  (
129  const DimensionedField<scalar, volMesh>&,
130  const GeometricField<Type, fvPatchField, volMesh>&
131  );
132 
133  template<class Type>
134  tmp<fvMatrix<Type> > SuSp
135  (
136  const tmp<DimensionedField<scalar, volMesh> >&,
137  const GeometricField<Type, fvPatchField, volMesh>&
138  );
139 
140  template<class Type>
141  tmp<fvMatrix<Type> > SuSp
142  (
143  const tmp<volScalarField>&,
144  const GeometricField<Type, fvPatchField, volMesh>&
145  );
146 
147  template<class Type>
148  zeroField SuSp
149  (
150  const zero&,
151  const GeometricField<Type, fvPatchField, volMesh>&
152  );
153 }
154 
155 
156 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
157 
158 } // End namespace Foam
159 
160 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
161 
162 #ifdef NoRepository
163 # include "fvmSup.C"
164 #endif
165 
166 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
167 
168 #endif
169 
170 // ************************************************************************* //
tmp< fvMatrix< Type > > Sp(const DimensionedField< scalar, volMesh > &, const GeometricField< Type, fvPatchField, volMesh > &)
Namespace for OpenFOAM.
tmp< fvMatrix< Type > > SuSp(const DimensionedField< scalar, volMesh > &, const GeometricField< Type, fvPatchField, volMesh > &)
tmp< fvMatrix< Type > > Su(const DimensionedField< Type, volMesh > &, const GeometricField< Type, fvPatchField, volMesh > &)
dimensioned< scalar > dimensionedScalar
Dimensioned scalar obtained from generic dimensioned type.