incompressibleMultiphaseVoFMixture.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) 2023 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::incompressibleMultiphaseVoFMixture
26 
27 Description
28  Incompressible multiphase mixture for interface-capturing simulations.
29 
30  Derived from viscosity so that it can be used in conjunction with the
31  incompressible turbulence models.
32 
33  Surface tension and contact-angle is handled for the interface between each
34  phase-pair.
35 
36 SourceFiles
37  incompressibleMultiphaseVoFMixture.C
38 
39 See also
40  Foam::multiphaseVoFMixture
41  Foam::incompressibleVoFphase
42 
43 \*---------------------------------------------------------------------------*/
44 
45 #ifndef incompressibleMultiphaseVoFMixture_H
46 #define incompressibleMultiphaseVoFMixture_H
47 
48 #include "multiphaseVoFMixture.H"
49 #include "viscosity.H"
50 #include "UPtrListDictionary.H"
51 #include "incompressibleVoFphase.H"
52 
53 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
54 
55 namespace Foam
56 {
57 
58 /*---------------------------------------------------------------------------*\
59  Class incompressibleMultiphaseVoFMixture Declaration
60 \*---------------------------------------------------------------------------*/
61 
63 :
64  public multiphaseVoFMixture,
65  public viscosity
66 {
67  // Private Data
68 
69  //- Dictionary of phases
71 
72  //- Mixture density
73  volScalarField rho_;
74 
75  //- Mixture viscosity
76  volScalarField nu_;
77 
78 
79  // Private Member Functions
80 
81  //- Return the dynamic laminar viscosity
82  tmp<volScalarField> mu() const;
83 
84 
85 public:
86 
87  TypeName("incompressibleMultiphaseVoFMixture");
88 
89 
90  // Constructors
91 
92  //- Construct from components
94 
95 
96  //- Destructor
98  {}
99 
100 
101  // Member Functions
102 
103  //- Return the phases
105  {
106  return phases_;
107  }
108 
109  //- Return the mixture density
110  virtual const volScalarField& rho() const
111  {
112  return rho_;
113  }
114 
115  //- Return the kinematic laminar viscosity
116  virtual tmp<volScalarField> nu() const;
117 
118  //- Return the laminar viscosity for patch
119  virtual tmp<scalarField> nu(const label patchi) const;
120 
121  //- Correct the mixture properties
122  virtual void correct();
123 
124  //- Read base phaseProperties dictionary
125  virtual bool read();
126 };
127 
128 
129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 
131 } // End namespace Foam
132 
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 
135 #endif
136 
137 // ************************************************************************* //
Generic GeometricField class.
Template dictionary class which manages the storage associated with it.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:99
Incompressible multiphase mixture for interface-capturing simulations.
virtual void correct()
Correct the mixture properties.
virtual tmp< volScalarField > nu() const
Return the kinematic laminar viscosity.
TypeName("incompressibleMultiphaseVoFMixture")
virtual const volScalarField & rho() const
Return the mixture density.
UPtrListDictionary< incompressibleVoFphase > & phases()
Return the phases.
incompressibleMultiphaseVoFMixture(const fvMesh &mesh)
Construct from components.
virtual bool read()
Read base phaseProperties dictionary.
Multiphase VoF mixture with support for interface properties.
A class for managing temporary objects.
Definition: tmp.H:55
Abstract base class for all fluid physical properties.
Definition: viscosity.H:50
label patchi
Namespace for OpenFOAM.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59