src/postProcessing/functionObjects/field/fieldValues/cellSource/cellSourceTemplates.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2009-2011 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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 \*---------------------------------------------------------------------------*/
  25
  26 #include "cellSource.H"
  27 #include "volFields.H"
  28
  29 // * * * * * * * * * * * * Protected Member Functions  * * * * * * * * * * * //
  30
  31 template<class Type>
  32 bool Foam::fieldValues::cellSource::validField(const word& fieldName) const
  33 {
  34     typedef GeometricField<Type, fvPatchField, volMesh> vf;
  35
  36     if (obr_.foundObject<vf>(fieldName))
  37     {
  38         return true;
  39     }
  40
  41     return false;
  42 }
  43
  44
  45 template<class Type>
  46 Foam::tmp<Foam::Field<Type> > Foam::fieldValues::cellSource::setFieldValues
  47 (
  48     const word& fieldName
  49 ) const
  50 {
  51     typedef GeometricField<Type, fvPatchField, volMesh> vf;
  52
  53     if (obr_.foundObject<vf>(fieldName))
  54     {
  55         return filterField(obr_.lookupObject<vf>(fieldName));
  56     }
  57
  58     return tmp<Field<Type> >(new Field<Type>(0.0));
  59 }
  60
  61
  62 template<class Type>
  63 Type Foam::fieldValues::cellSource::processValues
  64 (
  65     const Field<Type>& values,
  66     const scalarField& V,
  67     const scalarField& weightField
  68 ) const
  69 {
  70     Type result = pTraits<Type>::zero;
  71     switch (operation_)
  72     {
  73         case opSum:
  74         {
  75             result = sum(values);
  76             break;
  77         }
  78         case opVolAverage:
  79         {
  80             result = sum(values*V)/sum(V);
  81             break;
  82         }
  83         case opVolIntegrate:
  84         {
  85             result = sum(values*V);
  86             break;
  87         }
  88         case opWeightedAverage:
  89         {
  90             result = sum(values*weightField)/sum(weightField);
  91             break;
  92         }
  93         case opMin:
  94         {
  95             result = min(values);
  96             break;
  97         }
  98         case opMax:
  99         {
 100             result = max(values);
 101             break;
 102         }
 103         default:
 104         {
 105             // Do nothing
 106         }
 107     }
 108
 109     return result;
 110 }
 111
 112
 113 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 114
 115 template<class Type>
 116 bool Foam::fieldValues::cellSource::writeValues(const word& fieldName)
 117 {
 118     const bool ok = validField<Type>(fieldName);
 119
 120     if (ok)
 121     {
 122         Field<Type> values(setFieldValues<Type>(fieldName));
 123         combineFields(values);
 124
 125         scalarField V(filterField(mesh().V()));
 126         combineFields(V);
 127
 128         scalarField weightField(setFieldValues<scalar>(weightFieldName_));
 129         combineFields(weightField);
 130
 131         if (Pstream::master())
 132         {
 133             Type result = processValues(values, V, weightField);
 134
 135             if (valueOutput_)
 136             {
 137                 IOField<Type>
 138                 (
 139                     IOobject
 140                     (
 141                         fieldName + "_" + sourceTypeNames_[source_] + "-"
 142                             + sourceName_,
 143                         obr_.time().timeName(),
 144                         obr_,
 145                         IOobject::NO_READ,
 146                         IOobject::NO_WRITE
 147                     ),
 148                     values
 149                 ).write();
 150             }
 151
 152
 153             outputFilePtr_()<< tab << result;
 154
 155             if (log_)
 156             {
 157                 Info<< "    " << operationTypeNames_[operation_]
 158                     << "(" << sourceName_ << ") for " << fieldName
 159                     <<  " = " << result << endl;
 160             }
 161         }
 162     }
 163
 164     return ok;
 165 }
 166
 167
 168 template<class Type>
 169 Foam::tmp<Foam::Field<Type> > Foam::fieldValues::cellSource::filterField
 170 (
 171     const Field<Type>& field
 172 ) const
 173 {
 174     return tmp<Field<Type> >(new Field<Type>(field, cellId_));
 175 }
 176
 177
 178 // ************************************************************************* //
 179