sphereToCell.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) 2011-2017 OpenFOAM Foundation
9  Copyright (C) 2018-2020 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 "sphereToCell.H"
30 #include "polyMesh.H"
32 
33 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
34 
35 namespace Foam
36 {
37  defineTypeNameAndDebug(sphereToCell, 0);
38  addToRunTimeSelectionTable(topoSetSource, sphereToCell, word);
39  addToRunTimeSelectionTable(topoSetSource, sphereToCell, istream);
40  addToRunTimeSelectionTable(topoSetCellSource, sphereToCell, word);
41  addToRunTimeSelectionTable(topoSetCellSource, sphereToCell, istream);
43  (
44  topoSetCellSource,
45  sphereToCell,
46  word,
47  sphere
48  );
50  (
51  topoSetCellSource,
52  sphereToCell,
53  istream,
54  sphere
55  );
56 }
57 
58 
59 Foam::topoSetSource::addToUsageTable Foam::sphereToCell::usage_
60 (
61  sphereToCell::typeName,
62  "\n Usage: sphereToCell (centreX centreY centreZ) radius\n\n"
63  " Select all cells with cellCentre within bounding sphere\n\n"
64 );
65 
66 
67 // * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
68 
69 void Foam::sphereToCell::combine(topoSet& set, const bool add) const
70 {
71  const pointField& ctrs = mesh_.cellCentres();
72 
73  const scalar orad2 = sqr(radius_);
74  const scalar irad2 = innerRadius_ > 0 ? sqr(innerRadius_) : -1;
75 
76  // Treat innerRadius == 0 like unspecified innerRadius (always accept)
77 
78  forAll(ctrs, elemi)
79  {
80  const scalar d2 = magSqr(ctrs[elemi] - origin_);
81 
82  if ((d2 < orad2) && (d2 > irad2))
83  {
84  addOrDelete(set, elemi, add);
85  }
86  }
87 }
88 
89 
90 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
91 
93 (
94  const polyMesh& mesh,
95  const point& origin,
96  const scalar radius,
97  const scalar innerRadius
98 )
99 :
101  origin_(origin),
102  radius_(radius),
103  innerRadius_(innerRadius)
104 {}
105 
106 
108 (
109  const polyMesh& mesh,
110  const dictionary& dict
111 )
112 :
114  (
115  mesh,
116  dict.getCompat<vector>("origin", {{"centre", -1806}}),
117  dict.getCheck<scalar>("radius", scalarMinMax::ge(0)),
118  dict.getCheckOrDefault<scalar>("innerRadius", 0, scalarMinMax::ge(0))
119  )
120 {}
121 
122 
124 (
125  const polyMesh& mesh,
126  Istream& is
127 )
128 :
130  origin_(checkIs(is)),
131  radius_(readScalar(checkIs(is))),
132  innerRadius_(0)
133 {}
134 
135 
136 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
137 
139 (
140  const topoSetSource::setAction action,
141  topoSet& set
142 ) const
143 {
144  if (action == topoSetSource::ADD || action == topoSetSource::NEW)
145  {
146  if (verbose_)
147  {
148  Info<< " Adding cells within sphere,"
149  << " origin = " << origin_ << ", radius = " << radius_;
150 
151  if (innerRadius_ > 0)
152  {
153  Info<< ", innerRadius = " << innerRadius_;
154  }
155 
156  Info<< endl;
157  }
158 
159  combine(set, true);
160  }
161  else if (action == topoSetSource::SUBTRACT)
162  {
163  if (verbose_)
164  {
165  Info<< " Removing cells within sphere,"
166  << " origin = " << origin_ << ", radius = " << radius_;
167 
168  if (innerRadius_ > 0)
169  {
170  Info<< ", innerRadius = " << innerRadius_;
171  }
172 
173  Info<< endl;
174  }
175 
176  combine(set, false);
177  }
178 }
179 
180 
181 // ************************************************************************* //
Foam::addToRunTimeSelectionTable
addToRunTimeSelectionTable(decompositionMethod, kahipDecomp, dictionary)
Foam::pointField
vectorField pointField
pointField is a vectorField.
Definition: pointFieldFwd.H:44
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::sphereToCell::sphereToCell
sphereToCell(const polyMesh &mesh, const point &origin, const scalar radius, const scalar innerRadius=0)
Construct from components.
Definition: sphereToCell.C:93
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::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::sphereToCell
A topoSetCellSource to select cells based on cell centres inside a given bounding sphere.
Definition: sphereToCell.H:156
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
dict
dictionary dict
Definition: searchingEngine.H:14
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::primitiveMesh::cellCentres
const vectorField & cellCentres() const
Definition: primitiveMeshCellCentresAndVols.C:84
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::sphereToCell::applyToSet
virtual void applyToSet(const topoSetSource::setAction action, topoSet &set) const
Apply specified action to the topoSet.
Definition: sphereToCell.C:139
Foam::topoSetCellSource
The topoSetCellSource is a intermediate class for handling topoSet sources for selecting cells.
Definition: topoSetCellSource.H:54
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
sphereToCell.H
Foam::topoSetSource::mesh_
const polyMesh & mesh_
Reference to the mesh.
Definition: topoSetSource.H:156
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)