cloud_fvModelTemplates.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_fvModel.H"
27 
28 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
29 
30 template<class Type>
32 (
33  const word& name,
34  const word& modelType,
35  const fvMesh& mesh,
36  const dictionary& dict,
37  const cloud::Cloud<Type>&
38 )
39 :
40  fvModel(name, modelType, mesh, dict),
41  cloudPtr_(new Type(mesh, name, Foam::cloud::contextType::fvModel)),
42  cloud_(cloudPtr_()),
43  coupledCloud_(refCast<const clouds::coupled>(cloud_))
44 {
45  // Ensure LagrangianModels are constructed before time is incremented
46  cloudPtr_->LagrangianModels();
47 }
48 
49 
50 template<class Type>
52 (
53  const word& name,
54  const word& modelType,
55  const fvMesh& mesh,
56  const dictionary& dict
57 )
58 :
59  cloud(name, modelType, mesh, dict, cloud::Cloud<Type>())
60 {}
61 
62 
63 // ************************************************************************* //
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
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:96
Finite volume model abstract base class.
Definition: fvModel.H:60
Cloud(const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
Construct from components.
Empty template class used to template the constructor on the type.
Finite volume model that solves for the evolution of a cloud. Provides two-way coupling with a finite...
Definition: cloud_fvModel.H:56
cloud(const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict, const Cloud< Type > &)
Construct from components.
This fvModel adds any number of Lagrangian clouds to any single-phase solver. The particles are track...
Definition: clouds.H:131
A class for handling words, derived from string.
Definition: word.H:62
Foam::fvMesh mesh(Foam::IOobject(regionName, runTime.name(), runTime, Foam::IOobject::MUST_READ), false)
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