patchExprDriver.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) 2019 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
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 
28 #include "patchExprDriver.H"
29 #include "patchExprScanner.H"
30 #include "error.H"
31 #include "fvPatch.H"
32 #include "fvMesh.H"
33 #include "className.H"
35 
36 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
37 
38 namespace Foam
39 {
40 namespace expressions
41 {
42 namespace patchExpr
43 {
44 
46 
48 (
51  dictionary,
52  patch
53 );
54 
56 (
59  idName,
60  patch
61 );
62 
63 } // End namespace patchExpr
64 } // End namespace expressions
65 } // End namespace Foam
66 
67 
68 // * * * * * * * * * * * * * * * Local Functions * * * * * * * * * * * * * * //
69 
70 namespace Foam
71 {
72  static inline const fvPatch& lookupFvPatch
73  (
74  const fvMesh& mesh,
75  const word& patchName
76  )
77  {
78  return mesh.boundary()[patchName];
79  }
80 
81 } // End namespace Foam
82 
83 
84 // * * * * * * * * * * * * * Static Member Functions * * * * * * * * * * * * //
85 
86 const Foam::fvPatch& Foam::expressions::patchExpr::parseDriver::getFvPatch
87 (
88  const fvMesh& fvm,
89  const dictionary& dict
90 )
91 {
92  return lookupFvPatch
93  (
94  regionMesh(dict, fvm, true),
95  dict.get<word>("patch")
96  );
97 }
98 
99 
100 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
101 
103 :
104  parsing::genericRagelLemonDriver(),
105  expressions::fvExprDriver(),
106  patch_(p)
107 {}
108 
109 
111 (
112  const fvPatch& p,
113  const dictionary& dict
114 )
115 :
118  patch_(p)
119 {}
120 
121 
123 (
124  const fvPatch& p,
125  const parseDriver& driver_
126 )
127 :
129  expressions::fvExprDriver(driver_),
130  patch_(p)
131 {}
132 
133 
135 (
136  const word& patchName,
137  const fvMesh& mesh
138 )
139 :
140  parseDriver(lookupFvPatch(mesh, patchName))
141 {}
142 
143 
145 (
146  const dictionary& dict,
147  const fvMesh& mesh
148 )
149 :
150  parseDriver(getFvPatch(mesh, dict), dict)
151 {}
152 
153 
154 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
155 
157 (
158  const std::string& expr,
159  size_t pos,
160  size_t len
161 )
162 {
163  scanner scan(this->debugScanner());
164 
165  scan.process(expr, pos, len, *this);
166 
167  return 0;
168 }
169 
170 
171 // ************************************************************************* //
patchExprScanner.H
p
volScalarField & p
Definition: createFieldRefs.H:8
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
patchExprDriver.H
Foam::expressions::patchExpr::parseDriver::parse
virtual unsigned parse(const std::string &expr, size_t pos=0, size_t len=std::string::npos)
Execute the parser.
Definition: patchExprDriver.C:157
Foam::expressions::fvExprDriver
Base driver for parsing value expressions associated with an fvMesh.
Definition: fvExprDriver.H:137
Foam::dictionary::get
T get(const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
Definition: dictionaryTemplates.C:81
Foam::lookupFvPatch
static const fvPatch & lookupFvPatch(const fvMesh &mesh, const word &patchName)
Definition: patchExprDriver.C:73
error.H
Foam::parsing::genericRagelLemonDriver
Generic interface code for Ragel/Lemon combination Subclasses should implement one or more process() ...
Definition: genericRagelLemonDriver.H:59
className.H
Macro definitions for declaring ClassName(), NamespaceName(), etc.
Foam::fvPatch
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:65
Foam::expressions::patchExpr::addNamedToRunTimeSelectionTable
addNamedToRunTimeSelectionTable(fvExprDriver, parseDriver, dictionary, patch)
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:6
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:83
fvMesh.H
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::expressions::patchExpr::parseDriver
Driver for patch expressions.
Definition: patchExprDriver.H:140
Foam::fvMesh::boundary
const fvBoundaryMesh & boundary() const
Return reference to boundary mesh.
Definition: fvMesh.C:679
Foam::expressions::exprDriver::dict
const dictionary & dict() const
The dictionary with all input data/specification.
Definition: exprDriver.H:299
Foam::expressions::patchExpr::scanner::process
bool process(const std::string &str, size_t pos, size_t len, parseDriver &driver_)
Evaluate sub-string.
Foam::foamVersion::patch
const std::string patch
OpenFOAM patch number as a std::string.
Foam::expressions::patchExpr::defineTypeNameAndDebug
defineTypeNameAndDebug(parseDriver, 0)
fvPatch.H
Foam::expressions::fvExprDriver::regionMesh
static const fvMesh & regionMesh(const dictionary &dict, const fvMesh &mesh, bool readIfNecessary)
Definition: fvExprDriver.C:534
Foam::expressions::patchExpr::parseDriver::parseDriver
parseDriver(const parseDriver &)=delete
Foam::expressions::patchExpr::scanner
Ragel lexer/scanner interface for patch expressions.
Definition: patchExprScanner.H:68
Foam::pos
dimensionedScalar pos(const dimensionedScalar &ds)
Definition: dimensionedScalar.C:177