src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/AverageIOField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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 Class
  26     Foam::AverageIOField
  27
  28 Description
  29     A primitive field + average with IO.
  30
  31 SourceFiles
  32     AverageIOField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef AverageIOField_H
  37 #define AverageIOField_H
  38
  39 #include "regIOobject.H"
  40 #include "Field.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class AverageIOField Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 template<class Type>
  52 class AverageIOField
  53 :
  54     public regIOobject,
  55     public pTraits<Type>,
  56     public Field<Type>
  57 {
  58
  59 public:
  60
  61     TypeName("AverageField");
  62
  63
  64     // Constructors
  65
  66         //- Construct from IOobject
  67         AverageIOField
  68         (
  69             const IOobject&
  70         );
  71
  72         //- Construct from IOobject and size (does not set values)
  73         AverageIOField
  74         (
  75             const IOobject&,
  76             const label size
  77         );
  78
  79         //- Construct from components
  80         AverageIOField
  81         (
  82             const IOobject&,
  83             const Type& average,
  84             const Field<Type>&
  85         );
  86
  87
  88     // Member functions
  89
  90         const pTraits<Type>& average() const
  91         {
  92             return static_cast<const pTraits<Type>&>(*this);
  93         }
  94
  95         bool writeData(Ostream& os) const
  96         {
  97             os  << static_cast<const Type&>(*this)
  98                 << token::NL
  99                 << static_cast<const Field<Type>&>(*this);
 100
 101             return os.good();
 102         }
 103 };
 104
 105
 106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 107
 108 } // End namespace Foam
 109
 110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 111
 112 #ifdef NoRepository
 113 #   include "AverageIOField.C"
 114 #endif
 115
 116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 117
 118 #endif
 119
 120 // ************************************************************************* //