src/finiteVolume/finiteVolume/fvm/fvmSup.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 InNamespace
  26     Foam::fvm
  27
  28 Description
  29     Calculate the matrix for implicit and explicit sources.
  30
  31 SourceFiles
  32     fvmSup.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef fvmSup_H
  37 #define fvmSup_H
  38
  39 #include "volFieldsFwd.H"
  40 #include "fvMatrix.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             GeometricField<Type, fvPatchField, volMesh>&
  60         );
  61
  62         template<class Type>
  63         tmp<fvMatrix<Type> > Su
  64         (
  65             const tmp<DimensionedField<Type, volMesh> >&,
  66             GeometricField<Type, fvPatchField, volMesh>&
  67         );
  68
  69         template<class Type>
  70         tmp<fvMatrix<Type> > Su
  71         (
  72             const tmp<GeometricField<Type, fvPatchField, volMesh> >&,
  73             GeometricField<Type, fvPatchField, volMesh>&
  74         );
  75
  76         template<class Type>
  77         zeroField Su
  78         (
  79             const zeroField&,
  80             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             GeometricField<Type, fvPatchField, volMesh>&
  91         );
  92
  93         template<class Type>
  94         tmp<fvMatrix<Type> > Sp
  95         (
  96             const tmp<DimensionedField<scalar, volMesh> >&,
  97             GeometricField<Type, fvPatchField, volMesh>&
  98         );
  99
 100         template<class Type>
 101         tmp<fvMatrix<Type> > Sp
 102         (
 103             const tmp<volScalarField>&,
 104             GeometricField<Type, fvPatchField, volMesh>&
 105         );
 106
 107
 108         template<class Type>
 109         tmp<fvMatrix<Type> > Sp
 110         (
 111             const dimensionedScalar&,
 112             GeometricField<Type, fvPatchField, volMesh>&
 113         );
 114
 115
 116         template<class Type>
 117         zeroField Sp
 118         (
 119             const zeroField&,
 120             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             GeometricField<Type, fvPatchField, volMesh>&
 131         );
 132
 133         template<class Type>
 134         tmp<fvMatrix<Type> > SuSp
 135         (
 136             const tmp<DimensionedField<scalar, volMesh> >&,
 137             GeometricField<Type, fvPatchField, volMesh>&
 138         );
 139
 140         template<class Type>
 141         tmp<fvMatrix<Type> > SuSp
 142         (
 143             const tmp<volScalarField>&,
 144             GeometricField<Type, fvPatchField, volMesh>&
 145         );
 146
 147         template<class Type>
 148         zeroField SuSp
 149         (
 150             const zeroField&,
 151             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 // ************************************************************************* //