Loading...
Searching...
No Matches
cylinderAnnulusToFace.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) 2017 OpenFOAM Foundation
9 Copyright (C) 2018-2022 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
30#include "polyMesh.H"
33// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
34
35namespace Foam
36{
41 (
44 word
45 );
47 (
51 );
53 (
56 word,
57 cylinderAnnulus
58 );
60 (
63 istream,
64 cylinderAnnulus
65 );
66}
67
68
69Foam::topoSetSource::addToUsageTable Foam::cylinderAnnulusToFace::usage_
70(
71 cylinderAnnulusToFace::typeName,
72 "\n Usage: cylinderAnnulusToFace (p1X p1Y p1Z) (p2X p2Y p2Z)"
73 " radius innerRadius\n\n"
74 " Select faces with centres within bounding cylinder annulus\n\n"
75);
76
77
78// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
79
81(
82 const polyMesh& mesh,
83 const point& point1,
84 const point& point2,
85 const scalar radius,
86 const scalar innerRadius
87)
88:
89 cylinderToFace(mesh, point1, point2, radius, innerRadius)
90{}
91
92
94(
95 const polyMesh& mesh,
104(
105 const polyMesh& mesh,
106 Istream& is
107)
108:
109 cylinderToFace(mesh, is, true) // mandatoryInnerRadius = true
110{}
111
112
113// ************************************************************************* //
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
A topoSetFaceSource to select all faces with centres inside a given bounding cylinder annulus.
cylinderAnnulusToFace(const polyMesh &mesh, const point &point1, const point &point2, const scalar radius, const scalar innerRadius=0)
Construct from components.
A topoSetFaceSource to select all faces whose face centre inside a given bounding cylinder or cylinde...
cylinderToFace(const polyMesh &mesh, Istream &is, const bool mandatoryInnerRadius)
Construct from Istream with mandatory inner radius.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition dictionary.H:133
Mesh consisting of general polyhedral cells.
Definition polyMesh.H:79
The topoSetFaceSource is a intermediate class for handling topoSet sources for selecting faces.
Class with constructor to add usage string to table.
Base class of a source for a topoSet.
const polyMesh & mesh() const noexcept
Reference to the mesh.
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.
vector point
Point is a vector.
Definition point.H:37
dictionary dict