OpenFOAM logo
Open Source CFD Toolkit

fvcFlux.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Namespace
00026     fvc
00027 
00028 Description
00029     Calculate the face-flux of the given field.
00030 
00031 SourceFiles
00032     fvcFlux.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 
00037 #ifndef fvcFlux_H
00038 #define fvcFlux_H
00039 
00040 #include "volFieldsFwd.H"
00041 #include "surfaceFieldsFwd.H"
00042 
00043 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00044 
00045 namespace Foam
00046 {
00047 
00048 /*---------------------------------------------------------------------------*\
00049                      Namespace fvc functions Declaration
00050 \*---------------------------------------------------------------------------*/
00051 
00052 namespace fvc
00053 {
00054     template<class Type>
00055     tmp<GeometricField<Type, fvPatchField, surfaceMesh> > flux
00056     (
00057         const surfaceScalarField&,
00058         const GeometricField<Type, fvPatchField, volMesh>&,
00059         const word& name
00060     );
00061 
00062     template<class Type>
00063     tmp<GeometricField<Type, fvPatchField, surfaceMesh> > flux
00064     (
00065         const tmp<surfaceScalarField>&,
00066         const GeometricField<Type, fvPatchField, volMesh>&,
00067         const word& name
00068     );
00069 
00070     template<class Type>
00071     tmp<GeometricField<Type, fvPatchField, surfaceMesh> > flux
00072     (
00073         const surfaceScalarField&,
00074         const tmp<GeometricField<Type, fvPatchField, volMesh> >&,
00075         const word& name
00076     );
00077 
00078     template<class Type>
00079     tmp<GeometricField<Type, fvPatchField, surfaceMesh> > flux
00080     (
00081         const tmp<surfaceScalarField>&,
00082         const tmp<GeometricField<Type, fvPatchField, volMesh> >&,
00083         const word& name
00084     );
00085 
00086 
00087     template<class Type>
00088     tmp<GeometricField<Type, fvPatchField, surfaceMesh> > flux
00089     (
00090         const surfaceScalarField&,
00091         const GeometricField<Type, fvPatchField, volMesh>&
00092     );
00093 
00094     template<class Type>
00095     tmp<GeometricField<Type, fvPatchField, surfaceMesh> > flux
00096     (
00097         const tmp<surfaceScalarField>&,
00098         const GeometricField<Type, fvPatchField, volMesh>&
00099     );
00100 
00101     template<class Type>
00102     tmp<GeometricField<Type, fvPatchField, surfaceMesh> > flux
00103     (
00104         const surfaceScalarField&,
00105         const tmp<GeometricField<Type, fvPatchField, volMesh> >&
00106     );
00107 
00108     template<class Type>
00109     tmp<GeometricField<Type, fvPatchField, surfaceMesh> > flux
00110     (
00111         const tmp<surfaceScalarField>&,
00112         const tmp<GeometricField<Type, fvPatchField, volMesh> >&
00113     );
00114 }
00115 
00116 
00117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00118 
00119 } // End namespace Foam
00120 
00121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00122 
00123 #ifdef NoRepository
00124 #   include "fvcFlux.C"
00125 #endif
00126 
00127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00128 
00129 #endif
00130 
00131 // ************************************************************************* //
For further information go to www.openfoam.org