/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2013-2026 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::UniformField

Description
    A class representing the concept of a uniform field which stores only
    the single value and providing the operator[] to return it.

\*---------------------------------------------------------------------------*/

#ifndef UniformField_H
#define UniformField_H

#include "label.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{

// Forward declaration of friend functions and operators

template<class Type>
class UniformField;

template<class Type>
Ostream& operator<<(Ostream& os, const UniformField<Type>& u);


/*---------------------------------------------------------------------------*\
                        Class UniformField Declaration
\*---------------------------------------------------------------------------*/

template<class Type>
class UniformField
{
    // Private Data

        Type value_;


public:

    // Public typedefs

        //- Component type
        typedef typename pTraits<Type>::cmptType cmptType;


    // Constructors

        //- Construct given value
        inline UniformField(const Type& value);


    // Member Operators

        inline operator Type() const;

        inline Type operator[](const label) const;

        inline UniformField primitiveField() const;


    // IOstream Operators

        friend Ostream& operator<< <Type>(Ostream&, const UniformField<Type>&);
};


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#include "UniformFieldI.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //