multicomponentParticle.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-2026 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::clouds::multicomponentParticle
26 
27 Description
28  Cloud with spherical particles with multicomponent thermodynamic modelling
29 
30 SourceFiles
31  multicomponentParticle.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef multicomponentParticle_H
36 #define multicomponentParticle_H
37 
38 #include "multicomponentThermal.H"
39 #include "coupledToThermalFluid.H"
40 #include "sphericalCoupled.H"
41 #include "massiveCoupledToFluid.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 namespace clouds
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class multicomponentParticle Declaration
52 \*---------------------------------------------------------------------------*/
53 
55 :
56  public cloud,
57  public carried,
58  public spherical,
59  public multicomponentThermal,
60  public coupledToThermalFluid,
61  public sphericalCoupled,
63 {
64 protected:
65 
66  // Protected Member Functions
67 
68  //- Return the acceleration with which to do second-order tracking
70  (
71  const LagrangianSubMesh&
72  ) const;
73 
74  //- Do we need to re-calculate particles that are modified?
75  virtual bool reCalculateModified();
76 
77  //- Update the cloud properties
78  virtual void calculate
79  (
80  const LagrangianSubScalarField& deltaT,
81  const bool final
82  );
83 
84  //- Partition hook
85  virtual void partition();
86 
87 
88 public:
89 
90  // Public Static Data
91 
92  //- Run-time type information
93  TypeName("multicomponentParticle");
94 
95 
96  // Constructors
97 
98  //- Construct from a mesh and context
100  (
102  const contextType context,
103  const dictionary& dict
104  );
105 
106 
107  //- Destructor
108  virtual ~multicomponentParticle();
109 
110 
111  // Member Functions
112 
113  //- Solve the cloud's evolution over the current time-step
114  virtual void solve(const bool initial, const bool final);
115 };
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 } // End namespace clouds
120 } // End namespace Foam
121 
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123 
124 #endif
125 
126 // ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Class containing Lagrangian geometry and topology.
Mesh that relates to a sub-section of a Lagrangian mesh. This is used to construct fields that relate...
Base class for clouds. Provides a basic evolution algorithm, models, and a database for caching deriv...
Definition: cloud.H:61
contextType
Context in which this cloud is used.
Definition: cloud.H:203
enum Foam::cloud::contextType context
const LagrangianMesh & mesh() const
Access the mesh.
Definition: cloud.H:280
Base class for clouds which are carried by a fluid.
Definition: carried.H:57
Base class for clouds which are coupled to a fluid with a thermodynamic model.
Base class for clouds of massive particles which are coupled to a fluid.
Cloud with spherical particles with multicomponent thermodynamic modelling.
virtual void solve(const bool initial, const bool final)
Solve the cloud's evolution over the current time-step.
TypeName("multicomponentParticle")
Run-time type information.
virtual bool reCalculateModified()
Do we need to re-calculate particles that are modified?
virtual tmp< LagrangianSubVectorField > dUdt(const LagrangianSubMesh &) const
Return the acceleration with which to do second-order tracking.
multicomponentParticle(LagrangianMesh &mesh, const contextType context, const dictionary &dict)
Construct from a mesh and context.
virtual void partition()
Partition hook.
virtual void calculate(const LagrangianSubScalarField &deltaT, const bool final)
Update the cloud properties.
Base class for clouds with multicomponent thermodynamic modelling.
Base class for clouds of spherical particles which are coupled to a carrier.
Base class for clouds with spherical particles.
Definition: spherical.H:53
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
A class for managing temporary objects.
Definition: tmp.H:55
Namespace for OpenFOAM.
dictionary dict