cloudLagrangianMeshFunctionObject.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::functionObjects::cloudLagrangianMeshFunctionObject
26 
27 Description
28  Base class for function objects that refer to a LagrangianMesh and a cloud.
29  Used, for example, to construct, evolve and write derived Lagrangian
30  properties.
31 
32 SourceFiles
33  cloudLagrangianMeshFunctionObject.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef cloudLagrangianMeshFunctionObject_functionObject_H
38 #define cloudLagrangianMeshFunctionObject_functionObject_H
39 
41 #include "cloudFunctionObject.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 namespace functionObjects
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class cloudLagrangianMeshFunctionObject Declaration
52 \*---------------------------------------------------------------------------*/
53 
55 :
57  public cloudFunctionObject
58 {
59 public:
60 
61  //- Runtime type information
62  TypeName("cloudLagrangianMeshFunctionObject");
63 
64 
65  // Constructors
66 
67  //- Construct from Time and dictionary
69  (
70  const word& name,
71  const Time& runTime,
72  const dictionary& dict
73  );
74 
75  //- Disallow default bitwise copy construction
77  (
79  ) = delete;
80 
81 
82  //- Destructor
84 
85 
86  // Member Operators
87 
88  //- Disallow default bitwise assignment
89  void operator=(const cloudLagrangianMeshFunctionObject&) = delete;
90 };
91 
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 } // End namespace functionObjects
96 } // End namespace Foam
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 #endif
101 
102 // ************************************************************************* //
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:76
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
const word & name() const
Return the name of this functionObject.
Base class for function objects relating to a Lagrangian mesh.
Base class for function objects that refer to a cloud. Provides hooks into the cloud solution process...
Base class for function objects that refer to a LagrangianMesh and a cloud. Used, for example,...
TypeName("cloudLagrangianMeshFunctionObject")
Runtime type information.
cloudLagrangianMeshFunctionObject(const word &name, const Time &runTime, const dictionary &dict)
Construct from Time and dictionary.
void operator=(const cloudLagrangianMeshFunctionObject &)=delete
Disallow default bitwise assignment.
A class for handling words, derived from string.
Definition: word.H:62
Namespace for OpenFOAM.
dictionary dict