Files
OpenFOAM-6/src/sampling/sampledSet/boundaryRandom/boundaryRandom.H

133 lines
3.5 KiB
C++

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2018 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::sampledSets::boundaryRandom
Description
Random samples within patches
Usage
\table
Property | Description | Req'd? | Default
patches | The patches on which to sample | yes |
nPoints | The number of points | yes |
axis | The coordinate axis that is written | yes |
\endtable
Example specification:
\verbatim
{
type boundaryRandom;
patches (inlet1 inlet2);
nPoints 1000;
axis x;
}
\endverbatim
SourceFiles
boundaryRandom.C
\*---------------------------------------------------------------------------*/
#ifndef boundaryRandom_H
#define boundaryRandom_H
#include "sampledSet.H"
#include "DynamicList.H"
#include "HashSet.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace sampledSets
{
/*---------------------------------------------------------------------------*\
Class boundaryRandom Declaration
\*---------------------------------------------------------------------------*/
class boundaryRandom
:
public sampledSet
{
// Private data
//- Patches to sample
const labelHashSet patches_;
//- Number of points
const label nPoints_;
// Private Member Functions
//- Sample all points
void calcSamples
(
DynamicList<point>& samplingPts,
DynamicList<label>& samplingCells,
DynamicList<label>& samplingFaces,
DynamicList<label>& samplingSegments,
DynamicList<scalar>& samplingCurveDist
) const;
//- Use calcSamples to obtain samples and copy them into *this
void genSamples();
public:
//- Runtime type information
TypeName("boundaryRandom");
// Constructors
//- Construct from dictionary
boundaryRandom
(
const word& name,
const polyMesh& mesh,
const meshSearch& searchEngine,
const dictionary& dict
);
//- Destructor
virtual ~boundaryRandom();
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace sampledSets
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //