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

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

#include "moleFractions.H"
#include "fluidMulticomponentThermo.H"
#include "addToRunTimeSelectionTable.H"

// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //

namespace Foam
{
namespace functionObjects
{
    defineTypeNameAndDebug(moleFractions, 0);
    addToRunTimeSelectionTable(functionObject, moleFractions, dictionary);
}
}


// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //

Foam::functionObjects::moleFractions::moleFractions
(
    const word& name,
    const Time& runTime,
    const dictionary& dict
)
:
    fvMeshFunctionObject(name, runTime, dict),
    phaseName_(dict.lookupOrDefault<word>("phase", word::null)),
    X_()
{}


// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //

Foam::functionObjects::moleFractions::~moleFractions()
{}


// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //

bool Foam::functionObjects::moleFractions::read(const dictionary& dict)
{
    return true;
}


bool Foam::functionObjects::moleFractions::execute()
{
    // Lookup or construct a multicomponent thermo. Lookup is likely to be
    // appropriate if this is being used at run-time. Construction if this is
    // being called as a one-off post-process.
    const word thermoName =
        IOobject::groupName(physicalProperties::typeName, phaseName_);
    autoPtr<fluidMulticomponentThermo> thermoPtr
    (
        mesh_.foundObject<fluidMulticomponentThermo>(thermoName)
      ? autoPtr<fluidMulticomponentThermo>(nullptr)
      : fluidMulticomponentThermo::New(mesh_)
    );
    const fluidMulticomponentThermo& thermo =
        mesh_.lookupObject<fluidMulticomponentThermo>(thermoName);

    // Construct mole fraction fields corresponding to the mass fraction fields
    const PtrList<volScalarField>& Y = thermo.Y();
    if (X_.empty())
    {
        X_.setSize(Y.size());

        forAll(Y, i)
        {
            X_.set
            (
                i,
                new volScalarField
                (
                    IOobject
                    (
                        "X_" + Y[i].name(),
                        mesh_.time().name(),
                        mesh_
                    ),
                    mesh_,
                    dimensionedScalar(dimless, 0)
                )
            );
        }
    }

    // Get the mixture molar mass
    const volScalarField W(thermo.W());

    // Calculate the mole fractions
    forAll(Y, i)
    {
        X_[i] = Y[i]*W/thermo.Wi(i);
    }

    return true;
}


bool Foam::functionObjects::moleFractions::write()
{
    forAll(X_, i)
    {
        X_[i].write();
    }

    return true;
}


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