src/OpenFOAM/fields/DimensionedFields/DimensionedField/DimensionedFieldIO.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 "DimensionedField.H"
  27 #include "IOstreams.H"
  28
  29
  30 // * * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * //
  31
  32 template<class Type, class GeoMesh>
  33 void Foam::DimensionedField<Type, GeoMesh>::readField
  34 (
  35     const dictionary& fieldDict,
  36     const word& fieldDictEntry
  37 )
  38 {
  39     dimensions_.reset(dimensionSet(fieldDict.lookup("dimensions")));
  40
  41     Field<Type> f(fieldDictEntry, fieldDict, GeoMesh::size(mesh_));
  42     this->transfer(f);
  43 }
  44
  45
  46 template<class Type, class GeoMesh>
  47 void Foam::DimensionedField<Type, GeoMesh>::readIfPresent
  48 (
  49     const word& fieldDictEntry
  50 )
  51 {
  52     if
  53     (
  54         (this->readOpt() == IOobject::READ_IF_PRESENT && this->headerOk())
  55      || this->readOpt() == IOobject::MUST_READ
  56      || this->readOpt() == IOobject::MUST_READ_IF_MODIFIED
  57     )
  58     {
  59         readField(dictionary(readStream(typeName)), fieldDictEntry);
  60     }
  61 }
  62
  63
  64 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  65
  66 template<class Type, class GeoMesh>
  67 Foam::DimensionedField<Type, GeoMesh>::DimensionedField
  68 (
  69     const IOobject& io,
  70     const Mesh& mesh,
  71     const word& fieldDictEntry
  72 )
  73 :
  74     regIOobject(io),
  75     Field<Type>(0),
  76     mesh_(mesh),
  77     dimensions_(dimless)
  78 {
  79     readField(dictionary(readStream(typeName)), fieldDictEntry);
  80 }
  81
  82
  83 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  84
  85 template<class Type, class GeoMesh>
  86 bool Foam::DimensionedField<Type, GeoMesh>::writeData
  87 (
  88     Ostream& os,
  89     const word& fieldDictEntry
  90 ) const
  91 {
  92     os.writeKeyword("dimensions") << dimensions() << token::END_STATEMENT
  93         << nl << nl;
  94
  95     Field<Type>::writeEntry(fieldDictEntry, os);
  96
  97     // Check state of Ostream
  98     os.check
  99     (
 100         "bool DimensionedField<Type, GeoMesh>::writeData"
 101         "(Ostream& os, const word& fieldDictEntry) const"
 102     );
 103
 104     return (os.good());
 105 }
 106
 107
 108 template<class Type, class GeoMesh>
 109 bool Foam::DimensionedField<Type, GeoMesh>::writeData(Ostream& os) const
 110 {
 111     return writeData(os, "value");
 112 }
 113
 114
 115 // * * * * * * * * * * * * * * * IOstream Operators  * * * * * * * * * * * * //
 116
 117 template<class Type, class GeoMesh>
 118 Foam::Ostream& Foam::operator<<
 119 (
 120     Ostream& os,
 121     const DimensionedField<Type, GeoMesh>& df
 122 )
 123 {
 124     df.writeData(os);
 125
 126     return os;
 127 }
 128
 129
 130 template<class Type, class GeoMesh>
 131 Foam::Ostream& Foam::operator<<
 132 (
 133     Ostream& os,
 134     const tmp<DimensionedField<Type, GeoMesh> >& tdf
 135 )
 136 {
 137     tdf().writeData(os);
 138     tdf.clear();
 139
 140     return os;
 141 }
 142
 143
 144 // ************************************************************************* //