APIdiffusionCoefficient.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) 2011-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 \*---------------------------------------------------------------------------*/
25 
28 
29 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
30 
31 namespace Foam
32 {
33 namespace Function2s
34 {
36 
37  // Permit lookup with the old type name for backwards compatibility
39  (
40  scalarFunction2,
42  dictionary,
43  APIdiffCoef
44  );
45 }
46 }
47 
48 
49 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
50 
52 (
53  const word& name,
54  const scalar a,
55  const scalar b,
56  const scalar wf,
57  const scalar wa
58 )
59 :
61  a_(a),
62  b_(b),
63  wf_(wf),
64  wa_(wa),
65  alpha_(sqrt(1/wf_ + 1/wa_)),
66  beta_(sqr(cbrt(a_) + cbrt(b_)))
67 {}
68 
69 
71 (
72  const word& name,
73  const unitSets& units,
74  const dictionary& dict
75 )
76 :
78  a_(dict.lookup<scalar>("a")),
79  b_(dict.lookup<scalar>("b")),
80  wf_(dict.lookup<scalar>("wf")),
81  wa_(dict.lookup<scalar>("wa")),
82  alpha_(sqrt(1/wf_ + 1/wa_)),
83  beta_(sqr((cbrt(a_) + cbrt(b_))))
84 {
86 }
87 
88 
89 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
90 
92 (
93  Ostream& os,
94  const unitSets& units
95 ) const
96 {
97  writeEntry(os, "a", a_);
98  writeEntry(os, "b", b_);
99  writeEntry(os, "wf", wf_);
100  writeEntry(os, "wa", wa_);
101 }
102 
103 
104 // ************************************************************************* //
Macros for easy insertion into run-time selection tables.
APIdiffusionCoefficient(const word &name, const scalar a, const scalar b, const scalar wf, const scalar wa)
Construct from name and coefficients.
virtual void write(Ostream &os, const unitSets &units) const
Write the function coefficients.
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
Template function which returns the un-mangled name of a given type. Useful for types which do not ha...
A class for handling words, derived from string.
Definition: word.H:63
volScalarField & b
Definition: createFields.H:27
addScalarFunction2(APIdiffusionCoefficient)
addNamedToRunTimeSelectionTable(scalarFunction2, APIdiffusionCoefficient, dictionary, APIdiffCoef)
const unitSet & lookup(const word &unitName)
Lookup and return the named unit from the table.
Definition: units.C:346
Namespace for OpenFOAM.
void assertNoConvertUnits(const word &typeName, const Function1s::unitSets &units, const dictionary &dict)
Generate an error in an context where unit conversions are not supported.
tmp< DimensionedField< typename outerProduct< Type, Type >::type, GeoMesh, Field >> sqr(const DimensionedField< Type, GeoMesh, PrimitiveField > &df)
void cbrt(LagrangianPatchField< scalar > &f, const LagrangianPatchField< scalar > &f1)
word name(const LagrangianState state)
Return a string representation of a Lagrangian state enumeration.
void sqrt(LagrangianPatchField< scalar > &f, const LagrangianPatchField< scalar > &f1)
void writeEntry(Ostream &os, const word &key, const DimensionedFieldFunction< DimensionedFieldType > &f)
dictionary dict