Removed unnecessary return statement
[foam-extend-3.2.git] / applications / solvers / surfaceTracking / freeSurface / surfactantProperties.H
blob3c9dbdc925705c912f7aa9d4877365887794b5cc
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | foam-extend: Open Source CFD
4    \\    /   O peration     | Version:     3.2
5     \\  /    A nd           | Web:         http://www.foam-extend.org
6      \\/     M anipulation  | For copyright notice see file Copyright
7 -------------------------------------------------------------------------------
8 License
9     This file is part of foam-extend.
11     foam-extend is free software: you can redistribute it and/or modify it
12     under the terms of the GNU General Public License as published by the
13     Free Software Foundation, either version 3 of the License, or (at your
14     option) any later version.
16     foam-extend is distributed in the hope that it will be useful, but
17     WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19     General Public License for more details.
21     You should have received a copy of the GNU General Public License
22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     surfactantProperties
27 Description
29 SourceFiles
30     surfactantProperties.H
32 \*---------------------------------------------------------------------------*/
35 #ifndef SurfactantProperties_H
36 #define SurfactantProperties_H
39 #include "fvCFD.H"
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 namespace Foam
46 /*---------------------------------------------------------------------------*\
47                   Class freeSurface Declaration
48 \*---------------------------------------------------------------------------*/
50 class surfactantProperties
52     // Private data
54         //- Surfactant concetration in the bulk of fluid
55         dimensionedScalar surfactBulkConc_;
57         //- Saturated surfactant concentration on the free-surface
58         dimensionedScalar surfactSaturatedConc_;
60         //- Adsorption coefficient of surfactant
61         dimensionedScalar surfactAdsorptionCoeff_;
63         //- Desorption coefficient of surfactant
64         dimensionedScalar surfactDesorptionCoeff_;
66         //- Diffusion coefficient of surfactant in the bulk of fluid
67         dimensionedScalar surfactBulkDiffusion_;
69         //- Diffusion coefficient of surfactant at the free-surface
70         dimensionedScalar surfactDiffusion_;
72         //- Temperature of surfactant at the free-surface
73         dimensionedScalar surfactT_;
75         //- Universal gas constant
76         dimensionedScalar surfactR_;
78         //- Equilibrium surfactant concentration at the free-surface
79         dimensionedScalar surfactEquilibriumConc_;
81         //- Is the surfactant soluble
82         Switch soluble_;
84 public:
86     // Constructors
87     surfactantProperties(const dictionary& dict)
88     :
89         surfactBulkConc_(dict.lookup("bulkConc")),
90         surfactSaturatedConc_(dict.lookup("saturatedConc")),
91         surfactAdsorptionCoeff_(dict.lookup("adsorptionCoeff")),
92         surfactDesorptionCoeff_(dict.lookup("desorptionCoeff")),
93         surfactBulkDiffusion_(dict.lookup("bulkDiffusion")),
94         surfactDiffusion_(dict.lookup("diffusion")),
95         surfactT_(dict.lookup("temperature")),
96         surfactR_("R", dimGasConstant*dimMass/dimMoles, 8.3144),
97         surfactEquilibriumConc_
98         (
99             surfactSaturatedConc_
100            /(
101                 1.0
102               + surfactDesorptionCoeff_
103                /surfactBulkConc_
104             )
105         ),
106         soluble_(dict.lookup("soluble"))
107     {}
110     // Member function
112         //- Return surfactant concentration in the bulk of fluid
113         const dimensionedScalar& surfactBulkConc() const
114         {
115             return surfactBulkConc_;
116         }
118         //- Return saturated surfactant concentration at the free-surface
119         const dimensionedScalar& surfactSaturatedConc() const
120         {
121             return surfactSaturatedConc_;
122         }
124         //- Return surfactant adsorption coefficient
125         const dimensionedScalar& surfactAdsorptionCoeff() const
126         {
127             return surfactAdsorptionCoeff_;
128         }
130         //- Return surfactant desorption coefficient
131         const dimensionedScalar& surfactDesorptionCoeff() const
132         {
133             return surfactDesorptionCoeff_;
134         }
136         //- Return diffusion coefficient of the surfactant in the bulk of fluid
137         const dimensionedScalar& surfactBulkDiffusion() const
138         {
139             return surfactBulkDiffusion_;
140         }
142         //- Return diffusion coefficient of the surfactant at the free-surface
143         const dimensionedScalar& surfactDiffusion() const
144         {
145             return surfactDiffusion_;
146         }
148         //- Return surfactant temeprature
149         const dimensionedScalar& surfactT() const
150         {
151             return surfactT_;
152         }
154         //- Return universal gas constant
155         const dimensionedScalar& surfactR() const
156         {
157             return surfactR_;
158         }
160         //- Return equilibrium surfactant concentration at the free-surface
161         const dimensionedScalar& surfactEquilibriumConc() const
162         {
163             return surfactEquilibriumConc_;
164         }
166         //- Is the surfactant soluble
167         Switch soluble() const
168         {
169             return soluble_;
170         }
174 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
176 } // End namespace Foam
178 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
180 #endif
182 // ************************************************************************* //