initialPointsMethod.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-------------------------------------------------------------------------------
11License
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 "initialPointsMethod.H"
31
32// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
33
34namespace Foam
35{
36defineTypeNameAndDebug(initialPointsMethod, 0);
37defineRunTimeSelectionTable(initialPointsMethod, dictionary);
38}
39
40// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
41
43(
44 const word& type,
45 const dictionary& initialPointsDict,
46 const Time& runTime,
47 Random& rndGen,
48 const conformationSurfaces& geometryToConformTo,
49 const cellShapeControl& cellShapeControls,
50 const autoPtr<backgroundMeshDecomposition>& decomposition
51)
52:
53 dictionary(initialPointsDict),
54 runTime_(runTime),
55 rndGen_(rndGen),
56 geometryToConformTo_(geometryToConformTo),
57 cellShapeControls_(cellShapeControls),
58 decomposition_(decomposition),
59 detailsDict_(optionalSubDict(type + "Coeffs")),
60 minimumSurfaceDistanceCoeffSqr_
61 (
62 sqr
63 (
64 initialPointsDict.get<scalar>("minimumSurfaceDistanceCoeff")
65 )
66 ),
67 fixInitialPoints_(initialPointsDict.get<bool>("fixInitialPoints"))
68{}
69
70
71// * * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * //
72
74(
75 const dictionary& dict,
76 const Time& runTime,
77 Random& rndGen,
78 const conformationSurfaces& geometryToConformTo,
79 const cellShapeControl& cellShapeControls,
80 const autoPtr<backgroundMeshDecomposition>& decomposition
81)
82{
83 const word modelType(dict.get<word>("initialPointsMethod"));
84
85 Info<< nl << "Selecting initialPointsMethod " << modelType << endl;
86
87 auto* ctorPtr = dictionaryConstructorTable(modelType);
88
89 if (!ctorPtr)
90 {
92 (
93 dict,
94 "initialPointsMethod",
95 modelType,
96 *dictionaryConstructorTablePtr_
97 ) << exit(FatalIOError);
98 }
99
100 return
101 autoPtr<initialPointsMethod>
102 (
103 ctorPtr
104 (
105 dict,
106 runTime,
107 rndGen,
111 )
112 );
113}
114
115
116// ************************************************************************* //
Macros for easy insertion into run-time selection tables.
static autoPtr< Time > New()
Construct (dummy) Time - no functionObjects or libraries.
Definition: Time.C:717
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: autoPtr.H:66
T get(const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
Abstract base class for generating initial points for a conformalVoronoiMesh.
const conformationSurfaces & geometryToConformTo() const
const cellShapeControl & cellShapeControls() const
const backgroundMeshDecomposition & decomposition() const
#define defineTypeNameAndDebug(Type, DebugSwitch)
Define the typeName and debug information.
Definition: className.H:121
bool
Definition: EEqn.H:20
engineTime & runTime
#define FatalIOErrorInLookup(ios, lookupTag, lookupName, lookupTable)
Report an error message using Foam::FatalIOError.
Definition: error.H:478
List< ReturnType > get(const UPtrList< T > &list, const AccessOp &aop)
type
Types of root.
Definition: Roots.H:55
Namespace for OpenFOAM.
dimensionedSymmTensor sqr(const dimensionedVector &dv)
messageStream Info
Information stream (stdout output on master, null elsewhere)
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:372
IOerror FatalIOError
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:130
constexpr char nl
The newline '\n' character (0x0a)
Definition: Ostream.H:53
#define defineRunTimeSelectionTable(baseType, argNames)
Define run-time selection table.
dictionary dict
Random rndGen
Definition: createFields.H:23