mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
06ade9515e
- meshTools is the first layer in which coordSet is actually needed STYLE: rename writer implementations in advance of upcoming changes (#2347) - simplifies tracing of code changes (git blame)
172 lines
4.7 KiB
C++
172 lines
4.7 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | www.openfoam.com
|
|
\\/ M anipulation |
|
|
-------------------------------------------------------------------------------
|
|
Copyright (C) 2011 OpenFOAM Foundation
|
|
Copyright (C) 2018-2020 OpenCFD Ltd.
|
|
-------------------------------------------------------------------------------
|
|
License
|
|
This file is part of OpenFOAM.
|
|
|
|
OpenFOAM is free software: you can redistribute it and/or modify it
|
|
under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
Class
|
|
Foam::sphereToCell
|
|
|
|
Description
|
|
A \c topoSetCellSource to select cells based
|
|
on cell centres inside a given bounding sphere.
|
|
|
|
Operands:
|
|
\table
|
|
Operand | Type | Location
|
|
output | cellSet | $FOAM_CASE/constant/polyMesh/sets/\<set\>
|
|
\endtable
|
|
|
|
Usage
|
|
Minimal example by using \c system/topoSetDict.actions:
|
|
\verbatim
|
|
{
|
|
// Mandatory (inherited) entries
|
|
name <name>;
|
|
type cellSet;
|
|
action <action>;
|
|
|
|
// Mandatory entries
|
|
source sphereToCell;
|
|
origin (0 0 0);
|
|
radius 0.5;
|
|
|
|
// Optional entries
|
|
innerRadius 0;
|
|
}
|
|
\endverbatim
|
|
|
|
where the entries mean:
|
|
\table
|
|
Property | Description | Type | Req'd | Dflt
|
|
name | Name of cellSet | word | yes | -
|
|
type | Type name: cellSet | word | yes | -
|
|
action | Action applied on cells - see below | word | yes | -
|
|
source | Source name: sphereToCell | word | yes | -
|
|
origin | The origin (centre) of the sphere | vector | yes | -
|
|
radius | The (outer) radius of sphere | scalar | yes | -
|
|
innerRadius | The inner radius of sphere | scalar | no | 0
|
|
\endtable
|
|
|
|
Options for the \c action entry:
|
|
\verbatim
|
|
new | Create a new cellSet from selected cells
|
|
add | Add selected cells into this cellSet
|
|
subtract | Remove selected cells from this cellSet
|
|
\endverbatim
|
|
|
|
See also
|
|
- Foam::topoSetSource
|
|
- Foam::topoSetCellSource
|
|
|
|
SourceFiles
|
|
sphereToCell.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef sphereToCell_H
|
|
#define sphereToCell_H
|
|
|
|
#include "topoSetCellSource.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class sphereToCell Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class sphereToCell
|
|
:
|
|
public topoSetCellSource
|
|
{
|
|
// Private Data
|
|
|
|
//- Add usage string
|
|
static addToUsageTable usage_;
|
|
|
|
//- Centre point of the sphere
|
|
point origin_;
|
|
|
|
//- The outer radius of the sphere
|
|
scalar radius_;
|
|
|
|
//- The inner radius of the sphere
|
|
scalar innerRadius_;
|
|
|
|
|
|
// Private Member Functions
|
|
|
|
void combine(topoSet& set, const bool add) const;
|
|
|
|
|
|
public:
|
|
|
|
//- Runtime type information
|
|
TypeName("sphereToCell");
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Construct from components
|
|
sphereToCell
|
|
(
|
|
const polyMesh& mesh,
|
|
const point& origin,
|
|
const scalar radius,
|
|
const scalar innerRadius = 0
|
|
);
|
|
|
|
//- Construct from dictionary
|
|
sphereToCell(const polyMesh& mesh, const dictionary& dict);
|
|
|
|
//- Construct from Istream
|
|
sphereToCell(const polyMesh& mesh, Istream& is);
|
|
|
|
|
|
//- Destructor
|
|
virtual ~sphereToCell() = default;
|
|
|
|
|
|
// Member Functions
|
|
|
|
virtual void applyToSet
|
|
(
|
|
const topoSetSource::setAction action,
|
|
topoSet& set
|
|
) const;
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|