src/finiteVolume/finiteVolume/fvc/fvcAverage.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 "fvcAverage.H"
  28 #include "fvcSurfaceIntegrate.H"
  29 #include "fvMesh.H"
  30 #include "linear.H"
  31
  32 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  33
  34 namespace Foam
  35 {
  36
  37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  38
  39 namespace fvc
  40 {
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 template<class Type>
  45 tmp<GeometricField<Type, fvPatchField, volMesh> >
  46 average
  47 (
  48     const GeometricField<Type, fvsPatchField, surfaceMesh>& ssf
  49 )
  50 {
  51     const fvMesh& mesh = ssf.mesh();
  52
  53     tmp<GeometricField<Type, fvPatchField, volMesh> > taverage
  54     (
  55         new GeometricField<Type, fvPatchField, volMesh>
  56         (
  57             IOobject
  58             (
  59                 "average("+ssf.name()+')',
  60                 ssf.instance(),
  61                 mesh,
  62                 IOobject::NO_READ,
  63                 IOobject::NO_WRITE
  64             ),
  65             mesh,
  66             ssf.dimensions()
  67         )
  68     );
  69
  70     GeometricField<Type, fvPatchField, volMesh>& av = taverage();
  71
  72     av.internalField() =
  73     (
  74         surfaceSum(mesh.magSf()*ssf)/surfaceSum(mesh.magSf())
  75     )().internalField();
  76
  77     forAll(av.boundaryField(), patchi)
  78     {
  79         av.boundaryField()[patchi] = ssf.boundaryField()[patchi];
  80     }
  81
  82     av.correctBoundaryConditions();
  83
  84     return taverage;
  85 }
  86
  87
  88 template<class Type>
  89 tmp<GeometricField<Type, fvPatchField, volMesh> >
  90 average
  91 (
  92     const tmp<GeometricField<Type, fvsPatchField, surfaceMesh> >& tssf
  93 )
  94 {
  95     tmp<GeometricField<Type, fvPatchField, volMesh> > taverage
  96     (
  97         fvc::average(tssf())
  98     );
  99     tssf.clear();
 100     return taverage;
 101 }
 102
 103
 104 template<class Type>
 105 tmp<GeometricField<Type, fvPatchField, volMesh> >
 106 average
 107 (
 108     const GeometricField<Type, fvPatchField, volMesh>& vtf
 109 )
 110 {
 111     return fvc::average(linearInterpolate(vtf));
 112 }
 113
 114
 115 template<class Type>
 116 tmp<GeometricField<Type, fvPatchField, volMesh> >
 117 average
 118 (
 119     const tmp<GeometricField<Type, fvPatchField, volMesh> >& tvtf
 120 )
 121 {
 122     tmp<GeometricField<Type, fvPatchField, volMesh> > taverage
 123     (
 124         fvc::average(tvtf())
 125     );
 126     tvtf.clear();
 127     return taverage;
 128 }
 129
 130
 131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 132
 133 } // End namespace fvc
 134
 135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 136
 137 } // End namespace Foam
 138
 139 // ************************************************************************* //