/*---------------------------------------------------------------------------*\
  ==  == ====== ====   ====    |
                    \\     ||  | Multiphase Code Repository by HZDR
  ======   //   ||  || ===//   | Website: https://doi.org/10.14278/rodare.767
  ||  ||  //    ||  // || \\   | License: GPL-3.0-or-later
  ==  == ====== ====   ==  ==  |
-------------------------------------------------------------------------------
License
    This file is part of the Multiphase Code Repository by HZDR.

    Copyright (C) 2025 by Helmholtz-Zentrum Dresden-Rossendorf e.V. (HZDR),
    Website: https://hzdr.de

    Multiphase Code Repository by HZDR is based on the free software for
    computational fluid dynamics (CFD) from the OpenFOAM Foundation.
    Copyright (C) 2025 by OpenFOAM Foundation, Website: https://openfoam.org

    If you are interested in which files are original OpenFOAM Foundation
    files, which OpenFOAM Foundation files were modified, and which files were
    newly created, see FILES.md.

    Multiphase Code Repository by HZDR 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.

    Multiphase Code Repository by HZDR 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 the Multiphase Code Repository by HZDR. If not, see
    <http://www.gnu.org/licenses/>.

Class
    Foam::groupPropertyFvScalarField

Description
    Base class for source conditions of properties of the groups in a
    population balance model.

SourceFiles
    groupPropertyFvScalarField.C

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

#ifndef groupPropertyFvScalarField_H
#define groupPropertyFvScalarField_H

#include "DimensionedField.H"
#include "volMesh.H"

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

namespace Foam
{

// Forward declaration of classes
class populationBalanceModel;

/*---------------------------------------------------------------------------*\
                Class groupPropertyFvScalarField Declaration
\*---------------------------------------------------------------------------*/

class groupPropertyFvScalarField
{
private:

    // Private Data

        //- Reference to the internal field
        const DimensionedField<scalar, volMesh>& internalField_;

        //- Pointer to the population balance
        mutable const populationBalanceModel* popBalPtr_;

        //- The index of this group
        mutable label i_;


public:

    // Constructors

        //- Construct from internal field
        groupPropertyFvScalarField
        (
            const DimensionedField<scalar, volMesh>&
        );


public:

    // Member Functions

        //- Return the population balance
        const populationBalanceModel& popBal() const;

        //- Return the index of this group
        label i() const;
};


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

} // End namespace Foam

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

#endif

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