AverageField.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2011-2024 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.
 
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.
 
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
Class
    Foam::AverageField
 
Description
    A primitive field with a separate average value.
 
SourceFiles
    AverageField.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef AverageField_H
#define AverageField_H
 
#include "Field.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                        Class AverageField Declaration
\*---------------------------------------------------------------------------*/
 
template<class Type>
class AverageField
:
    public Field<Type>
{
    // Private Data
 
        //- The average of the field
        Type average_;
 
 
public:
 
    // Constructors
 
        //- Construct from size (does not set values)
        AverageField(const label size);
 
        //- Construct from components
        AverageField(const Field<Type>&, const Type& average);
 
        //- Construct from Istream
        AverageField(Istream&);
 
 
    // Member Functions
 
        const Type& average() const;
 
        Type& average();
 
        bool writeData(Ostream& os) const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#ifdef NoRepository
    #include "AverageField.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //