src/postProcessing/foamCalcFunctions/field/components/components.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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 "components.H"
  28 #include "addToRunTimeSelectionTable.H"
  29
  30 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  31
  32 namespace Foam
  33 {
  34     namespace calcTypes
  35     {
  36         defineTypeNameAndDebug(components, 0);
  37         addToRunTimeSelectionTable(calcType, components, dictionary);
  38     }
  39 }
  40
  41
  42 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  43
  44 Foam::calcTypes::components::components()
  45 :
  46     calcType()
  47 {}
  48
  49
  50 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
  51
  52 Foam::calcTypes::components::~components()
  53 {}
  54
  55
  56 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  57
  58 void Foam::calcTypes::components::init()
  59 {
  60     Foam::argList::validArgs.append("components");
  61     argList::validArgs.append("fieldName1 .. fieldNameN");
  62 }
  63
  64
  65 void Foam::calcTypes::components::preCalc
  66 (
  67     const argList& args,
  68     const Time& runTime,
  69     const fvMesh& mesh
  70 )
  71 {
  72     if (args.additionalArgs().size() < 2)
  73     {
  74         Info<< nl << "must specify one or more fields" << nl;
  75         args.printUsage();
  76         FatalError.exit();
  77     }
  78 }
  79
  80
  81 void Foam::calcTypes::components::calc
  82 (
  83     const argList& args,
  84     const Time& runTime,
  85     const fvMesh& mesh
  86 )
  87 {
  88     const stringList& params = args.additionalArgs();
  89
  90     for (label fieldi=1; fieldi<params.size(); fieldi++)
  91     {
  92         const word fieldName(params[fieldi]);
  93
  94         IOobject fieldHeader
  95         (
  96             fieldName,
  97             runTime.timeName(),
  98             mesh,
  99             IOobject::MUST_READ
 100         );
 101
 102         // Check field exists
 103         if (fieldHeader.headerOk())
 104         {
 105             bool processed = false;
 106
 107             writeComponentFields<vector>(fieldHeader, mesh, processed);
 108             writeComponentFields<sphericalTensor>
 109             (
 110                 fieldHeader,
 111                 mesh,
 112                 processed
 113             );
 114             writeComponentFields<symmTensor>(fieldHeader, mesh, processed);
 115             writeComponentFields<tensor>(fieldHeader, mesh, processed);
 116
 117             if (!processed)
 118             {
 119                 FatalError
 120                     << "Unable to process " << fieldName << nl
 121                     << "No call to components for fields of type "
 122                     << fieldHeader.headerClassName() << nl << nl
 123                     << exit(FatalError);
 124             }
 125         }
 126         else
 127         {
 128             Info<< "    No " << fieldName << endl;
 129         }
 130     }
 131 }
 132
 133
 134 // ************************************************************************* //