LagrangianModelRef.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2025 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::LagrangianModelRef
26 
27 Description
28  Simple wrapper to provide an optional reference to a Lagrangian model
29 
30 SourceFiles
31  LagrangianModelRef.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef LagrangianModelRef_H
36 #define LagrangianModelRef_H
37 
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 
40 namespace Foam
41 {
42 
43 class LagrangianModel;
44 
45 /*---------------------------------------------------------------------------*\
46  Class LagrangianModelRef Declaration
47 \*---------------------------------------------------------------------------*/
48 
50 {
51  // Private Data
52 
53  //- Reference to the model
54  const LagrangianModel& ref_;
55 
56 
57 public:
58 
59  // Constructors
60 
61  //- Construct null
62  inline LagrangianModelRef();
63 
64  //- Construct for given reference
65  inline LagrangianModelRef(const LagrangianModel& ref);
66 
67 
68  // Member Functions
69 
70  //- Check if the reference is valid
71  inline bool valid() const;
72 
73 
74  // Member Operators
75 
76  //- Access the reference
77  inline const LagrangianModel& operator()() const;
78 };
79 
80 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
81 
82 } // End namespace Foam
83 
84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
85 
86 #include "LagrangianModelRefI.H"
87 
88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
89 
90 #endif
91 
92 // ************************************************************************* //
Simple wrapper to provide an optional reference to a Lagrangian model.
bool valid() const
Check if the reference is valid.
const LagrangianModel & operator()() const
Access the reference.
LagrangianModelRef()
Construct null.
Base class for Lagrangian models.
trAU ref().rename("rAU")
Namespace for OpenFOAM.