src/postProcessing/foamCalcFunctions/field/magSqr/magSqr.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 "magSqr.H"
  28 #include "addToRunTimeSelectionTable.H"
  29
  30 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  31
  32 namespace Foam
  33 {
  34     namespace calcTypes
  35     {
  36         defineTypeNameAndDebug(magSqr, 0);
  37         addToRunTimeSelectionTable(calcType, magSqr, dictionary);
  38     }
  39 }
  40
  41
  42 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  43
  44 Foam::calcTypes::magSqr::magSqr()
  45 :
  46     calcType()
  47 {}
  48
  49
  50 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
  51
  52 Foam::calcTypes::magSqr::~magSqr()
  53 {}
  54
  55
  56 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  57
  58 void Foam::calcTypes::magSqr::init()
  59 {
  60     Foam::argList::validArgs.append("magSqr");
  61     argList::validArgs.append("fieldName");
  62 }
  63
  64
  65 void Foam::calcTypes::magSqr::preCalc
  66 (
  67     const argList& args,
  68     const Time& runTime,
  69     const fvMesh& mesh
  70 )
  71 {}
  72
  73
  74 void Foam::calcTypes::magSqr::calc
  75 (
  76     const argList& args,
  77     const Time& runTime,
  78     const fvMesh& mesh
  79 )
  80 {
  81     const word& fieldName = args.additionalArgs()[1];
  82
  83     IOobject fieldHeader
  84     (
  85         fieldName,
  86         runTime.timeName(),
  87         mesh,
  88         IOobject::MUST_READ
  89     );
  90
  91     // Check field exists
  92     if (fieldHeader.headerOk())
  93     {
  94         bool processed = false;
  95
  96         writeMagSqrField<scalar>(fieldHeader, mesh, processed);
  97         writeMagSqrField<vector>(fieldHeader, mesh, processed);
  98         writeMagSqrField<sphericalTensor>(fieldHeader, mesh, processed);
  99         writeMagSqrField<symmTensor>(fieldHeader, mesh, processed);
 100         writeMagSqrField<tensor>(fieldHeader, mesh, processed);
 101
 102         if (!processed)
 103         {
 104             FatalError
 105                 << "Unable to process " << fieldName << nl
 106                 << "No call to magSqr for fields of type "
 107                 << fieldHeader.headerClassName() << nl << nl
 108                << exit(FatalError);
 109         }
 110     }
 111     else
 112     {
 113         Info<< "    No " << fieldName << endl;
 114     }
 115 }
 116
 117
 118
 119 // ************************************************************************* //
 120