coupledToIncompressibleFluid.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::clouds::coupledToIncompressibleFluid
26 
27 Description
28  Base class for clouds which are coupled to an incompressible fluid
29 
30 SourceFiles
31  coupledToIncompressibleFluid.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef coupledToIncompressibleFluid_H
36 #define coupledToIncompressibleFluid_H
37 
38 #include "coupled.H"
39 #include "physicalProperties.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 namespace clouds
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class coupledToIncompressibleFluid Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 :
54  public coupled
55 {
56 private:
57 
58  // Private Member Data
59 
60  //- Reference to the mesh
61  const LagrangianMesh& mesh_;
62 
63  //- Physical properties dictionary
64  Foam::physicalProperties physicalProperties_;
65 
66  //- Cached carrier kinematic viscosity field
67  tmp<volScalarField> tnucVf_;
68 
69 
70  // Private Member Functions
71 
72  //- Get the carrier kinematic viscosity field
73  virtual tmp<volScalarField> getNucVf() const;
74 
75  //- Calculate the carrier kinematic viscosity
76  virtual tmp<LagrangianSubScalarField> calcNuc
77  (
78  const LagrangianModelRef& model,
79  const LagrangianSubMesh& subMesh
80  ) const;
81 
82 
83 protected:
84 
85  // Protected Member Functions
86 
87  //- Update the carrier kinematic viscosity
88  void updateNuc();
89 
90 
91 public:
92 
93  // Public Static Data
94 
95  //- Run-time type information
96  TypeName("coupledToIncompressibleFluid");
97 
98 
99  // Public Data
100 
101  //- Cloud/carrier density ratio
103 
104  //- Carrier kinematic viscosity
105  const CarrierField<scalar>& nuc;
106 
107 
108  // Constructors
109 
110  //- Construct from a reference to the cloud
112 
113 
114  //- Destructor
116 };
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 } // End namespace clouds
121 } // End namespace Foam
122 
123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
124 
125 #endif
126 
127 // ************************************************************************* //
Class containing Lagrangian geometry and topology.
Simple wrapper to provide an optional reference to a Lagrangian model.
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:63
Base class for clouds which are coupled to an incompressible fluid.
void updateNuc()
Update the carrier kinematic viscosity.
TypeName("coupledToIncompressibleFluid")
Run-time type information.
coupledToIncompressibleFluid(const cloud &)
Construct from a reference to the cloud.
const dimensionedScalar rhoByRhoc
Cloud/carrier density ratio.
const CarrierField< scalar > & nuc
Carrier kinematic viscosity.
Base class for clouds which are coupled to a fluid.
Definition: coupled.H:60
A base class for physical properties.
A class for managing temporary objects.
Definition: tmp.H:55
Namespace for OpenFOAM.