surfaceAreaLagrangianScalarFieldSource.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 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::surfaceAreaLagrangianScalarFieldSource
 
Description
    This source condition provides the surface area of introduced particles. It
    converts between the corresponding diameter/etc..., conditions to
    automatically produce a value for the surface area. It is selected
    automatically by the functions that need it, so the user should never need
    to specify this condition explicitly.
 
SourceFiles
    surfaceAreaLagrangianScalarFieldSource.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef surfaceAreaLagrangianScalarFieldSource_H
#define surfaceAreaLagrangianScalarFieldSource_H
 
#include "LagrangianFieldSources.H"
#include "CloudLagrangianFieldSource.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
             Class surfaceAreaLagrangianScalarFieldSource Declaration
\*---------------------------------------------------------------------------*/
 
class surfaceAreaLagrangianScalarFieldSource
:
    public LagrangianScalarFieldSource,
    private CloudLagrangianFieldSource<scalar>
{
public:
 
    //- Runtime type information
    TypeName("surfaceArea");
 
 
    // Constructors
 
        //- Construct from internal field
        surfaceAreaLagrangianScalarFieldSource(const regIOobject&);
 
        //- Construct from internal field and dictionary
        surfaceAreaLagrangianScalarFieldSource
        (
            const regIOobject&,
            const dictionary&
        );
 
        //- Copy constructor setting the internal field reference
        surfaceAreaLagrangianScalarFieldSource
        (
            const surfaceAreaLagrangianScalarFieldSource&,
            const regIOobject&
        );
 
        //- Construct and return a clone setting the internal field reference
        virtual autoPtr<LagrangianScalarFieldSource> clone
        (
            const regIOobject& iIo
        ) const
        {
            return autoPtr<LagrangianScalarFieldSource>
            (
                new surfaceAreaLagrangianScalarFieldSource(*this, iIo)
            );
        }
 
 
    //- Destructor
    virtual ~surfaceAreaLagrangianScalarFieldSource();
 
 
    // Member Functions
 
        //- Return the value for an instantaneous injection
        virtual tmp<LagrangianSubScalarField> value
        (
            const LagrangianInjection&,
            const LagrangianSubMesh&
        ) const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //