normalToFace.H 4.61 KiB
/*---------------------------------------------------------------------------*\
========= |
\\ / 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::normalToFace
Description
A \c topoSetFaceSource to select faces whose surface normal aligned
with a given direction.
Operands:
\table
Operand | Type | Location
output | faceSet | $FOAM_CASE/constant/polyMesh/sets/\<set\>
\endtable
Usage
Minimal example by using \c system/topoSetDict.actions:
\verbatim
{
// Mandatory (inherited) entries
name <name>;
type faceSet;
action <action>;
// Mandatory entries
source normalToFace;
normal (1 0 0);
cos 0.01;
}
\endverbatim
where the entries mean:
\table
Property | Description | Type | Req'd | Dflt
name | Name of faceSet | word | yes | -
type | Type name: faceSet | word | yes | -
action | Action applied on faces - see below | word | yes | -
source | Source name: normalToFace | word | yes | -
normal | The surface normal direction | vector | yes | -
cos | Tolerance angle (range -1, +1), i.e. cosine of angle <!--
--> between the input normal and face normal | scalar | yes | -
\endtable
Options for the \c action entry:
\verbatim
new | Create a new faceSet from selected faces
add | Add selected faces into this faceSet
subtract | Remove selected faces from this faceSet
\endverbatim
See also
- Foam::topoSetSource
- Foam::topoSetFaceSource
SourceFiles
normalToFace.C
\*---------------------------------------------------------------------------*/
#ifndef normalToFace_H
#define normalToFace_H
#include "topoSetFaceSource.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class normalToFace Declaration
\*---------------------------------------------------------------------------*/
class normalToFace
:
public topoSetFaceSource
{
// Private Data
//- Add usage string
static addToUsageTable usage_;
//- The surface normal direction
vector normal_;
//- Tolerance (i.e. cos of angle between normal_ and faceNormal)
const scalar tol_;
// Private Member Functions
//- Normalize normal and check tolerance
void setNormal();
public:
//- Runtime type information
TypeName("normalToFace");
// Constructors
//- Construct from components
normalToFace
(
const polyMesh& mesh,
const vector& normal,
const scalar tol
);
//- Construct from dictionary
normalToFace(const polyMesh& mesh, const dictionary& dict);
//- Construct from Istream
normalToFace(const polyMesh& mesh, Istream&);
//- Destructor
virtual ~normalToFace() = default;
// Member Functions
virtual void applyToSet
(
const topoSetSource::setAction action,
topoSet& set
) const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //