ensightVarNameI.H
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-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 "error.H"
29 #include <cctype>
30 
31 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
32 
33 inline Foam::ensight::VarName::VarName(const char* s)
34 :
35  word(s, false)
36 {
37  stripInvalid();
38 }
39 
40 
41 inline Foam::ensight::VarName::VarName(const std::string& s)
42 :
43  word(s, false)
44 {
45  stripInvalid();
46 }
47 
48 
49 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
50 
51 inline bool Foam::ensight::VarName::valid(char c)
52 {
53  return
54  (
55  word::valid(c) // includes space, quotes, /\;{}
56  && c != '!'
57  && c != '#'
58  && c != '%'
59  && c != '('
60  && c != ')'
61  && c != '*'
62  && c != '+'
63  && c != ','
64  && c != '-'
65  && c != '.'
66  && c != '@'
67  && c != '['
68  && c != ']'
69  && c != '^'
70  );
71 }
72 
73 
74 inline void Foam::ensight::VarName::stripInvalid()
75 {
76  string::stripInvalid<VarName>(*this);
77 
78  if (empty())
79  {
80  FatalErrorInFunction
81  << "ensight::VarName empty after stripping" << nl
82  << exit(FatalError);
83  }
84 
85  // Prefix with '_' to avoid starting with leading digits
86  std::string::iterator iter = begin();
87  if (isdigit(*iter))
88  {
89  insert(iter, '_');
90  }
91 }
92 
93 
94 // ************************************************************************* //
insert
srcOptions insert("case", fileName(rootDirSource/caseDirSource))
Foam::ensight::VarName::valid
static bool valid(char c)
Is this character valid for an ensight var-name.
Definition: ensightVarNameI.H:51
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
stdFoam::begin
constexpr auto begin(C &c) -> decltype(c.begin())
Return iterator to the beginning of the container c.
Definition: stdFoam.H:97
s
gmvFile<< "tracers "<< particles.size()<< nl;for(const passiveParticle &p :particles){ gmvFile<< p.position().x()<< " ";}gmvFile<< nl;for(const passiveParticle &p :particles){ gmvFile<< p.position().y()<< " ";}gmvFile<< nl;for(const passiveParticle &p :particles){ gmvFile<< p.position().z()<< " ";}gmvFile<< nl;forAll(lagrangianScalarNames, i){ word name=lagrangianScalarNames[i];IOField< scalar > s(IOobject(name, runTime.timeName(), cloud::prefix, mesh, IOobject::MUST_READ, IOobject::NO_WRITE))
Definition: gmvOutputSpray.H:25
error.H
Foam::ensight::VarName::VarName
VarName(const VarName &)=default
Copy construct.
Foam::FatalError
error FatalError
Foam::word::valid
static bool valid(char c)
Is this character valid for a word?
Definition: wordI.H:59
Foam::exit
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:130
Foam::ensight::VarName::stripInvalid
void stripInvalid()
Strip invalid characters.
Definition: ensightVarNameI.H:74
FatalErrorInFunction
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:453
Foam::nl
constexpr char nl
Definition: Ostream.H:404
Foam::constant::universal::c
const dimensionedScalar c
Speed of light in a vacuum.