src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.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 "fieldValue.H"
  27 #include "fvMesh.H"
  28 #include "Time.H"
  29
  30 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  31
  32 namespace Foam
  33 {
  34     defineTypeNameAndDebug(fieldValue, 0);
  35 }
  36
  37
  38 // * * * * * * * * * * * * Protected Member Functions  * * * * * * * * * * * //
  39
  40 void Foam::fieldValue::updateMesh(const mapPolyMesh&)
  41 {
  42     // Do nothing
  43 }
  44
  45
  46 void Foam::fieldValue::movePoints(const Field<point>&)
  47 {
  48     // Do nothing
  49 }
  50
  51
  52 void Foam::fieldValue::makeFile()
  53 {
  54     // Create the output file if not already created
  55     if (outputFilePtr_.empty())
  56     {
  57         if (debug)
  58         {
  59             Info<< "Creating output file." << endl;
  60         }
  61
  62         // File update
  63         if (Pstream::master())
  64         {
  65             fileName outputDir;
  66             word startTimeName =
  67                 obr_.time().timeName(obr_.time().startTime().value());
  68
  69             if (Pstream::parRun())
  70             {
  71                 // Put in undecomposed case (Note: gives problems for
  72                 // distributed data running)
  73                 outputDir =
  74                     obr_.time().path()/".."/name_/startTimeName;
  75             }
  76             else
  77             {
  78                 outputDir = obr_.time().path()/name_/startTimeName;
  79             }
  80
  81             // Create directory if does not exist
  82             mkDir(outputDir);
  83
  84             // Open new file at start up
  85             outputFilePtr_.reset(new OFstream(outputDir/(type() + ".dat")));
  86
  87             // Add headers to output data
  88             writeFileHeader();
  89         }
  90     }
  91 }
  92
  93
  94 void Foam::fieldValue::read(const dictionary& dict)
  95 {
  96     if (active_)
  97     {
  98         log_ = dict.lookupOrDefault<Switch>("log", false);
  99         dict.lookup("fields") >> fields_;
 100         dict.lookup("valueOutput") >> valueOutput_;
 101     }
 102 }
 103
 104
 105 void Foam::fieldValue::write()
 106 {
 107     if (active_)
 108     {
 109         if (log_)
 110         {
 111             Info<< type() << " " << name_ << " output:" << nl;
 112         }
 113
 114         makeFile();
 115     }
 116 }
 117
 118
 119 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
 120
 121 Foam::fieldValue::fieldValue
 122 (
 123     const word& name,
 124     const objectRegistry& obr,
 125     const dictionary& dict,
 126     const bool loadFromFiles
 127 )
 128 :
 129     name_(name),
 130     obr_(obr),
 131     active_(true),
 132     log_(false),
 133     sourceName_(dict.lookupOrDefault<word>("sourceName", "sampledSurface")),
 134     fields_(dict.lookup("fields")),
 135     valueOutput_(dict.lookup("valueOutput")),
 136     outputFilePtr_(NULL)
 137 {
 138     // Only active if obr is an fvMesh
 139     if (isA<fvMesh>(obr_))
 140     {
 141         read(dict);
 142     }
 143     else
 144     {
 145         WarningIn
 146         (
 147             "fieldValue::fieldValue"
 148             "("
 149                 "const word&, "
 150                 "const objectRegistry&, "
 151                 "const dictionary&, "
 152                 "const bool"
 153             ")"
 154         )   << "No fvMesh available, deactivating."
 155             << nl << endl;
 156         active_ = false;
 157     }
 158 }
 159
 160
 161 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
 162
 163 Foam::fieldValue::~fieldValue()
 164 {}
 165
 166
 167 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 168
 169 void Foam::fieldValue::execute()
 170 {
 171     // Do nothing
 172 }
 173
 174
 175 void Foam::fieldValue::end()
 176 {
 177     // Do nothing
 178 }
 179
 180
 181 // ************************************************************************* //