Files
OpenFOAM-12/src/dynamicMesh/pointPatchDist/pointPatchDist.H
Henry Weller def4772281 Documentation: Centred the Class Declaration comment
Patch contributed by Institute of Fluid Dynamics,
Helmholtz-Zentrum Dresden - Rossendorf (HZDR)
2020-08-28 13:28:58 +01:00

119 lines
3.0 KiB
C++

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2013-2020 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
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::pointPatchDist
Description
Calculation of distance to nearest patch for all points
SourceFiles
pointPatchDist.C
\*---------------------------------------------------------------------------*/
#ifndef pointPatchDist_H
#define pointPatchDist_H
#include "pointFields.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
class pointMesh;
/*---------------------------------------------------------------------------*\
Class pointPatchDist Declaration
\*---------------------------------------------------------------------------*/
class pointPatchDist
:
public pointScalarField
{
// Private Member Data
//- Reference to pointField
const pointField& points_;
//- Set of patch IDs
const labelHashSet patchIDs_;
//- Number of unset points
label nUnset_;
public:
// Constructors
//- Construct from mesh and set of patches
pointPatchDist
(
const pointMesh& pMesh,
const labelHashSet& patchIDs,
const pointField& points
);
//- Disallow default bitwise copy construction
pointPatchDist(const pointPatchDist&) = delete;
//- Destructor
virtual ~pointPatchDist();
// Member Functions
const pointScalarField& y() const
{
return *this;
}
label nUnset() const
{
return nUnset_;
}
//- Correct for mesh geom/topo changes
void correct();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const pointPatchDist&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //