PopulationBalancePhaseSystem.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) 2017-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/>.
 
Class
    Foam::PopulationBalancePhaseSystem
 
Description
    Class which provides population balance functionality. Stores the mass
    transfer rates resulting from coalescence, breakup or drift across
    representative phases that collectively define a dispersed phase.
 
See also
    Foam::diameterModels::populationBalanceModel
 
SourceFiles
    PopulationBalancePhaseSystem.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef PopulationBalancePhaseSystem_H
#define PopulationBalancePhaseSystem_H
 
#include "phaseSystem.H"
#include "populationBalanceModel.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                Class PopulationBalancePhaseSystem Declaration
\*---------------------------------------------------------------------------*/
 
template<class BasePhaseSystem>
class PopulationBalancePhaseSystem
:
    public BasePhaseSystem
{
    // Private data
 
        //- Population balances
        PtrList<diameterModels::populationBalanceModel> populationBalances_;
 
 
public:
 
    // Constructors
 
        //- Construct from fvMesh
        PopulationBalancePhaseSystem(const fvMesh&);
 
 
    //- Destructor
    virtual ~PopulationBalancePhaseSystem();
 
 
    // Member Functions
 
        //- Return the mass transfer rate for an interface
        virtual tmp<volScalarField> dmdtf(const phaseInterfaceKey& key) const;
 
        //- Return the mass transfer rates for each phase
        virtual PtrList<volScalarField> dmdts() const;
 
        //- Return the momentum transfer matrices for the cell-based algorithm
        virtual autoPtr<phaseSystem::momentumTransferTable> momentumTransfer();
 
        //- Return the momentum transfer matrices for the face-based algorithm
        virtual autoPtr<phaseSystem::momentumTransferTable> momentumTransferf();
 
        //- Return the heat transfer matrices
        virtual autoPtr<phaseSystem::heatTransferTable> heatTransfer() const;
 
        //- Return the specie transfer matrices
        virtual autoPtr<phaseSystem::specieTransferTable>
            specieTransfer() const;
 
        //- Solve all population balance equations
        virtual void solve
        (
            const PtrList<volScalarField>& rAUs,
            const PtrList<surfaceScalarField>& rAUfs
        );
 
        //- Correct derived properties
        virtual void correct();
 
        //- Read base phaseProperties dictionary
        virtual bool read();
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#ifdef NoRepository
    #include "PopulationBalancePhaseSystem.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //