cloud_functionObjectTemplates.C
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 \*---------------------------------------------------------------------------*/
25 
26 #include "cloud.H"
27 #include "cloud_functionObject.H"
28 
29 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
30 
31 template<class Type>
33 (
34  const word& name,
35  const Time& runTime,
36  const dictionary& dict,
37  const cloud::Cloud<Type>&
38 )
39 :
40  regionFunctionObject(name, runTime, dict),
41  cloudPtr_
42  (
43  new Type
44  (
45  refCast<const polyMesh>(obr_),
46  name,
47  Foam::cloud::contextType::functionObject,
48  IOobject::READ_IF_PRESENT,
49  IOobject::NO_WRITE
50  )
51  )
52 {
53  // Ensure LagrangianModels are constructed before time is incremented
54  cloudPtr_->LagrangianModels();
55 }
56 
57 
58 template<class Type>
60 (
61  const word& name,
62  const Time& runTime,
63  const dictionary& dict
64 )
65 :
66  cloud(name, runTime, dict, cloud::Cloud<Type>())
67 {}
68 
69 
70 // ************************************************************************* //
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:99
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:76
Foam::LagrangianModels & LagrangianModels() const
Access the models.
Definition: cloud.C:623
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
Abstract base-class for Time/database functionObjects.
Cloud(const word &name, const Time &runTime, const dictionary &dict)
Construct from components.
Empty template class used to template the constructor on the type.
Function object that solves for the evolution of a cloud. Only provides one-way coupling with a finit...
cloud(const word &name, const Time &runTime, const dictionary &dict, const Cloud< Type > &)
Construct from components.
Specialisation of Foam::functionObject for a region.
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:80
A class for handling words, derived from string.
Definition: word.H:62
Namespace for OpenFOAM.
To & refCast(From &r)
Reference type cast template function.
Definition: typeInfo.H:134
word name(const LagrangianState state)
Return a string representation of a Lagrangian state enumeration.
dictionary dict