codedPoints0MotionSolver.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) 2017-2021 OpenCFD Ltd.
9-------------------------------------------------------------------------------
10License
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
29#include "dictionary.H"
30#include "Time.H"
31#include "dynamicCode.H"
33
34// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
35
36namespace Foam
37{
39
41 (
45 );
46}
47
48// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
49
51{
52 return mesh().time().libs();
53}
54
55
57{
58 return "points0MotionSolver " + name();
59}
60
61
63{
64 redirectMotionSolverPtr_.reset(nullptr);
65}
66
67
70{
72}
73
74
76(
77 dynamicCode& dynCode,
78 const dynamicCodeContext& context
79) const
80{
81 // Set additional rewrite rules
82 dynCode.setFilterVariable("typeName", name_);
83
84 // Compile filtered C template
85 dynCode.addCompileFile(codeTemplateC);
86
87 // Copy filtered H template
88 dynCode.addCopyFile(codeTemplateH);
89
90 #ifdef FULLDEBUG
91 dynCode.setFilterVariable("verbose", "true");
93 <<"compile " << name_ << " sha1: " << context.sha1() << endl;
94 #endif
95
96 // Define Make/options
97 dynCode.setMakeOptions
98 (
99 "EXE_INC = -g \\\n"
100 "-I$(LIB_SRC)/finiteVolume/lnInclude \\\n"
101 "-I$(LIB_SRC)/meshTools/lnInclude \\\n"
102 "-I$(LIB_SRC)/dynamicMesh/lnInclude \\\n"
103 "-I$(LIB_SRC)/fvMotionSolvers/lnInclude \\\n"
104 + context.options()
105 + "\n\nLIB_LIBS = \\\n"
106 " -lfiniteVolume \\\n"
107 " -lmeshTools \\\n"
108 " -ldynamicMesh \\\n"
109 " -lfvMotionSolvers \\\n"
110 + context.libs()
111 );
112}
113
114
115// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
116
118(
119 const polyMesh& mesh,
120 const IOdictionary& dict
121)
122:
123 motionSolver(mesh, dict, typeName),
124 codedBase(),
125 name_(dict.getCompat<word>("name", {{"redirectType", 1706}})),
126 redirectMotionSolverPtr_(nullptr)
127{
128 updateLibrary(name_);
129 redirectMotionSolver();
130}
131
132
133// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
134
137{
138 if (!redirectMotionSolverPtr_)
139 {
140 // Get the dictionary for the solver and override the
141 // solver name (in case it is not a subdictionary and contains
142 // the 'coded' as the motionSolver)
143 dictionary constructDict(motionSolver::coeffDict());
144 constructDict.set("solver", name_);
145 constructDict.set("motionSolver", name_);
146
147 IOobject io(*this);
149
150 redirectMotionSolverPtr_ = motionSolver::New
151 (
152 mesh(),
153 IOdictionary(io, constructDict)
154 );
155 }
156
157 return *redirectMotionSolverPtr_;
158}
159
160
162{
163 updateLibrary(name_);
164 return redirectMotionSolver().curPoints();
165}
166
167
169{
170 updateLibrary(name_);
171 redirectMotionSolver().solve();
172}
173
174
176{
177 updateLibrary(name_);
178 return redirectMotionSolver().movePoints(fld);
179}
180
181
183{
184 updateLibrary(name_);
185 return redirectMotionSolver().updateMesh(mpm);
186}
187
188
189// ************************************************************************* //
Macros for easy insertion into run-time selection tables.
#define addToRunTimeSelectionTable(baseType, thisType, argNames)
Add to construction table with typeName as the key.
Info<< nl<< "Wrote faMesh in vtk format: "<< writer.output().name()<< nl;}{ vtk::lineWriter writer(aMesh.points(), aMesh.edges(), fileName(aMesh.mesh().time().globalPath()/"finiteArea-edges"));writer.writeGeometry();writer.beginCellData(4);writer.writeProcIDs();{ Field< scalar > fld(faMeshTools::flattenEdgeField(aMesh.magLe(), true))
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:57
Defines the attributes of an object for which implicit objectRegistry management is supported,...
Definition: IOobject.H:170
readOption readOpt() const noexcept
The read option.
Definition: IOobjectI.H:164
static autoPtr< Time > New()
Construct (dummy) Time - no functionObjects or libraries.
Definition: Time.C:717
dlLibraryTable & libs() const
Mutable access to the loaded dynamic libraries.
Definition: Time.H:510
Base class for function objects and boundary conditions using dynamic code that provides methods for ...
Definition: codedBase.H:67
Provides a general interface to enable dynamic code compilation of mesh motion solvers.
virtual tmp< pointField > curPoints() const
Return point location obtained from the current motion field.
virtual void prepare(dynamicCode &, const dynamicCodeContext &) const
Adapt the context for the current object.
motionSolver & redirectMotionSolver() const
Dynamically compiled motionSolver.
virtual const dictionary & codeDict() const
virtual void clearRedirect() const
Clear redirected object(s)
virtual dlLibraryTable & libs() const
Mutable access to the loaded dynamic libraries.
virtual void solve()
Solve for motion.
virtual string description() const
Description (type + name) for the output.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
entry * set(entry *entryPtr)
Assign a new entry, overwriting any existing entry.
Definition: dictionary.C:780
A table of dynamically loaded libraries.
Encapsulation of dynamic code dictionaries.
const string & libs() const noexcept
The code libs (LIB_LIBS)
const SHA1 & sha1() const noexcept
The SHA1 calculated from options, libs, include, code, etc.
const string & options() const noexcept
The code options (Make/options)
Tools for handling dynamic code compilation.
Definition: dynamicCode.H:60
void addCopyFile(const fileName &name)
Add a file template name, which will be found and filtered.
Definition: dynamicCode.C:359
void setFilterVariable(const word &key, const std::string &value)
Define a filter variable.
Definition: dynamicCode.C:388
void addCompileFile(const fileName &name)
Add a file template name, which will be found and filtered.
Definition: dynamicCode.C:353
void setMakeOptions(const std::string &content)
Define contents for Make/options.
Definition: dynamicCode.C:397
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
Definition: mapPolyMesh.H:162
void movePoints()
Update for new mesh geometry.
void updateMesh()
Update for new mesh topology.
Virtual base class for mesh motion solver.
Definition: motionSolver.H:61
const polyMesh & mesh() const
Return reference to mesh.
Definition: motionSolver.H:144
const dictionary & coeffDict() const
Const access to the coefficients dictionary.
Definition: motionSolver.H:150
const Time & time() const noexcept
Return time registry.
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:81
A class for handling character strings derived from std::string.
Definition: string.H:79
A class for managing temporary objects.
Definition: tmp.H:65
A class for handling words, derived from Foam::string.
Definition: word.H:68
#define defineTypeNameAndDebug(Type, DebugSwitch)
Define the typeName and debug information.
Definition: className.H:121
dynamicFvMesh & mesh
#define DetailInfo
Definition: evalEntry.C:37
IOobject io("surfaceFilmProperties", mesh.time().constant(), mesh, IOobject::READ_IF_PRESENT, IOobject::NO_WRITE, false)
Namespace for OpenFOAM.
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:372
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:59
dictionary dict