dynamicFvMeshNew.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) 2019-2022 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 "staticFvMesh.H"
31 #include "argList.H"
32 
33 // * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * * //
34 
36 {
37  // Note: - do not register the dictionary since dynamicFvMeshes themselves
38  // do this.
39  // - defaultRegion (region0) gets loaded from constant, other ones
40  // get loaded from constant/<regionname>. Normally we'd use
41  // polyMesh::dbDir() but we haven't got a polyMesh yet ...
42  IOobject dictHeader
43  (
44  "dynamicMeshDict",
45  io.time().constant(),
46  polyMesh::regionName(io.name()),
47  io.db(),
51  );
52 
53  if (dictHeader.typeHeaderOk<IOdictionary>(true))
54  {
55  IOdictionary dict(dictHeader);
56 
57  const word modelType(dict.get<word>("dynamicFvMesh"));
58 
59  Info<< "Selecting dynamicFvMesh " << modelType << endl;
60 
61  io.time().libs().open
62  (
63  dict,
64  "dynamicFvMeshLibs",
65  IOobjectConstructorTablePtr_
66  );
67 
68  if (!IOobjectConstructorTablePtr_)
69  {
71  << "dynamicFvMesh table is empty"
72  << exit(FatalError);
73  }
74 
75  auto* doInitCtor = doInitConstructorTable(modelType);
76  if (doInitCtor)
77  {
78  DebugInfo
79  << "Constructing dynamicFvMesh with explicit initialisation"
80  << endl;
81 
82  // Two-step constructor
83  // 1. Construct mesh, do not initialise
84  autoPtr<dynamicFvMesh> meshPtr(doInitCtor(io, false));
85 
86  // 2. Initialise parents and itself
87  meshPtr().init(true);
88 
89  return meshPtr;
90  }
91 
92  auto* ctorPtr = IOobjectConstructorTable(modelType);
93 
94  if (!ctorPtr)
95  {
97  (
98  dict,
99  "dynamicFvMesh",
100  modelType,
101  *IOobjectConstructorTablePtr_
102  ) << exit(FatalIOError);
103  }
104 
105  return autoPtr<dynamicFvMesh>(ctorPtr(io));
106  }
107 
108  DebugInfo
109  << "Constructing staticFvMesh with explicit initialisation" << endl;
110 
111  // 1. Construct mesh, do not initialise
113 
114  // 2. Initialise parents and itself
115  meshPtr().init(true);
116 
117  return meshPtr;
118 }
119 
120 
122 (
123  const argList& args,
124  const Time& runTime
125 )
126 {
127  const IOobject meshIO
128  (
130  runTime.timeName(),
131  runTime,
133  );
134 
135  if (args.dryRun() || args.found("dry-run-write"))
136  {
137  Info
138  << "Operating in 'dry-run' mode: case will run for 1 time step. "
139  << "All checks assumed OK on a clean exit" << endl;
140 
142 
143  // Stop after 1 iteration of the simplified mesh
144 
145  if (args.found("dry-run-write"))
146  {
147  // Using saWriteNow triggers function objects execute(), write()
149  }
150  else
151  {
152  // Using saNoWriteNow triggers function objects execute(),
153  // but not write()
155  }
156 
157  functionObject::outputPrefix = "postProcessing-dry-run";
158 
160  }
161 
162  return New(meshIO);
163 }
164 
165 
166 // ************************************************************************* //
dictionary dict
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:125
error FatalError
Error stream (stdout output on all processes), with additional &#39;FOAM FATAL ERROR&#39; header text and sta...
adjust endTime to stop immediately w/ writing
Definition: Time.H:101
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:598
virtual stopAtControls stopAt() const
Return the stop control information.
Definition: Time.C:801
const word & regionName() const
The mesh region name or word::null if polyMesh::defaultRegion.
Definition: polyMesh.C:847
engineTime & runTime
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:531
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.
Ignore writing from objectRegistry::writeObject()
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:69
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:50
Foam::autoPtr< Foam::dynamicFvMesh > meshPtr
A class for handling words, derived from Foam::string.
Definition: word.H:63
int dryRun() const noexcept
Return the dry-run flag.
Definition: argListI.H:109
static word defaultRegion
Return the default region name.
Definition: polyMesh.H:405
Extract command arguments and options from the supplied argc and argv parameters. ...
Definition: argList.H:118
#define DebugInfo
Report an information message using Foam::Info.
static word timeName(const scalar t, const int precision=precision_)
Return a time name for the given scalar time value formatted with the given precision.
Definition: Time.C:714
Adjust endTime to stop immediately w/o writing.
Definition: Time.H:100
static word outputPrefix
Directory prefix.
static autoPtr< dynamicFvMesh > New(const IOobject &io)
Select, construct and return the dynamicFvMesh.
messageStream Info
Information stream (stdout output on master, null elsewhere)
Pointer management similar to std::unique_ptr, with some additional methods and type checking...
Definition: HashPtrTable.H:48
static autoPtr< dynamicFvMesh > New(const IOobject &io)
Return a reference to the selected simplified mesh.
IOobject io("surfaceFilmProperties", mesh.time().constant(), mesh, IOobject::READ_IF_PRESENT, IOobject::NO_WRITE, IOobject::NO_REGISTER)
Foam::staticFvMesh.
Definition: staticFvMesh.H:47
static bool allowConstructFromLargerSize
Permit read construct from a larger size.
Definition: Field.H:93
Foam::argList args(argc, argv)
Defines the attributes of an object for which implicit objectRegistry management is supported...
Definition: IOobject.H:172
#define FatalIOErrorInLookup(ios, lookupTag, lookupName, lookupTable)
Report an error message using Foam::FatalIOError.
Definition: error.H:635
Do not request registration (bool: false)
bool found(const word &optName) const
Return true if the named option is found.
Definition: argListI.H:171
IOerror FatalIOError
Error stream (stdout output on all processes), with additional &#39;FOAM FATAL IO ERROR&#39; header text and ...