src/finiteVolume/finiteVolume/fvc/fvcFlux.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::fvc
  27
  28 Description
  29     Calculate the face-flux of the given field.
  30
  31 SourceFiles
  32     fvcFlux.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36
  37 #ifndef fvcFlux_H
  38 #define fvcFlux_H
  39
  40 #include "volFieldsFwd.H"
  41 #include "surfaceFieldsFwd.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                      Namespace fvc functions Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 namespace fvc
  53 {
  54     template<class Type>
  55     tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > flux
  56     (
  57         const surfaceScalarField&,
  58         const GeometricField<Type, fvPatchField, volMesh>&,
  59         const word& name
  60     );
  61
  62     template<class Type>
  63     tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > flux
  64     (
  65         const tmp<surfaceScalarField>&,
  66         const GeometricField<Type, fvPatchField, volMesh>&,
  67         const word& name
  68     );
  69
  70     template<class Type>
  71     tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > flux
  72     (
  73         const surfaceScalarField&,
  74         const tmp<GeometricField<Type, fvPatchField, volMesh> >&,
  75         const word& name
  76     );
  77
  78     template<class Type>
  79     tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > flux
  80     (
  81         const tmp<surfaceScalarField>&,
  82         const tmp<GeometricField<Type, fvPatchField, volMesh> >&,
  83         const word& name
  84     );
  85
  86
  87     template<class Type>
  88     tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > flux
  89     (
  90         const surfaceScalarField&,
  91         const GeometricField<Type, fvPatchField, volMesh>&
  92     );
  93
  94     template<class Type>
  95     tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > flux
  96     (
  97         const tmp<surfaceScalarField>&,
  98         const GeometricField<Type, fvPatchField, volMesh>&
  99     );
 100
 101     template<class Type>
 102     tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > flux
 103     (
 104         const surfaceScalarField&,
 105         const tmp<GeometricField<Type, fvPatchField, volMesh> >&
 106     );
 107
 108     template<class Type>
 109     tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > flux
 110     (
 111         const tmp<surfaceScalarField>&,
 112         const tmp<GeometricField<Type, fvPatchField, volMesh> >&
 113     );
 114 }
 115
 116
 117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 118
 119 } // End namespace Foam
 120
 121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 122
 123 #ifdef NoRepository
 124 #   include "fvcFlux.C"
 125 #endif
 126
 127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 128
 129 #endif
 130
 131 // ************************************************************************* //