coupled.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) 2025-2026 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::clouds::coupled
 
Description
    Base class for clouds which are coupled to a carrier
 
SourceFiles
    coupled.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef coupled_H
#define coupled_H
 
#include "carried.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
template<class Type>
class CarrierEqn;
 
namespace clouds
{
 
/*---------------------------------------------------------------------------*\
                           Class coupled Declaration
\*---------------------------------------------------------------------------*/
 
class coupled
{
private:
 
    // Private Data
 
        //- Reference to the cloud
        const cloud& cloud_;
 
        //- Reference to the carried cloud
        const carried& carriedCloud_;
 
        //- Are any carrier equations cached?
        mutable bool hasCarrierEqns_;
 
        //- Cached carrier kinematic viscosity field
        tmp<volScalarField> tnucVf_;
 
        //- Carrier equations
        #define DECLARE_CARRIER_EQNS(Type, nullArg)    \
            mutable HashPtrTable<CarrierEqn<Type>>     \
                CAT3(carrier, CAPITALIZE(Type), Eqns_);
        FOR_ALL_FIELD_TYPES(DECLARE_CARRIER_EQNS);
        #undef DECLARE_CARRIER_EQNS
 
        //- Carrier velocity time derivative
        mutable autoPtr<volVectorField> dUdtcPtr_;
 
 
    // Private Member Functions
 
        //- Get the carrier kinematic viscosity field
        tmp<volScalarField> getNucVf() const;
 
        //- Calculate the carrier kinematic viscosity
        virtual tmp<LagrangianSubScalarField> calcNuc
        (
            const LagrangianModelRef& model,
            const LagrangianSubMesh& subMesh
        ) const;
 
        //- Access the carrier equations. Only specialisations are defined.
        template<class Type>
        HashPtrTable<CarrierEqn<Type>>& carrierEqns() const;
 
 
protected:
 
    // Protected Member Functions
 
        //- Update the cached carrier fields
        void updateCarrier();
 
        //- Add/get a carrier equation to/from the cache
        template<class Type>
        CarrierEqn<Type>& carrierEqn(const CloudDerivedField<Type>&);
 
        //- Add/get a carrier equation to/from the cache
        template<class Type>
        CarrierEqn<Type>& carrierEqn(const CarrierField<Type>&);
 
        //- Clear the carrier equations
        void clearCarrierEqns();
 
        //- Do we need to re-calculate particles that are modified?
        template<class Type>
        bool initPsicDdt
        (
            const LagrangianSubScalarSubField& vOrM,
            const CloudDerivedField<Type>& psic
        ) const;
 
        //- Return the basic models-only equation for a carrier field
        tmp<LagrangianEqn<scalar>> psicEqn
        (
            const LagrangianSubScalarField& deltaT,
            const LagrangianSubScalarSubField& vOrM,
            const CloudDerivedField<scalar>& oneOrRhoc
        ) const;
 
        //- Return the basic models-only equation for a carrier field
        template<class Type>
        tmp<LagrangianEqn<Type>> psicEqn
        (
            const LagrangianSubScalarField& deltaT,
            const LagrangianSubScalarSubField& vOrM,
            const LagrangianSubSubField<Type>& psi,
            const CloudDerivedField<Type>& psic
        ) const;
 
 
public:
 
    // Public Static Data
 
        //- Run-time type information
        TypeName("coupled");
 
 
    // Public Data
 
        //- Carrier kinematic viscosity
        const CloudDerivedField<scalar>& nuc;
 
 
    // Constructors
 
        //- Construct from a reference to the cloud
        coupled(const cloud& c, const carried&);
 
 
    //- Destructor
    virtual ~coupled();
 
 
    // Member Functions
 
        // Equations
 
            //- Return if any carrier equations are cached
            bool hasCarrierEqns() const;
 
            //- Return if a carrier equation is in the cache
            template<class Type>
            bool hasCarrierEqn(const word&) const;
 
            //- Get a carrier equation from the cache
            template<class Type>
            const CarrierEqn<Type>& carrierEqn(const word&) const;
 
            //- Get multiple phase carrier equations from the cache
            template<class Type>
            const HashTable<const CarrierEqn<Type>*> carrierEqns
            (
                const word&
            ) const;
 
            //- Return if a carrier equation is in the cache
            template<class Type>
            bool hasCarrierEqn(const VolField<Type>&) const;
 
            //- Get a carrier equation from the cache
            template<class Type>
            const CarrierEqn<Type>& carrierEqn(const VolField<Type>&) const;
 
            //- Get multiple phase carrier equations from the cache
            template<class Type>
            const HashTable<const CarrierEqn<Type>*> carrierEqns
            (
                const VolField<Type>&
            ) const;
};
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace clouds
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#ifdef NoRepository
    #include "coupledTemplates.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //