blockVertex.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) 2016 OpenFOAM Foundation
9  Copyright (C) 2019-2021 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 "blockVertex.H"
30 #include "pointVertex.H"
31 #include "blockMeshTools.H"
32 
33 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
34 
35 namespace Foam
36 {
37  defineTypeNameAndDebug(blockVertex, 0);
38  defineRunTimeSelectionTable(blockVertex, Istream);
39 }
40 
41 
42 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
43 
45 {
47  return nullptr;
48 }
49 
50 
52 (
53  const dictionary& dict,
54  const label index,
55  const searchableSurfaces& geometry,
56  Istream& is
57 )
58 {
59  DebugInFunction << "Constructing blockVertex" << endl;
60 
61  token firstToken(is);
62 
63  if (firstToken.isPunctuation(token::BEGIN_LIST))
64  {
65  // Putback the opening bracket
66  is.putBack(firstToken);
67 
69  (
70  new blockVertices::pointVertex(dict, index, geometry, is)
71  );
72  }
73  else if (firstToken.isWord())
74  {
75  const word faceType(firstToken.wordToken());
76 
77  auto* ctorPtr = IstreamConstructorTable(faceType);
78 
79  if (!ctorPtr)
80  {
82  (
83  dict,
84  "blockVertex",
85  faceType,
86  *IstreamConstructorTablePtr_
87  ) << abort(FatalIOError);
88  }
89 
90  return autoPtr<blockVertex>(ctorPtr(dict, index, geometry, is));
91  }
92 
94  << "incorrect first token, expected <word> or '(', found "
95  << firstToken.info() << nl
96  << exit(FatalIOError);
97 
98  return nullptr;
99 }
100 
101 
102 Foam::label Foam::blockVertex::read
103 (
104  Istream& is,
105  const dictionary& dict
106 )
107 {
108  const dictionary* varDictPtr = dict.findDict("namedVertices");
109  if (varDictPtr)
110  {
111  return blockMeshTools::read(is, *varDictPtr);
112  }
113  return readLabel(is);
114 }
115 
116 
118 (
119  Ostream& os,
120  const label val,
121  const dictionary& d
122 )
123 {
124  const dictionary* varDictPtr = d.findDict("namedVertices");
125  if (varDictPtr)
126  {
127  blockMeshTools::write(os, val, *varDictPtr);
128  }
129  else
130  {
131  os << val;
132  }
133 }
134 
135 
136 // ************************************************************************* //
Foam::dictionary::findDict
dictionary * findDict(const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
Find and return a sub-dictionary pointer if present.
Definition: dictionaryI.H:127
Foam::blockMeshTools::write
void write(Ostream &, const label val, const dictionary &)
Write with dictionary lookup.
Definition: blockMeshTools.C:112
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::blockVertex::New
static autoPtr< blockVertex > New(const dictionary &dict, const label index, const searchableSurfaces &geometry, Istream &)
New function which constructs and returns pointer to a blockVertex.
Definition: blockVertex.C:52
pointVertex.H
Foam::defineRunTimeSelectionTable
defineRunTimeSelectionTable(reactionRateFlameArea, dictionary)
Foam::FatalIOError
IOerror FatalIOError
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:369
Foam::token
A token holds an item read from Istream.
Definition: token.H:68
Foam::token::isWord
bool isWord() const noexcept
Token is word-variant (WORD, DIRECTIVE)
Definition: tokenI.H:609
Foam::blockMeshTools::read
void read(Istream &, label &val, const dictionary &)
In-place read with dictionary lookup.
Definition: blockMeshTools.C:57
NotImplemented
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:517
FatalIOErrorInLookup
#define FatalIOErrorInLookup(ios, lookupTag, lookupName, lookupTable)
Report an error message using Foam::FatalIOError.
Definition: error.H:478
Foam::token::info
InfoProxy< token > info() const
Return info proxy for printing token information to a stream.
Definition: token.H:586
Foam::Istream
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:61
DebugInFunction
#define DebugInFunction
Report an information message using Foam::Info.
Definition: messageStream.H:388
Foam::token::isPunctuation
bool isPunctuation() const noexcept
Token is PUNCTUATION.
Definition: tokenI.H:459
dict
dictionary dict
Definition: searchingEngine.H:14
blockVertex.H
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
os
OBJstream os(runTime.globalPath()/outputName)
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::abort
errorManip< error > abort(error &err)
Definition: errorManip.H:144
Foam::token::wordToken
const word & wordToken() const
Return const reference to the word contents.
Definition: tokenI.H:631
Foam::blockVertex::read
static label read(Istream &, const dictionary &)
Read vertex index with optional name lookup.
Definition: blockVertex.C:103
Foam::exit
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:130
Foam::autoPtr< Foam::blockVertex >
blockMeshTools.H
Foam::nl
constexpr char nl
Definition: Ostream.H:404
Foam::readLabel
label readLabel(const char *buf)
Parse entire buffer as a label, skipping leading/trailing whitespace.
Definition: label.H:66
Foam::Istream::putBack
void putBack(const token &tok)
Put back a token. Only a single put back is permitted.
Definition: Istream.C:70
Foam::searchableSurfaces
Container for searchableSurfaces. The collection is specified as a dictionary. For example,...
Definition: searchableSurfaces.H:92
FatalIOErrorInFunction
#define FatalIOErrorInFunction(ios)
Report an error message using Foam::FatalIOError.
Definition: error.H:473
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
Foam::blockVertex::write
static void write(Ostream &, const label, const dictionary &)
Write vertex index with optional name backsubstitution.
Definition: blockVertex.C:118
Foam::token::BEGIN_LIST
Begin list [isseparator].
Definition: token.H:155
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)
Foam::blockVertices::pointVertex
Definition: pointVertex.H:52
Foam::blockVertex::clone
virtual autoPtr< blockVertex > clone() const
Clone function.
Definition: blockVertex.C:44