MPPICCloud.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) 2013-2024 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::MPPICCloud
 
Description
    Adds MPPIC modelling to clouds
 
SourceFiles
    MPPICCloudI.H
    MPPICCloud.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef MPPICCloud_H
#define MPPICCloud_H
 
#include "volFieldsFwd.H"
#include "fvMatricesFwd.H"
#include "dimensionedTypes.H"
#include "fvMesh.H"
#include "fluidThermo.H"
#include "Cloud.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
// Forward declaration of classes
 
template<class CloudType>
class PackingModel;
 
template<class CloudType>
class DampingModel;
 
template<class CloudType>
class IsotropyModel;
 
 
/*---------------------------------------------------------------------------*\
                       Class MPPICCloudName Declaration
\*---------------------------------------------------------------------------*/
 
TemplateName(MPPICCloud);
 
 
/*---------------------------------------------------------------------------*\
                         Class MPPICCloud Declaration
\*---------------------------------------------------------------------------*/
 
template<class CloudType>
class MPPICCloud
:
    public CloudType,
    public MPPICCloudName
{
public:
 
    // Public Typedefs
 
        //- Type of cloud this cloud was instantiated for
        typedef CloudType cloudType;
 
        //- Type of parcel the cloud was instantiated for
        typedef typename CloudType::parcelType parcelType;
 
        //- Convenience typedef for this cloud type
        typedef MPPICCloud<CloudType> MPPICCloudType;
 
 
private:
 
    // Private Data
 
        //- Cloud copy pointer
        autoPtr<MPPICCloud<CloudType>> cloudCopyPtr_;
 
 
protected:
 
    // Protected data
 
        // References to the cloud sub-models
 
            //- Packing model
            autoPtr<PackingModel<MPPICCloud<CloudType>>>
                packingModel_;
 
            //- Damping model
            autoPtr<DampingModel<MPPICCloud<CloudType>>>
                dampingModel_;
 
            //- Exchange model
            autoPtr<IsotropyModel<MPPICCloud<CloudType>>>
                isotropyModel_;
 
 
        // Initialisation
 
            //- Set cloud sub-models
            void setModels();
 
            //- Reset state of cloud
            void cloudReset(MPPICCloud<CloudType>& c);
 
 
public:
 
    // Constructors
 
        //- Construct given carrier fields
        MPPICCloud
        (
            const word& cloudName,
            const volScalarField& rho,
            const volVectorField& U,
            const volScalarField& mu,
            const dimensionedVector& g,
            const bool readFields = true
        );
 
        //- Construct given carrier fields and thermo
        MPPICCloud
        (
            const word& cloudName,
            const volScalarField& rho,
            const volVectorField& U,
            const dimensionedVector& g,
            const fluidThermo& carrierThermo,
            const bool readFields = true
        );
 
        //- Copy constructor with new name
        MPPICCloud
        (
            MPPICCloud<CloudType>& c,
            const word& name
        );
 
        //- Copy constructor with new name - creates bare cloud
        MPPICCloud
        (
            const fvMesh& mesh,
            const word& name,
            const MPPICCloud<CloudType>& c
        );
 
        //- Disallow default bitwise copy construction
        MPPICCloud(const MPPICCloud&) = delete;
 
        //- Construct and return clone based on (this) with new name
        virtual autoPtr<lagrangian::Cloud<parcelType>> clone(const word& name)
        {
            return autoPtr<lagrangian::Cloud<parcelType>>
            (
                new MPPICCloud(*this, name)
            );
        }
 
        //- Construct and return bare clone based on (this) with new name
        virtual autoPtr<lagrangian::Cloud<parcelType>> cloneBare
        (
            const word& name
        ) const
        {
            return autoPtr<lagrangian::Cloud<parcelType>>
            (
                new MPPICCloud(this->mesh(), name, *this)
            );
        }
 
 
    //- Destructor
    virtual ~MPPICCloud();
 
 
    // Member Functions
 
        // Access
 
            //- Return a reference to the cloud copy
            inline const MPPICCloud& cloudCopy() const;
 
            //- Return const access to the packing model
            inline const PackingModel<MPPICCloud<CloudType>>&
                packingModel() const;
 
            //- Return a reference to the packing model
            inline PackingModel<MPPICCloud<CloudType>>& packingModel();
 
            //- Return condt access to the damping model
            inline const DampingModel<MPPICCloud<CloudType>>&
                dampingModel() const;
 
            //- Return a reference to the damping model
            inline DampingModel<MPPICCloud<CloudType>>& dampingModel();
 
            //- Return condt access to the isotropy model
            inline const IsotropyModel<MPPICCloud<CloudType>>&
                isotropyModel() const;
 
            //- Return a reference to the isotropy model
            inline IsotropyModel<MPPICCloud<CloudType>>& isotropyModel();
 
 
        // Cloud evolution functions
 
            //- Store the current cloud state
            void storeState();
 
            //- Reset the current cloud to the previously stored state
            void restoreState();
 
            //- Evolve the cloud
            void evolve();
 
            //- Particle motion
            template<class TrackCloudType>
            void motion
            (
                TrackCloudType& cloud,
                typename parcelType::trackingData& td
            );
 
 
        //- I-O
 
            //- Print cloud information
            void info();
 
 
    // Member Operators
 
        //- Disallow default bitwise assignment
        void operator=(const MPPICCloud&) = delete;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#include "MPPICCloudI.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#ifdef NoRepository
    #include "MPPICCloud.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //