extrudeModel.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2017 OpenFOAM Foundation
9  Copyright (C) 2020 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 \*---------------------------------------------------------------------------*/
28 
29 #include "extrudeModel.H"
30 
31 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
35  defineTypeNameAndDebug(extrudeModel, 0);
36  defineRunTimeSelectionTable(extrudeModel, dictionary);
37 }
38 
39 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
40 
42 (
43  const word& modelType,
44  const dictionary& dict
45 )
46 :
47  nLayers_(dict.getOrDefault<label>("nLayers", 1)),
48  expansionRatio_(dict.getOrDefault<scalar>("expansionRatio", 1)),
49  coeffDict_(dict.optionalSubDict(modelType + "Coeffs"))
50 {
51  DebugInfo
52  << "Selected extrudeModel for " << modelType
53  << " using coeffs " << coeffDict_ << nl;
54 }
55 
56 
57 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
58 
59 Foam::label Foam::extrudeModel::nLayers() const
60 {
61  return nLayers_;
62 }
63 
64 
66 {
67  return expansionRatio_;
68 }
69 
70 
71 Foam::scalar Foam::extrudeModel::sumThickness(const label layer) const
72 {
73  // 1+r+r^2+ .. +r^(n-1) = (1-r^n)/(1-r)
74 
75  if (mag(1.0-expansionRatio_) < SMALL)
76  {
77  return scalar(layer)/nLayers_;
78  }
79  else
80  {
81  return
82  (1.0-pow(expansionRatio_, layer))
83  / (1.0-pow(expansionRatio_, nLayers_));
84  }
85 }
86 
87 
88 // ************************************************************************* //
Foam::extrudeModel::sumThickness
scalar sumThickness(const label layer) const
Helper: calculate cumulative relative thickness for layer.
Definition: extrudeModel.C:71
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::defineRunTimeSelectionTable
defineRunTimeSelectionTable(reactionRateFlameArea, dictionary)
Foam::extrudeModel::nLayers
label nLayers() const
Return the number of layers.
Definition: extrudeModel.C:59
extrudeModel.H
Foam::extrudeModel::extrudeModel
extrudeModel(const extrudeModel &)=delete
No copy construct.
Foam::pow
dimensionedScalar pow(const dimensionedScalar &ds, const dimensionedScalar &expt)
Definition: dimensionedScalar.C:75
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::extrudeModel::nLayers_
label nLayers_
Definition: extrudeModel.H:82
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::extrudeModel::expansionRatio
scalar expansionRatio() const
Return the expansion ratio.
Definition: extrudeModel.C:65
DebugInfo
#define DebugInfo
Report an information message using Foam::Info.
Definition: messageStream.H:382
Foam::nl
constexpr char nl
Definition: Ostream.H:404
Foam::mag
dimensioned< typename typeOfMag< Type >::type > mag(const dimensioned< Type > &dt)
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)