src/postProcessing/foamCalcFunctions/basic/scalarMult/scalarMult.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 \*---------------------------------------------------------------------------*/
  25
  26 #include "scalarMult.H"
  27 #include "addToRunTimeSelectionTable.H"
  28
  29 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  30
  31 namespace Foam
  32 {
  33     namespace calcTypes
  34     {
  35         defineTypeNameAndDebug(scalarMult, 0);
  36         addToRunTimeSelectionTable(calcType, scalarMult, dictionary);
  37     }
  38 }
  39
  40
  41 // * * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * //
  42
  43 void Foam::calcTypes::scalarMult::writeScalarMultValues
  44 (
  45     const Time& runTime,
  46     const fvMesh& mesh,
  47     const IOobject& baseFieldHeader
  48 )
  49 {
  50     bool processed = false;
  51
  52     writeScalarMultValue<scalar>
  53     (
  54         baseFieldHeader,
  55         scalarMultValueStr_,
  56         mesh,
  57         processed
  58     );
  59     writeScalarMultValue<vector>
  60     (
  61         baseFieldHeader,
  62         scalarMultValueStr_,
  63         mesh,
  64         processed
  65     );
  66     writeScalarMultValue<sphericalTensor>
  67     (
  68         baseFieldHeader,
  69         scalarMultValueStr_,
  70         mesh,
  71         processed
  72     );
  73     writeScalarMultValue<symmTensor>
  74     (
  75         baseFieldHeader,
  76         scalarMultValueStr_,
  77         mesh,
  78         processed
  79     );
  80     writeScalarMultValue<tensor>
  81     (
  82         baseFieldHeader,
  83         scalarMultValueStr_,
  84         mesh,
  85         processed
  86     );
  87
  88     if (!processed)
  89     {
  90         FatalErrorIn("calcTypes::scalarMult::writeScalarMultValue()")
  91             << "Unable to process " << baseFieldName_
  92             << " + " << scalarMultValueStr_ << nl
  93             << "No call to scalarMult for fields of type "
  94             << baseFieldHeader.headerClassName() << nl << nl
  95             << exit(FatalError);
  96     }
  97 }
  98
  99
 100 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
 101
 102 Foam::calcTypes::scalarMult::scalarMult()
 103 :
 104     calcType(),
 105     baseFieldName_(""),
 106     scalarMultValueStr_(""),
 107     resultName_("")
 108 {}
 109
 110
 111 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
 112
 113 Foam::calcTypes::scalarMult::~scalarMult()
 114 {}
 115
 116
 117 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 118
 119 void Foam::calcTypes::scalarMult::init()
 120 {
 121     argList::validArgs.append("scalarMult");
 122     argList::validArgs.append("baseField");
 123     argList::validOptions.insert("value", "valueString");
 124     argList::validOptions.insert("resultName", "fieldName");
 125 }
 126
 127
 128 void Foam::calcTypes::scalarMult::preCalc
 129 (
 130     const argList& args,
 131     const Time& runTime,
 132     const fvMesh& mesh
 133 )
 134 {
 135     baseFieldName_ = args.additionalArgs()[1];
 136
 137     if (args.optionFound("value"))
 138     {
 139         scalarMultValueStr_ = args.option("value");
 140     }
 141     else
 142     {
 143         FatalErrorIn("calcTypes::scalarMult::preCalc")
 144             << "scalarMult requires -value option"
 145             << nl << exit(FatalError);
 146     }
 147
 148     if (args.optionFound("resultName"))
 149     {
 150         resultName_ = args.option("resultName");
 151     }
 152 }
 153
 154
 155 void Foam::calcTypes::scalarMult::calc
 156 (
 157     const argList& args,
 158     const Time& runTime,
 159     const fvMesh& mesh
 160 )
 161 {
 162     IOobject baseFieldHeader
 163     (
 164         baseFieldName_,
 165         runTime.timeName(),
 166         mesh,
 167         IOobject::MUST_READ
 168     );
 169
 170     if (baseFieldHeader.headerOk())
 171     {
 172         writeScalarMultValues(runTime, mesh, baseFieldHeader);
 173     }
 174     else
 175     {
 176         FatalErrorIn("calcTypes::scalarMult::calc")
 177             << "Unable to read base field: " << baseFieldName_
 178             << nl << exit(FatalError);
 179     }
 180 }
 181
 182
 183 // ************************************************************************* //