/*---------------------------------------------------------------------------*\
  ==  == ====== ====   ====    |
                    \\     ||  | 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::functionObjects::wallBoilingProperty

Description
    This function looks up the wall boiling model and collects and writes out a
    field of one of the wall boiling properties.

    Example of function object specification:
    \verbatim
    wallBoilingProperty1
    {
        type            wallBoilingProperty;
        libs            ("libaddonMultiphaseEulerFunctionObjects.so");
        writeControl    writeTime;
        field           qEvaporative;
    }
    \endverbatim

Usage
    \table
        Property | Description                | Required   | Default value
        type     | type name: wallBoilingProperty | yes    |
        model    | name of the wall boiling fvModel | no   | none
        field    | name of the property       | yes        |
    \endtable

SourceFiles
    wallBoilingProperty.C

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

#ifndef wallBoilingProperty_H
#define wallBoilingProperty_H

#include "fieldExpression.H"
#include "wallBoiling.H"

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

namespace Foam
{
namespace functionObjects
{

/*---------------------------------------------------------------------------*\
                         Class wallBoilingProperty Declaration
\*---------------------------------------------------------------------------*/

class wallBoilingProperty
:
    public fvMeshFunctionObject
{
private:

    //- Private Data

        //- The name of the wall boiling model
        word modelName_;

        //- The name of the property
        word fieldName_;


    // Private Member Functions

        //- Access the wall boiling model
        const fv::wallBoiling& model() const;


public:

    //- Runtime type information
    TypeName("wallBoilingProperty");


    // Constructors

        //- Construct from Time and dictionary
        wallBoilingProperty
        (
            const word& name,
            const Time& runTime,
            const dictionary& dict
        );

        //- Disallow default bitwise copy construction
        wallBoilingProperty(const wallBoilingProperty&) = delete;


    //- Destructor
    virtual ~wallBoilingProperty();


    // Member Functions

        //- Read the wallBoilingProperty data
        virtual bool read(const dictionary&);

        //- Return the list of fields required
        virtual wordList fields() const
        {
            return wordList::null();
        }

        //- Calculate the wallBoilingProperty field
        virtual bool execute();

        //- Write the wallBoilingProperty field
        virtual bool write();


    // Member Operators

        //- Disallow default bitwise assignment
        void operator=(const wallBoilingProperty&) = delete;
};


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

} // End namespace functionObjects
} // End namespace Foam

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

#endif

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