FreeFOAM The Cross-Platform CFD Toolkit
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) 1991-2010 OpenCFD Ltd.
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 
39 #include <finiteVolume/fvMatrix.H>
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Namespace fvm functions Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 namespace fvm
51 {
52  // Explicit source
53 
54  template<class Type>
55  tmp<fvMatrix<Type> > Su
56  (
57  const DimensionedField<Type, volMesh>&,
58  GeometricField<Type, fvPatchField, volMesh>&
59  );
60 
61  template<class Type>
62  tmp<fvMatrix<Type> > Su
63  (
64  const tmp<DimensionedField<Type, volMesh> >&,
65  GeometricField<Type, fvPatchField, volMesh>&
66  );
67 
68  template<class Type>
69  tmp<fvMatrix<Type> > Su
70  (
71  const tmp<GeometricField<Type, fvPatchField, volMesh> >&,
72  GeometricField<Type, fvPatchField, volMesh>&
73  );
74 
75  template<class Type>
76  zeroField Su
77  (
78  const zeroField&,
79  GeometricField<Type, fvPatchField, volMesh>&
80  );
81 
82 
83  // Implicit source
84 
85  template<class Type>
86  tmp<fvMatrix<Type> > Sp
87  (
88  const DimensionedField<scalar, volMesh>&,
89  GeometricField<Type, fvPatchField, volMesh>&
90  );
91 
92  template<class Type>
93  tmp<fvMatrix<Type> > Sp
94  (
95  const tmp<DimensionedField<scalar, volMesh> >&,
96  GeometricField<Type, fvPatchField, volMesh>&
97  );
98 
99  template<class Type>
100  tmp<fvMatrix<Type> > Sp
101  (
102  const tmp<volScalarField>&,
103  GeometricField<Type, fvPatchField, volMesh>&
104  );
105 
106 
107  template<class Type>
108  tmp<fvMatrix<Type> > Sp
109  (
110  const dimensionedScalar&,
111  GeometricField<Type, fvPatchField, volMesh>&
112  );
113 
114 
115  template<class Type>
116  zeroField Sp
117  (
118  const zeroField&,
119  GeometricField<Type, fvPatchField, volMesh>&
120  );
121 
122 
123  // Implicit/Explicit source depending on sign of coefficient
124 
125  template<class Type>
126  tmp<fvMatrix<Type> > SuSp
127  (
128  const DimensionedField<scalar, volMesh>&,
129  GeometricField<Type, fvPatchField, volMesh>&
130  );
131 
132  template<class Type>
133  tmp<fvMatrix<Type> > SuSp
134  (
135  const tmp<DimensionedField<scalar, volMesh> >&,
136  GeometricField<Type, fvPatchField, volMesh>&
137  );
138 
139  template<class Type>
140  tmp<fvMatrix<Type> > SuSp
141  (
142  const tmp<volScalarField>&,
143  GeometricField<Type, fvPatchField, volMesh>&
144  );
145 
146  template<class Type>
147  zeroField SuSp
148  (
149  const zeroField&,
150  GeometricField<Type, fvPatchField, volMesh>&
151  );
152 }
153 
154 
155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
156 
157 } // End namespace Foam
158 
159 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
160 
161 #ifdef NoRepository
162 # include <finiteVolume/fvmSup.C>
163 #endif
164 
165 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
166 
167 #endif
168 
169 // ************************ vim: set sw=4 sts=4 et: ************************ //