src/finiteVolume/finiteVolume/fvc/fvcFlux.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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 Description
  26
  27
  28 \*---------------------------------------------------------------------------*/
  29
  30 #include "fvcFlux.H"
  31 #include "fvMesh.H"
  32 #include "convectionScheme.H"
  33
  34 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  35
  36 namespace Foam
  37 {
  38
  39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  40
  41 namespace fvc
  42 {
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 template<class Type>
  47 tmp<GeometricField<Type, fvsPatchField, surfaceMesh> >
  48 flux
  49 (
  50     const surfaceScalarField& phi,
  51     const GeometricField<Type, fvPatchField, volMesh>& vf,
  52     const word& name
  53 )
  54 {
  55     return fv::convectionScheme<Type>::New
  56     (
  57         vf.mesh(),
  58         phi,
  59         vf.mesh().divScheme(name)
  60     )().flux(phi, vf);
  61 }
  62
  63
  64 template<class Type>
  65 tmp<GeometricField<Type, fvsPatchField, surfaceMesh> >
  66 flux
  67 (
  68     const tmp<surfaceScalarField>& tphi,
  69     const GeometricField<Type, fvPatchField, volMesh>& vf,
  70     const word& name
  71 )
  72 {
  73     tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > Flux
  74     (
  75         fvc::flux(tphi(), vf, name)
  76     );
  77     tphi.clear();
  78     return Flux;
  79 }
  80
  81
  82 template<class Type>
  83 tmp<GeometricField<Type, fvsPatchField, surfaceMesh> >
  84 flux
  85 (
  86     const surfaceScalarField& phi,
  87     const tmp<GeometricField<Type, fvPatchField, volMesh> >& tvf,
  88     const word& name
  89 )
  90 {
  91     tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > Flux
  92     (
  93         fvc::flux(phi, tvf(), name)
  94     );
  95     tvf.clear();
  96     return Flux;
  97 }
  98
  99
 100 template<class Type>
 101 tmp<GeometricField<Type, fvsPatchField, surfaceMesh> >
 102 flux
 103 (
 104     const tmp<surfaceScalarField>& tphi,
 105     const tmp<GeometricField<Type, fvPatchField, volMesh> >& tvf,
 106     const word& name
 107 )
 108 {
 109     tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > Flux
 110     (
 111         fvc::flux(tphi(), tvf(), name)
 112     );
 113     tphi.clear();
 114     tvf.clear();
 115     return Flux;
 116 }
 117
 118
 119 template<class Type>
 120 tmp<GeometricField<Type, fvsPatchField, surfaceMesh> >
 121 flux
 122 (
 123     const surfaceScalarField& phi,
 124     const GeometricField<Type, fvPatchField, volMesh>& vf
 125 )
 126 {
 127     return fvc::flux
 128     (
 129         phi, vf, "flux("+phi.name()+','+vf.name()+')'
 130     );
 131 }
 132
 133
 134 template<class Type>
 135 tmp<GeometricField<Type, fvsPatchField, surfaceMesh> >
 136 flux
 137 (
 138     const tmp<surfaceScalarField>& tphi,
 139     const GeometricField<Type, fvPatchField, volMesh>& vf
 140 )
 141 {
 142     tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > Flux
 143     (
 144         fvc::flux(tphi(), vf)
 145     );
 146     tphi.clear();
 147     return Flux;
 148 }
 149
 150
 151 template<class Type>
 152 tmp<GeometricField<Type, fvsPatchField, surfaceMesh> >
 153 flux
 154 (
 155     const surfaceScalarField& phi,
 156     const tmp<GeometricField<Type, fvPatchField, volMesh> >& tvf
 157 )
 158 {
 159     tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > Flux
 160     (
 161         fvc::flux(phi, tvf())
 162     );
 163     tvf.clear();
 164     return Flux;
 165 }
 166
 167
 168 template<class Type>
 169 tmp<GeometricField<Type, fvsPatchField, surfaceMesh> >
 170 flux
 171 (
 172     const tmp<surfaceScalarField>& tphi,
 173     const tmp<GeometricField<Type, fvPatchField, volMesh> >& tvf
 174 )
 175 {
 176     tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > Flux
 177     (
 178         fvc::flux(tphi(), tvf())
 179     );
 180     tphi.clear();
 181     tvf.clear();
 182     return Flux;
 183 }
 184
 185
 186 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 187
 188 } // End namespace fvc
 189
 190 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 191
 192 } // End namespace Foam
 193
 194 // ************************************************************************* //