Loading...
Searching...
No Matches
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-------------------------------------------------------------------------------
11License
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"
33// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
35namespace Foam
36{
43 (
46 word,
47 sphere
48 );
50 (
53 istream,
54 sphere
55 );
56}
57
58
59Foam::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
69void Foam::sphereToCell::combine(topoSet& set, const bool add) const
70{
71 const tmp<pointField> tctrs(this->transform(mesh_.cellCentres()));
72 const pointField& ctrs = tctrs();
73
74 const scalar orad2 = sqr(radius_);
75 const scalar irad2 = innerRadius_ > 0 ? sqr(innerRadius_) : -1;
76
77 // Treat innerRadius == 0 like unspecified innerRadius (always accept)
78
79 forAll(ctrs, elemi)
80 {
81 const scalar d2 = magSqr(ctrs[elemi] - origin_);
82
83 if ((d2 < orad2) && (d2 > irad2))
84 {
85 addOrDelete(set, elemi, add);
86 }
87 }
88}
89
90
91// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
92
94(
95 const polyMesh& mesh,
96 const point& origin,
97 const scalar radius,
98 const scalar innerRadius
99)
100:
102 origin_(origin),
103 radius_(radius),
104 innerRadius_(innerRadius)
105{}
106
107
109(
110 const polyMesh& mesh,
111 const dictionary& dict
112)
113:
115 origin_(dict.getCompat<vector>("origin", {{"centre", -1806}})),
116 radius_(dict.getCheck<scalar>("radius", scalarMinMax::ge(0))),
117 innerRadius_
118 (
119 dict.getCheckOrDefault<scalar>("innerRadius", 0, scalarMinMax::ge(0))
120 )
121{}
122
123
125(
126 const polyMesh& mesh,
127 Istream& is
128)
129:
131 origin_(checkIs(is)),
132 radius_(readScalar(checkIs(is))),
133 innerRadius_(0)
134{}
135
136
137// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
138
140(
141 const topoSetSource::setAction action,
142 topoSet& set
143) const
144{
145 if (action == topoSetSource::ADD || action == topoSetSource::NEW)
146 {
147 if (verbose_)
148 {
149 Info<< " Adding cells within sphere,"
150 << " origin = " << origin_ << ", radius = " << radius_;
151
152 if (innerRadius_ > 0)
153 {
154 Info<< ", innerRadius = " << innerRadius_;
155 }
156
157 Info<< endl;
158 }
159
160 combine(set, true);
161 }
162 else if (action == topoSetSource::SUBTRACT)
163 {
164 if (verbose_)
165 {
166 Info<< " Removing cells within sphere,"
167 << " origin = " << origin_ << ", radius = " << radius_;
168
169 if (innerRadius_ > 0)
170 {
171 Info<< ", innerRadius = " << innerRadius_;
172 }
173
174 Info<< endl;
175 }
176
177 combine(set, false);
178 }
179}
180
181
182// ************************************************************************* //
Macros for easy insertion into run-time selection tables.
#define addNamedToRunTimeSelectionTable(baseType, thisType, argNames, lookupName)
Add to construction table with 'lookupName' as the key.
#define addToRunTimeSelectionTable(baseType, thisType, argNames)
Add to construction table with typeName as the key.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition Istream.H:60
static MinMax< scalar > ge(const scalar &minVal)
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition dictionary.H:133
T getCheck(const word &keyword, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
Find and return a T with additional checking FatalIOError if not found, or if the number of tokens is...
Mesh consisting of general polyhedral cells.
Definition polyMesh.H:79
const vectorField & cellCentres() const
A topoSetCellSource to select cells based on cell centres inside a given bounding sphere.
sphereToCell(const polyMesh &mesh, const point &origin, const scalar radius, const scalar innerRadius=0)
Construct from components.
virtual void applyToSet(const topoSetSource::setAction action, topoSet &set) const
Apply specified action to the topoSet.
Specialization of rigidBody to construct a sphere given the mass and radius.
The topoSetCellSource is a intermediate class for handling topoSet sources for selecting cells.
topoSetCellSource(const polyMesh &mesh)
Construct from mesh.
Class with constructor to add usage string to table.
Base class of a source for a topoSet.
void addOrDelete(topoSet &set, const label id, const bool add) const
Add or delete id from set. Add when 'add' is true.
setAction
Enumeration defining various actions.
@ SUBTRACT
Subtract elements from current set.
@ ADD
Add elements to current set.
@ NEW
Create a new set and ADD elements to it.
bool verbose_
Output verbosity (default: true).
const polyMesh & mesh() const noexcept
Reference to the mesh.
const polyMesh & mesh_
Reference to the mesh.
static Istream & checkIs(Istream &is)
Check state of stream.
General set of labels of mesh quantity (points, cells, faces).
Definition topoSet.H:63
A class for handling words, derived from Foam::string.
Definition word.H:66
#define defineTypeNameAndDebug(Type, DebugSwitch)
Define the typeName and debug information.
Definition className.H:142
dynamicFvMesh & mesh
Namespace for OpenFOAM.
dimensionedSymmTensor sqr(const dimensionedVector &dv)
refinementData transform(const tensor &, const refinementData val)
No-op rotational transform for base types.
messageStream Info
Information stream (stdout output on master, null elsewhere).
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition Ostream.H:519
vector point
Point is a vector.
Definition point.H:37
vectorField pointField
pointField is a vectorField.
Vector< scalar > vector
Definition vector.H:57
dimensioned< typename typeOfMag< Type >::type > magSqr(const dimensioned< Type > &dt)
dict add("bounds", meshBb)
dictionary dict
#define forAll(list, i)
Loop across all elements in list.
Definition stdFoam.H:299