cloudFunctionObject.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 "cloudFunctionObject.H"
28 #include "fvMesh.H"
29 #include "fvMeshFunctionObject.H"
30 #include "cloud.H"
31 
32 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
33 
34 namespace Foam
35 {
36 namespace functionObjects
37 {
39 }
40 }
41 
42 
43 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
44 
46 (
47  const LagrangianMeshFunctionObject& function
48 )
49 :
50  function_(function),
51  cloud_
52  (
53  function.mesh().lookupType<Foam::cloud>()
54  )
55 {}
56 
57 
59 (
60  const fvMeshFunctionObject& function,
61  const dictionary& dict
62 )
63 :
64  function_(function),
65  cloud_
66  (
67  function.mesh().lookupObject<LagrangianMesh>
68  (
69  dict.lookup<word>(cloud::typeName)
70  ).lookupType<Foam::cloud>()
71  )
72 {}
73 
74 
75 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
76 
78 {}
79 
80 
81 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
82 
84 {
85  return cloud<Foam::cloud>();
86 }
87 
88 
90 {}
91 
92 
94 (
95  const LagrangianSubScalarField& deltaT,
96  const bool final
97 )
98 {}
99 
100 
102 (
104 )
105 {}
106 
107 
109 (
110  const LagrangianSubScalarSubField& fraction
111 )
112 {}
113 
114 
116 (
117  const LagrangianSubScalarSubField& fraction
118 )
119 {}
120 
121 
123 (
125 )
126 {}
127 
128 
130 {}
131 
132 
133 // ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Class containing Lagrangian geometry and topology.
Base class for clouds. Provides a basic evolution algorithm, models, and a database for caching deriv...
Definition: cloud.H:63
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
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...
virtual void postSolve()
Hook following solution steps.
virtual void postCrossFaces(const LagrangianSubScalarSubField &fraction)
Hook following face crossings of a specific sub-mesh.
cloudFunctionObject(const LagrangianMeshFunctionObject &)
Construct from a Lagrangian mesh function object.
virtual void preSolve()
Hook before solution steps.
virtual void calculate(const LagrangianSubScalarField &deltaT, const bool final)
Solve equations and/or update continually changing properties.
const Cloud & cloud() const
Get a reference to the cloud.
virtual void preCrossFaces(const LagrangianScalarInternalDynamicField &fraction)
Hook before all face crossings.
Function object that solves for the evolution of a cloud. Only provides one-way coupling with a finit...
Specialisation of Foam::functionObject for an Foam::fvMesh, providing a reference to the Foam::fvMesh...
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)
defineTypeNameAndDebug(adjustTimeStepToCombustion, 0)
Namespace for OpenFOAM.
dictionary dict