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