OpenFOAM logo
Open Source CFD Toolkit

fvcGrad.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 gradient of the given field.
00030 
00031 SourceFiles
00032     fvcGrad.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 
00037 #ifndef fvcGrad_H
00038 #define fvcGrad_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
00056     <
00057         GeometricField
00058         <typename outerProduct<vector, Type>::type, fvPatchField, volMesh>
00059     > grad
00060     (
00061         const GeometricField<Type, fvPatchField, surfaceMesh>&
00062     );
00063 
00064     template<class Type>
00065     tmp
00066     <
00067         GeometricField
00068         <typename outerProduct<vector, Type>::type, fvPatchField, volMesh>
00069     > grad
00070     (
00071         const tmp<GeometricField<Type, fvPatchField, surfaceMesh> >&
00072     );
00073 
00074     template<class Type>
00075     tmp
00076     <
00077         GeometricField
00078         <typename outerProduct<vector, Type>::type, fvPatchField, volMesh>
00079     > grad
00080     (
00081         const GeometricField<Type, fvPatchField, volMesh>&,
00082         const word& name
00083     );
00084 
00085     template<class Type>
00086     tmp
00087     <
00088         GeometricField
00089         <typename outerProduct<vector, Type>::type, fvPatchField, volMesh>
00090     > grad
00091     (
00092         const tmp<GeometricField<Type, fvPatchField, volMesh> >&,
00093         const word& name
00094     );
00095 
00096     template<class Type>
00097     tmp
00098     <
00099         GeometricField
00100         <typename outerProduct<vector, Type>::type, fvPatchField, volMesh>
00101     > grad
00102     (
00103         const GeometricField<Type, fvPatchField, volMesh>&
00104     );
00105 
00106     template<class Type>
00107     tmp
00108     <
00109         GeometricField
00110         <typename outerProduct<vector, Type>::type, fvPatchField, volMesh>
00111     > grad
00112     (
00113         const tmp<GeometricField<Type, fvPatchField, volMesh> >&
00114     );
00115 }
00116 
00117 
00118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00119 
00120 } // End namespace Foam
00121 
00122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00123 
00124 #ifdef NoRepository
00125 #   include "fvcGrad.C"
00126 #endif
00127 
00128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00129 
00130 #endif
00131 
00132 // ************************************************************************* //
For further information go to www.openfoam.org