surfaceCellSizeFunction.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) 2012-2017 OpenFOAM Foundation
9  Copyright (C) 2019-2021 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 
31 
32 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
33 
34 namespace Foam
35 {
36  defineTypeNameAndDebug(surfaceCellSizeFunction, 0);
37  defineRunTimeSelectionTable(surfaceCellSizeFunction, dictionary);
38 }
39 
40 
41 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
42 
43 Foam::surfaceCellSizeFunction::surfaceCellSizeFunction
44 (
45  const word& type,
46  const dictionary& surfaceCellSizeFunctionDict,
47  const searchableSurface& surface,
48  const scalar& defaultCellSize
49 )
50 :
51  dictionary(surfaceCellSizeFunctionDict),
52  surface_(surface),
53  coeffsDict_(optionalSubDict(type + "Coeffs")),
54  defaultCellSize_(defaultCellSize),
55  refinementFactor_
56  (
57  getOrDefault<scalar>("refinementFactor", 1)
58  )
59 {}
60 
61 
62 // * * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * //
63 
65 (
66  const dictionary& dict,
67  const searchableSurface& surface,
68  const scalar& defaultCellSize
69 )
70 {
71  const word modelType(dict.get<word>("surfaceCellSizeFunction"));
72 
73  Info<< indent << "Selecting surfaceCellSizeFunction " << modelType << endl;
74 
75  auto* ctorPtr = dictionaryConstructorTable(modelType);
76 
77  if (!ctorPtr)
78  {
80  (
81  dict,
82  "surfaceCellSizeFunction",
83  modelType,
84  *dictionaryConstructorTablePtr_
85  ) << exit(FatalIOError);
86  }
87 
88  return autoPtr<surfaceCellSizeFunction>
89  (
90  ctorPtr(dict, surface, defaultCellSize)
91  );
92 }
93 
94 
95 // ************************************************************************* //
dictionary dict
type
Types of root.
Definition: Roots.H:52
Ostream & indent(Ostream &os)
Indent stream.
Definition: Ostream.H:493
static autoPtr< surfaceCellSizeFunction > New(const dictionary &surfaceCellSizeFunctionDict, const searchableSurface &surface, const scalar &defaultCellSize)
Return a reference to the selected surfaceCellSizeFunction.
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:125
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:531
T get(const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
Find and return a T. FatalIOError if not found, or if the number of tokens is incorrect.
Macros for easy insertion into run-time selection tables.
const wordList surface
Standard surface field types (scalar, vector, tensor, etc)
defineRunTimeSelectionTable(reactionRateFlameArea, dictionary)
defineTypeNameAndDebug(combustionModel, 0)
messageStream Info
Information stream (stdout output on master, null elsewhere)
#define FatalIOErrorInLookup(ios, lookupTag, lookupName, lookupTable)
Report an error message using Foam::FatalIOError.
Definition: error.H:645
Namespace for OpenFOAM.
IOerror FatalIOError
Error stream (stdout output on all processes), with additional &#39;FOAM FATAL IO ERROR&#39; header text and ...