sphereToFace.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) 2018-2020 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 "sphereToFace.H"
29 #include "polyMesh.H"
31 
32 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
33 
34 namespace Foam
35 {
36  defineTypeNameAndDebug(sphereToFace, 0);
37  addToRunTimeSelectionTable(topoSetSource, sphereToFace, word);
38  addToRunTimeSelectionTable(topoSetSource, sphereToFace, istream);
39  addToRunTimeSelectionTable(topoSetFaceSource, sphereToFace, word);
40  addToRunTimeSelectionTable(topoSetFaceSource, sphereToFace, istream);
42  (
43  topoSetFaceSource,
44  sphereToFace,
45  word,
46  sphere
47  );
49  (
50  topoSetFaceSource,
51  sphereToFace,
52  istream,
53  sphere
54  );
55 }
56 
57 
58 Foam::topoSetSource::addToUsageTable Foam::sphereToFace::usage_
59 (
60  sphereToFace::typeName,
61  "\n Usage: sphereToFace (centreX centreY centreZ) radius\n\n"
62  " Select all faces with faceCentre within bounding sphere\n\n"
63 );
64 
65 
66 // * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
67 
68 void Foam::sphereToFace::combine(topoSet& set, const bool add) const
69 {
70  const pointField& ctrs = mesh_.faceCentres();
71 
72  const scalar orad2 = sqr(radius_);
73  const scalar irad2 = innerRadius_ > 0 ? sqr(innerRadius_) : -1;
74 
75  // Treat innerRadius == 0 like unspecified innerRadius (always accept)
76 
77  forAll(ctrs, elemi)
78  {
79  const scalar d2 = magSqr(ctrs[elemi] - origin_);
80 
81  if ((d2 < orad2) && (d2 > irad2))
82  {
83  addOrDelete(set, elemi, add);
84  }
85  }
86 }
87 
88 
89 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
90 
92 (
93  const polyMesh& mesh,
94  const point& origin,
95  const scalar radius,
96  const scalar innerRadius
97 )
98 :
100  origin_(origin),
101  radius_(radius),
102  innerRadius_(innerRadius)
103 {}
104 
105 
107 (
108  const polyMesh& mesh,
109  const dictionary& dict
110 )
111 :
113  (
114  mesh,
115  dict.getCompat<vector>("origin", {{"centre", -1806}}),
116  dict.getCheck<scalar>("radius", scalarMinMax::ge(0)),
117  dict.getCheckOrDefault<scalar>("innerRadius", 0, scalarMinMax::ge(0))
118  )
119 {}
120 
121 
123 (
124  const polyMesh& mesh,
125  Istream& is
126 )
127 :
129  origin_(checkIs(is)),
130  radius_(readScalar(checkIs(is))),
131  innerRadius_(0)
132 {}
133 
134 
135 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
136 
138 (
139  const topoSetSource::setAction action,
140  topoSet& set
141 ) const
142 {
143  if (action == topoSetSource::ADD || action == topoSetSource::NEW)
144  {
145  if (verbose_)
146  {
147  Info<< " Adding faces within sphere,"
148  << " origin = " << origin_ << ", radius = " << radius_;
149 
150  if (innerRadius_ > 0)
151  {
152  Info<< ", innerRadius = " << innerRadius_;
153  }
154 
155  Info<< endl;
156  }
157 
158  combine(set, true);
159  }
160  else if (action == topoSetSource::SUBTRACT)
161  {
162  if (verbose_)
163  {
164  Info<< " Removing faces within sphere,"
165  << " origin = " << origin_ << ", radius = " << radius_;
166 
167  if (innerRadius_ > 0)
168  {
169  Info<< ", innerRadius = " << innerRadius_;
170  }
171 
172  Info<< endl;
173  }
174 
175  combine(set, false);
176  }
177 }
178 
179 
180 // ************************************************************************* //
Foam::addToRunTimeSelectionTable
addToRunTimeSelectionTable(decompositionMethod, kahipDecomp, dictionary)
Foam::pointField
vectorField pointField
pointField is a vectorField.
Definition: pointFieldFwd.H:44
Foam::sphereToFace
A topoSetFaceSource to select faces based on face centres inside a given bounding sphere.
Definition: sphereToFace.H:155
Foam::topoSetSource::ADD
Add elements to current set.
Definition: topoSetSource.H:103
Foam::BitOps::set
void set(List< bool > &bools, const labelRange &range)
Set the specified range 'on' in a boolList.
Definition: BitOps.C:37
Foam::topoSetSource::addToUsageTable
Class with constructor to add usage string to table.
Definition: topoSetSource.H:129
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:369
Foam::topoSetSource::setAction
setAction
Enumeration defining the valid actions.
Definition: topoSetSource.H:100
Foam::topoSetFaceSource
The topoSetFaceSource is a intermediate class for handling topoSet sources for selecting faces.
Definition: topoSetFaceSource.H:54
Foam::dictionary::getCompat
T getCompat(const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
Definition: dictionaryTemplates.C:134
Foam::topoSetSource::NEW
Create a new set and ADD elements to it.
Definition: topoSetSource.H:104
polyMesh.H
Foam::polyMesh
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:77
forAll
#define forAll(list, i)
Loop across all elements in list.
Definition: stdFoam.H:296
Foam::magSqr
dimensioned< typename typeOfMag< Type >::type > magSqr(const dimensioned< Type > &dt)
sphere
Specialization of rigidBody to construct a sphere given the mass and radius.
Foam::Istream
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:61
Foam::Info
messageStream Info
Information stream (stdout output on master, null elsewhere)
Foam::ListListOps::combine
AccessType combine(const UList< T > &lists, AccessOp aop=accessOp< T >())
Combines sub-lists into a single list.
Definition: ListListOps.C:69
Foam::addNamedToRunTimeSelectionTable
addNamedToRunTimeSelectionTable(topoSetCellSource, badQualityToCell, word, badQuality)
Foam::topoSet
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:63
Foam::dictionary::getCheckOrDefault
T getCheckOrDefault(const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
Definition: dictionaryTemplates.C:209
sphereToFace.H
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::sphereToFace::sphereToFace
sphereToFace(const polyMesh &mesh, const point &origin, const scalar radius, const scalar innerRadius=0)
Construct from components.
Definition: sphereToFace.C:92
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam::add
void add(FieldField< Field1, typename typeOfSum< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
Definition: FieldFieldFunctions.C:939
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:6
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam::topoSetSource::SUBTRACT
Subtract elements from current set.
Definition: topoSetSource.H:105
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::sqr
dimensionedSymmTensor sqr(const dimensionedVector &dv)
Definition: dimensionedSymmTensor.C:51
Foam::MinMax::ge
static MinMax< T > ge(const T &minVal)
A semi-infinite range from minVal to the type max.
Definition: MinMaxI.H:31
Foam::Vector< scalar >
Foam::primitiveMesh::faceCentres
const vectorField & faceCentres() const
Definition: primitiveMeshFaceCentresAndAreas.C:77
Foam::dictionary::getCheck
T getCheck(const word &keyword, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
Definition: dictionaryTemplates.C:120
Foam::topoSetSource::addOrDelete
void addOrDelete(topoSet &set, const label id, const bool add) const
Add or delete id from set. Add when 'add' is true.
Definition: topoSetSource.C:171
Foam::topoSetSource::mesh_
const polyMesh & mesh_
Reference to the mesh.
Definition: topoSetSource.H:156
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)
Foam::sphereToFace::applyToSet
virtual void applyToSet(const topoSetSource::setAction action, topoSet &set) const
Apply specified action to the topoSet.
Definition: sphereToFace.C:138