APIdiffCoef.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-2024 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 
26 #include "APIdiffCoef.H"
28 
29 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
30 
31 namespace Foam
32 {
33 namespace Function2s
34 {
36 }
37 }
38 
39 
40 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
41 
43 (
44  const word& name,
45  const scalar a,
46  const scalar b,
47  const scalar wf,
48  const scalar wa
49 )
50 :
52  a_(a),
53  b_(b),
54  wf_(wf),
55  wa_(wa),
56  alpha_(sqrt(1/wf_ + 1/wa_)),
57  beta_(sqr(cbrt(a_) + cbrt(b_)))
58 {}
59 
60 
62 (
63  const word& name,
64  const unitConversions& units,
65  const dictionary& dict
66 )
67 :
69  a_(dict.lookup<scalar>("a")),
70  b_(dict.lookup<scalar>("b")),
71  wf_(dict.lookup<scalar>("wf")),
72  wa_(dict.lookup<scalar>("wa")),
73  alpha_(sqrt(1/wf_ + 1/wa_)),
74  beta_(sqr((cbrt(a_) + cbrt(b_))))
75 {
76  assertNoConvertUnits(typeName, units, dict);
77 }
78 
79 
80 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
81 
83 (
84  Ostream& os,
85  const unitConversions& units
86 ) const
87 {
88  writeEntry(os, "a", a_);
89  writeEntry(os, "b", b_);
90  writeEntry(os, "wf", wf_);
91  writeEntry(os, "wa", wa_);
92 }
93 
94 
95 // ************************************************************************* //
Macros for easy insertion into run-time selection tables.
virtual void write(Ostream &os, const unitConversions &units) const
Write the function coefficients.
Definition: APIdiffCoef.C:83
APIdiffCoef(const word &name, const scalar a, const scalar b, const scalar wf, const scalar wa)
Construct from components.
Definition: APIdiffCoef.C:43
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
A class for handling words, derived from string.
Definition: word.H:62
volScalarField & b
Definition: createFields.H:25
addScalarFunction2(APIdiffCoef)
Namespace for OpenFOAM.
dimensionedSymmTensor sqr(const dimensionedVector &dv)
word name(const bool)
Return a word representation of a bool.
Definition: boolIO.C:39
const HashTable< unitConversion > & units()
Get the table of unit conversions.
void writeEntry(Ostream &os, const HashTable< T, Key, Hash > &ht)
Definition: HashTableIO.C:96
dimensionedScalar sqrt(const dimensionedScalar &ds)
dimensionedScalar cbrt(const dimensionedScalar &ds)
void assertNoConvertUnits(const word &typeName, const Function1s::unitConversions &units, const dictionary &dict)
Generate an error in an context where unit conversions are not supported.
dictionary dict