fvmSup.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2022 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 "zeroField.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 template<class Type> class fvMatrix;
47 
48 /*---------------------------------------------------------------------------*\
49  Namespace fvm functions Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 namespace fvm
53 {
54  // Explicit source
55 
56  template<class Type>
57  tmp<fvMatrix<Type>> Su
58  (
59  const DimensionedField<Type, volMesh>&,
60  const GeometricField<Type, fvPatchField, volMesh>&
61  );
62 
63  template<class Type>
64  tmp<fvMatrix<Type>> Su
65  (
66  const tmp<DimensionedField<Type, volMesh>>&,
67  const GeometricField<Type, fvPatchField, volMesh>&
68  );
69 
70  template<class Type>
71  tmp<fvMatrix<Type>> Su
72  (
73  const tmp<GeometricField<Type, fvPatchField, volMesh>>&,
74  const GeometricField<Type, fvPatchField, volMesh>&
75  );
76 
77  template<class Type>
78  zeroField Su
79  (
80  const zero&,
81  const GeometricField<Type, fvPatchField, volMesh>&
82  );
83 
84 
85  // Implicit source
86 
87  template<class Type>
88  tmp<fvMatrix<Type>> Sp
89  (
91  const GeometricField<Type, fvPatchField, volMesh>&
92  );
93 
94  template<class Type>
95  tmp<fvMatrix<Type>> Sp
96  (
97  const tmp<volScalarField::Internal>&,
98  const GeometricField<Type, fvPatchField, volMesh>&
99  );
100 
101  template<class Type>
102  tmp<fvMatrix<Type>> Sp
103  (
104  const tmp<volScalarField>&,
105  const GeometricField<Type, fvPatchField, volMesh>&
106  );
107 
108 
109  template<class Type>
110  tmp<fvMatrix<Type>> Sp
111  (
112  const dimensionedScalar&,
113  const GeometricField<Type, fvPatchField, volMesh>&
114  );
115 
116 
117  template<class Type>
118  zeroField Sp
119  (
120  const zero&,
121  const GeometricField<Type, fvPatchField, volMesh>&
122  );
123 
124 
125  // Implicit/Explicit source depending on sign of coefficient
126 
127  template<class Type>
128  tmp<fvMatrix<Type>> SuSp
129  (
131  const GeometricField<Type, fvPatchField, volMesh>&
132  );
133 
134  template<class Type>
135  tmp<fvMatrix<Type>> SuSp
136  (
137  const tmp<volScalarField::Internal>&,
138  const GeometricField<Type, fvPatchField, volMesh>&
139  );
140 
141  template<class Type>
142  tmp<fvMatrix<Type>> SuSp
143  (
144  const tmp<volScalarField>&,
145  const GeometricField<Type, fvPatchField, volMesh>&
146  );
147 
148  template<class Type>
149  zeroField SuSp
150  (
151  const zero&,
152  const GeometricField<Type, fvPatchField, volMesh>&
153  );
154 
155 
156  // Explicit and implicit sources provided as a pair
157 
158  template<class Type>
159  tmp<fvMatrix<Type>> S
160  (
161  const Pair<tmp<volScalarField::Internal>>&,
162  const GeometricField<Type, fvPatchField, volMesh>&
163  );
164 }
165 
166 
167 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
168 
169 } // End namespace Foam
170 
171 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
172 
173 #ifdef NoRepository
174  #include "fvmSup.C"
175 #endif
176 
177 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
178 
179 #endif
180 
181 // ************************************************************************* //
tmp< fvMatrix< Type > > SuSp(const volScalarField::Internal &, const GeometricField< Type, fvPatchField, volMesh > &)
tmp< fvMatrix< Type > > Su(const DimensionedField< Type, volMesh > &, const GeometricField< Type, fvPatchField, volMesh > &)
tmp< fvMatrix< Type > > Sp(const volScalarField::Internal &, const GeometricField< Type, fvPatchField, volMesh > &)
DimensionedField< scalar, volMesh > Internal
Type of the internal field from which this GeometricField is derived.
tmp< fvMatrix< Type > > S(const Pair< tmp< volScalarField::Internal >> &, const GeometricField< Type, fvPatchField, volMesh > &)
dimensioned< scalar > dimensionedScalar
Dimensioned scalar obtained from generic dimensioned type.
Namespace for OpenFOAM.