src/finiteVolume/finiteVolume/fvc/fvcDiv.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 \*---------------------------------------------------------------------------*/
  26
  27 #include "fvcDiv.H"
  28 #include "fvMesh.H"
  29 #include "fvcSurfaceIntegrate.H"
  30 #include "divScheme.H"
  31 #include "convectionScheme.H"
  32
  33 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  34
  35 namespace Foam
  36 {
  37
  38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  39
  40 namespace fvc
  41 {
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 template<class Type>
  46 tmp<GeometricField<Type, fvPatchField, volMesh> >
  47 div
  48 (
  49     const GeometricField<Type, fvsPatchField, surfaceMesh>& ssf
  50 )
  51 {
  52     return tmp<GeometricField<Type, fvPatchField, volMesh> >
  53     (
  54         new GeometricField<Type, fvPatchField, volMesh>
  55         (
  56             "div("+ssf.name()+')',
  57             fvc::surfaceIntegrate(ssf)
  58         )
  59     );
  60 }
  61
  62
  63 template<class Type>
  64 tmp<GeometricField<Type, fvPatchField, volMesh> >
  65 div
  66 (
  67     const tmp<GeometricField<Type, fvsPatchField, surfaceMesh> >& tssf
  68 )
  69 {
  70     tmp<GeometricField<Type, fvPatchField, volMesh> > Div(fvc::div(tssf()));
  71     tssf.clear();
  72     return Div;
  73 }
  74
  75
  76 template<class Type>
  77 tmp
  78 <
  79     GeometricField
  80     <
  81         typename innerProduct<vector, Type>::type, fvPatchField, volMesh
  82     >
  83 >
  84 div
  85 (
  86     const GeometricField<Type, fvPatchField, volMesh>& vf,
  87     const word& name
  88 )
  89 {
  90     return fv::divScheme<Type>::New
  91     (
  92         vf.mesh(), vf.mesh().divScheme(name)
  93     )().fvcDiv(vf);
  94 }
  95
  96
  97 template<class Type>
  98 tmp
  99 <
 100     GeometricField
 101     <
 102         typename innerProduct<vector, Type>::type, fvPatchField, volMesh
 103     >
 104 >
 105 div
 106 (
 107     const tmp<GeometricField<Type, fvPatchField, volMesh> >& tvvf,
 108     const word& name
 109 )
 110 {
 111     typedef typename innerProduct<vector, Type>::type DivType;
 112     tmp<GeometricField<DivType, fvPatchField, volMesh> > Div
 113     (
 114         fvc::div(tvvf(), name)
 115     );
 116     tvvf.clear();
 117     return Div;
 118 }
 119
 120 template<class Type>
 121 tmp
 122 <
 123     GeometricField
 124     <
 125         typename innerProduct<vector, Type>::type, fvPatchField, volMesh
 126     >
 127 >
 128 div
 129 (
 130     const GeometricField<Type, fvPatchField, volMesh>& vf
 131 )
 132 {
 133     return fvc::div(vf, "div("+vf.name()+')');
 134 }
 135
 136
 137 template<class Type>
 138 tmp
 139 <
 140     GeometricField
 141     <
 142         typename innerProduct<vector, Type>::type, fvPatchField, volMesh
 143     >
 144 >
 145 div
 146 (
 147     const tmp<GeometricField<Type, fvPatchField, volMesh> >& tvvf
 148 )
 149 {
 150     typedef typename innerProduct<vector, Type>::type DivType;
 151     tmp<GeometricField<DivType, fvPatchField, volMesh> > Div(fvc::div(tvvf()));
 152     tvvf.clear();
 153     return Div;
 154 }
 155
 156
 157 template<class Type>
 158 tmp<GeometricField<Type, fvPatchField, volMesh> >
 159 div
 160 (
 161     const surfaceScalarField& flux,
 162     const GeometricField<Type, fvPatchField, volMesh>& vf,
 163     const word& name
 164 )
 165 {
 166     return fv::convectionScheme<Type>::New
 167     (
 168         vf.mesh(),
 169         flux,
 170         vf.mesh().divScheme(name)
 171     )().fvcDiv(flux, vf);
 172 }
 173
 174
 175 template<class Type>
 176 tmp<GeometricField<Type, fvPatchField, volMesh> >
 177 div
 178 (
 179     const tmp<surfaceScalarField>& tflux,
 180     const GeometricField<Type, fvPatchField, volMesh>& vf,
 181     const word& name
 182 )
 183 {
 184     tmp<GeometricField<Type, fvPatchField, volMesh> > Div
 185     (
 186         fvc::div(tflux(), vf, name)
 187     );
 188     tflux.clear();
 189     return Div;
 190 }
 191
 192
 193 template<class Type>
 194 tmp<GeometricField<Type, fvPatchField, volMesh> >
 195 div
 196 (
 197     const surfaceScalarField& flux,
 198     const tmp<GeometricField<Type, fvPatchField, volMesh> >& tvf,
 199     const word& name
 200 )
 201 {
 202     tmp<GeometricField<Type, fvPatchField, volMesh> > Div
 203     (
 204         fvc::div(flux, tvf(), name)
 205     );
 206     tvf.clear();
 207     return Div;
 208 }
 209
 210
 211 template<class Type>
 212 tmp<GeometricField<Type, fvPatchField, volMesh> >
 213 div
 214 (
 215     const tmp<surfaceScalarField>& tflux,
 216     const tmp<GeometricField<Type, fvPatchField, volMesh> >& tvf,
 217     const word& name
 218 )
 219 {
 220     tmp<GeometricField<Type, fvPatchField, volMesh> > Div
 221     (
 222         fvc::div(tflux(), tvf(), name)
 223     );
 224     tflux.clear();
 225     tvf.clear();
 226     return Div;
 227 }
 228
 229
 230 template<class Type>
 231 tmp<GeometricField<Type, fvPatchField, volMesh> >
 232 div
 233 (
 234     const surfaceScalarField& flux,
 235     const GeometricField<Type, fvPatchField, volMesh>& vf
 236 )
 237 {
 238     return fvc::div
 239     (
 240         flux, vf, "div("+flux.name()+','+vf.name()+')'
 241     );
 242 }
 243
 244
 245 template<class Type>
 246 tmp<GeometricField<Type, fvPatchField, volMesh> >
 247 div
 248 (
 249     const tmp<surfaceScalarField>& tflux,
 250     const GeometricField<Type, fvPatchField, volMesh>& vf
 251 )
 252 {
 253     tmp<GeometricField<Type, fvPatchField, volMesh> > Div
 254     (
 255         fvc::div(tflux(), vf)
 256     );
 257     tflux.clear();
 258     return Div;
 259 }
 260
 261
 262 template<class Type>
 263 tmp<GeometricField<Type, fvPatchField, volMesh> >
 264 div
 265 (
 266     const surfaceScalarField& flux,
 267     const tmp<GeometricField<Type, fvPatchField, volMesh> >& tvf
 268 )
 269 {
 270     tmp<GeometricField<Type, fvPatchField, volMesh> > Div
 271     (
 272         fvc::div(flux, tvf())
 273     );
 274     tvf.clear();
 275     return Div;
 276 }
 277
 278
 279 template<class Type>
 280 tmp<GeometricField<Type, fvPatchField, volMesh> >
 281 div
 282 (
 283     const tmp<surfaceScalarField>& tflux,
 284     const tmp<GeometricField<Type, fvPatchField, volMesh> >& tvf
 285 )
 286 {
 287     tmp<GeometricField<Type, fvPatchField, volMesh> > Div
 288     (
 289         fvc::div(tflux(), tvf())
 290     );
 291     tflux.clear();
 292     tvf.clear();
 293     return Div;
 294 }
 295
 296
 297 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 298
 299 } // End namespace fvc
 300
 301 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 302
 303 } // End namespace Foam
 304
 305 // ************************************************************************* //