File size: 3,437 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 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::LagrangianModelRef
Description
Simple wrapper to provide an optional reference to a Lagrangian model
SourceFiles
LagrangianModelRef.C
\*---------------------------------------------------------------------------*/
#ifndef LagrangianModelRef_H
#define LagrangianModelRef_H
#include "LagrangianSubFieldsFwd.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
class LagrangianSource;
class LagrangianInjection;
/*---------------------------------------------------------------------------*\
Class LagrangianModelRef Declaration
\*---------------------------------------------------------------------------*/
class LagrangianModelRef
{
// Private Data
//- Reference to the source model
const LagrangianSource& source_;
//- Reference to the source field
const LagrangianSubScalarField& S_;
//- Reference to the injection model
const LagrangianInjection& injection_;
public:
// Constructors
//- Construct null
inline LagrangianModelRef();
//- Construct for a source
inline LagrangianModelRef
(
const LagrangianSource& source,
const LagrangianSubScalarField& S
);
//- Construct for an injection
inline LagrangianModelRef
(
const LagrangianInjection& injection
);
// Member Functions
//- Check if the source reference is valid
inline bool isSource() const;
//- Access the source model
inline const LagrangianSource& source() const;
//- Access the source field
inline const LagrangianSubScalarField& S() const;
//- Check if the injection reference is valid
inline bool isInjection() const;
//- Access the injection model
inline const LagrangianInjection& injection() const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "LagrangianModelRefI.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|