NaNLagrangianFieldSource.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::NaNLagrangianFieldSource
 
Description
    This source condition provides a NaN value.
 
Usage
    Example specification:
    \verbatim
    <LagrangianModelName>
    {
        type            NaN;
    }
    \endverbatim
 
SourceFiles
    NaNLagrangianFieldSource.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef NaNLagrangianFieldSource_H
#define NaNLagrangianFieldSource_H
 
#include "LagrangianFieldSource.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
               Class NaNLagrangianFieldSource Declaration
\*---------------------------------------------------------------------------*/
 
template<class Type>
class NaNLagrangianFieldSource
:
    public LagrangianFieldSource<Type>
{
public:
 
    //- Runtime type information
    TypeName("NaN");
 
 
    // Constructors
 
        //- Inherit constructors
        using LagrangianFieldSource<Type>::LagrangianFieldSource;
 
        //- Construct and return a clone setting the internal field reference
        virtual autoPtr<LagrangianFieldSource<Type>> clone
        (
            const regIOobject& iIo
        ) const
        {
            return autoPtr<LagrangianFieldSource<Type>>
            (
                new NaNLagrangianFieldSource<Type>(*this, iIo)
            );
        }
 
 
    //- Destructor
    virtual ~NaNLagrangianFieldSource();
 
 
    // Member Functions
 
        //- Return the source value
        virtual tmp<LagrangianSubField<Type>> sourceValue
        (
            const LagrangianSource&,
            const LagrangianSubMesh&
        ) const;
 
        //- Return the internal coefficient
        virtual tmp<LagrangianSubScalarField> internalCoeff
        (
            const LagrangianSource&,
            const LagrangianSubMesh&
        ) const;
 
        //- Return the value for an instantaneous injection
        virtual tmp<LagrangianSubField<Type>> value
        (
            const LagrangianInjection&,
            const LagrangianSubMesh&
        ) const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#ifdef NoRepository
    #include "NaNLagrangianFieldSource.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //