Loading...
Searching...
No Matches
solidBodyMotionFunctionNew.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-2016 OpenFOAM Foundation
9 Copyright (C) 2019-2024 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
30
31// * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * * //
32
35(
36 const word& motionType,
37 const dictionary& dict,
38 const Time& runTime
39)
40{
41 if (motionType.empty())
42 {
43 return nullptr;
44 }
45
46 auto* ctorPtr = dictionaryConstructorTable(motionType);
47
48 if (!ctorPtr)
49 {
51 (
52 dict,
53 "solidBodyMotionFunction",
54 motionType,
55 *dictionaryConstructorTablePtr_
56 ) << exit(FatalIOError);
57 }
58
59 Info<< "Selecting solid-body motion function " << motionType << endl;
60
62}
63
64
67(
68 const dictionary& dict,
69 const Time& runTime
70)
71{
72 return New
73 (
74 dict.get<word>("solidBodyMotionFunction", keyType::LITERAL),
77 );
78}
79
80
83(
84 const dictionary& dict,
85 const Time& runTime
86)
87{
88 word motionType;
89 dict.readIfPresent("solidBodyMotionFunction", motionType, keyType::LITERAL);
90
91 if (motionType.empty())
92 {
93 return nullptr;
94 }
95
96 return New(motionType, dict, runTime);
97}
98
99
100// ************************************************************************* //
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition Time.H:75
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition autoPtr.H:65
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition dictionary.H:133
@ LITERAL
String literal.
Definition keyType.H:82
static autoPtr< solidBodyMotionFunction > New(const word &motionType, const dictionary &dict, const Time &runTime)
Construct and dispatch motionType with dictionary and Time.
static autoPtr< solidBodyMotionFunction > NewIfPresent(const dictionary &dict, const Time &runTime)
Select "solidBodyMotionFunction" type (if present) from dictionary and create with Time.
A class for handling words, derived from Foam::string.
Definition word.H:66
engineTime & runTime
#define FatalIOErrorInLookup(ios, lookupTag, lookupName, lookupTable)
Report an error message using Foam::FatalIOError.
Definition error.H:637
tmp< DimensionedField< TypeR, GeoMesh > > New(const tmp< DimensionedField< TypeR, GeoMesh > > &tf1, const word &name, const dimensionSet &dimensions, const bool initCopy=false)
Global function forwards to reuseTmpDimensionedField::New.
messageStream Info
Information stream (stdout output on master, null elsewhere).
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition Ostream.H:519
IOerror FatalIOError
Error stream (stdout output on all processes), with additional 'FOAM FATAL IO ERROR' header text and ...
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition errorManip.H:125
dictionary dict