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