faceSelection.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) 2012-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 "faceSelection.H"
30 #include "fvMesh.H"
31 
32 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
33 
34 namespace Foam
35 {
36  defineTypeNameAndDebug(faceSelection, 0);
37  defineRunTimeSelectionTable(faceSelection, dictionary);
38 }
39 
40 
41 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
42 
44 (
45  const word& name,
46  const fvMesh& mesh,
47  const dictionary& dict
48 )
49 :
50  name_(name),
51  mesh_(mesh),
52  dict_(dict),
53  flip_(dict.getOrDefault("flip", false))
54 {}
55 
56 
57 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
58 
60 {}
61 
62 
63 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
64 
66 (
67  const word& name,
68  const fvMesh& mesh,
69  const dictionary& dict
70 )
71 {
72  const word modelType(dict.get<word>("type"));
73 
74  auto* ctorPtr = dictionaryConstructorTable(modelType);
75 
76  if (!ctorPtr)
77  {
79  (
80  dict,
81  "faceSelection",
82  modelType,
83  *dictionaryConstructorTablePtr_
84  ) << exit(FatalIOError);
85  }
86 
87  return autoPtr<faceSelection>(ctorPtr(name, mesh, dict));
88 }
89 
90 
92 (
93  const label zoneID,
94  labelList& faceToZoneID,
95  boolList& faceToFlip
96 ) const
97 {
98  if (flip_)
99  {
100  forAll(faceToZoneID, facei)
101  {
102  if (faceToZoneID[facei] == zoneID)
103  {
104  faceToFlip[facei] = !faceToFlip[facei];
105  }
106  }
107  }
108 }
109 
110 
111 // ************************************************************************* //
dictionary dict
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:125
virtual ~faceSelection()
Destructor.
T get(const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
Find and return a T. FatalIOError if not found, or if the number of tokens is incorrect.
#define forAll(list, i)
Loop across all elements in list.
Definition: stdFoam.H:421
dynamicFvMesh & mesh
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for expressions::valueTypeCode::INVALID.
Definition: exprTraits.C:127
faceSelection(const word &name, const fvMesh &mesh, const dictionary &dict)
Construct from dictionary.
defineRunTimeSelectionTable(reactionRateFlameArea, dictionary)
defineTypeNameAndDebug(combustionModel, 0)
static autoPtr< faceSelection > New(const word &name, const fvMesh &mesh, const dictionary &dict)
Return a reference to the selected faceSelection.
virtual void select(const label, labelList &, boolList &) const =0
Pointer management similar to std::unique_ptr, with some additional methods and type checking...
Definition: HashPtrTable.H:48
List< label > labelList
A List of labels.
Definition: List.H:62
#define FatalIOErrorInLookup(ios, lookupTag, lookupName, lookupTable)
Report an error message using Foam::FatalIOError.
Definition: error.H:645
List< bool > boolList
A List of bools.
Definition: List.H:60
Namespace for OpenFOAM.
IOerror FatalIOError
Error stream (stdout output on all processes), with additional &#39;FOAM FATAL IO ERROR&#39; header text and ...