cylinderToFace.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2017-2019 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 \*---------------------------------------------------------------------------*/
25 
26 #include "cylinderToFace.H"
27 #include "polyMesh.H"
29 
30 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
31 
32 namespace Foam
33 {
34  defineTypeNameAndDebug(cylinderToFace, 0);
35  addToRunTimeSelectionTable(topoSetSource, cylinderToFace, word);
36  addToRunTimeSelectionTable(topoSetSource, cylinderToFace, istream);
37 }
38 
39 
40 Foam::topoSetSource::addToUsageTable Foam::cylinderToFace::usage_
41 (
42  cylinderToFace::typeName,
43  "\n Usage: cylinderToFace (p1X p1Y p1Z) (p2X p2Y p2Z) radius\n\n"
44  " Select all faces with face centre within bounding cylinder\n\n"
45 );
46 
47 
48 // * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
49 
50 void Foam::cylinderToFace::combine(topoSet& set, const bool add) const
51 {
52  const vector axis = p2_ - p1_;
53  const scalar rad2 = sqr(radius_);
54  const scalar magAxis2 = magSqr(axis);
55 
56  const pointField& ctrs = mesh_.faceCentres();
57 
58  forAll(ctrs, facei)
59  {
60  vector d = ctrs[facei] - p1_;
61  scalar magD = d & axis;
62 
63  if ((magD > 0) && (magD < magAxis2))
64  {
65  scalar d2 = (d & d) - sqr(magD)/magAxis2;
66  if (d2 < rad2)
67  {
68  addOrDelete(set, facei, add);
69  }
70  }
71  }
72 }
73 
74 
75 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
76 
78 (
79  const polyMesh& mesh,
80  const vector& p1,
81  const vector& p2,
82  const scalar radius
83 )
84 :
85  topoSetSource(mesh),
86  p1_(p1),
87  p2_(p2),
88  radius_(radius)
89 {}
90 
91 
93 (
94  const polyMesh& mesh,
95  const dictionary& dict
96 )
97 :
98  topoSetSource(mesh),
99  p1_(dict.lookup("p1")),
100  p2_(dict.lookup("p2")),
101  radius_(dict.lookup<scalar>("radius"))
102 {}
103 
104 
106 (
107  const polyMesh& mesh,
108  Istream& is
109 )
110 :
111  topoSetSource(mesh),
112  p1_(checkIs(is)),
113  p2_(checkIs(is)),
114  radius_(readScalar(checkIs(is)))
115 {}
116 
117 
118 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
119 
121 {}
122 
123 
124 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
125 
127 (
128  const topoSetSource::setAction action,
129  topoSet& set
130 ) const
131 {
132  if ((action == topoSetSource::NEW) || (action == topoSetSource::ADD))
133  {
134  Info<< " Adding faces with centre within cylinder, with p1 = "
135  << p1_ << ", p2 = " << p2_ << " and radius = " << radius_ << endl;
136 
137  combine(set, true);
138  }
139  else if (action == topoSetSource::DELETE)
140  {
141  Info<< " Removing faces with centre within cylinder, with p1 = "
142  << p1_ << ", p2 = " << p2_ << " and radius = " << radius_ << endl;
143 
144  combine(set, false);
145  }
146 }
147 
148 
149 // ************************************************************************* //
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:434
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
virtual ~cylinderToFace()
Destructor.
dimensionedSymmTensor sqr(const dimensionedVector &dv)
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:251
Vector< scalar > vector
A scalar version of the templated Vector.
Definition: vector.H:49
AccessType combine(const List< T > &, AccessOp aop=accessOp< T >())
Combines sublists into one big list.
Definition: ListListOps.C:34
Macros for easy insertion into run-time selection tables.
Base class of a source for a topoSet.
Definition: topoSetSource.H:63
vectorField pointField
pointField is a vectorField.
Definition: pointFieldFwd.H:42
setAction
Enumeration defining the valid actions.
Definition: topoSetSource.H:82
bool readScalar(const char *buf, doubleScalar &s)
Read whole of buf as a scalar. Return true if successful.
Definition: doubleScalar.H:75
dimensioned< scalar > magSqr(const dimensioned< Type > &)
addToRunTimeSelectionTable(ensightPart, ensightPartCells, istream)
defineTypeNameAndDebug(combustionModel, 0)
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:61
cylinderToFace(const polyMesh &mesh, const vector &p1, const vector &p2, const scalar radius)
Construct from components.
Class with constructor to add usage string to table.
messageStream Info
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
Namespace for OpenFOAM.
ITstream & lookup(const word &, bool recursive=false, bool patternMatch=true) const
Find and return an entry data stream.
Definition: dictionary.C:812