A sampler type which provides a uniform distribution of nPoints sample locations along a straight line specified between a given start and an end points. More...

Inheritance diagram for uniformSet:

[legend]

Collaboration diagram for uniformSet:

[legend]

Public Member Functions
	TypeName ("uniform")

	uniformSet (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const word &axis, const point &start, const point &end, const label nPoints)

	uniformSet (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict)

virtual	~uniformSet ()=default

Public Member Functions inherited from sampledSet
	TypeName ("sampledSet")

	declareRunTimeSelectionTable (autoPtr, sampledSet, word,(const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict),(name, mesh, searchEngine, dict))

	sampledSet (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const coordSet::coordFormat axisType)

	sampledSet (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const word &axis)

	sampledSet (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict)

autoPtr< sampledSet >	clone () const

virtual	~sampledSet ()=default

const polyMesh &	mesh () const

const meshSearch &	searchEngine () const

const labelList &	segments () const

const labelList &	cells () const

const labelList &	faces () const

Ostream &	write (Ostream &) const

autoPtr< coordSet >	gather (labelList &indexSet, labelList &allSegments) const

Public Member Functions inherited from coordSet
	coordSet (const word &name, const coordFormat axisType)

	coordSet (const word &name, const word &axis)

	coordSet (const word &name, const word &axis, const List< point > &points, const scalarList &curveDist)

	coordSet (const word &name, const word &axis, List< point > &&points, scalarList &&curveDist)

const word &	name () const

word	axis () const

void	setPoints (const List< point > &newPoints)

void	setPoints (List< point > &&newPoints)

const scalarList &	curveDist () const

void	setCurveDist (const scalarList &curveDist)

void	setCurveDist (scalarList &&curveDist)

bool	hasVectorAxis () const

scalar	scalarCoord (const label index) const

vector	vectorCoord (const label index) const

Ostream &	write (Ostream &os) const

Public Member Functions inherited from Field
constexpr	Field () noexcept

	Field (const label len)

	Field (const label len, const Type &val)

	Field (const label len, const Foam::zero)

	Field (const Foam::one, const Type &val)

	Field (const Foam::one, Type &&val)

	Field (const Foam::one, const Foam::zero)

	Field (const Field< Type > &fld)

	Field (const UList< Type > &list)

template<class Addr >
	Field (const IndirectListBase< Type, Addr > &list)

	Field (Field< Type > &&fld)

	Field (List< Type > &&list)

template<int SizeMin>
	Field (DynamicList< Type, SizeMin > &&list)

	Field (const UList< Type > &mapF, const labelUList &mapAddressing)

	Field (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)

	Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)

	Field (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)

	Field (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)

	Field (const UList< Type > &mapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)

	Field (const UList< Type > &mapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)

	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const bool applyFlip=true)

	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)

	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)

	Field (Field< Type > &fld, bool reuse)

	Field (const tmp< Field< Type >> &tfld)

	Field (Istream &is)

	Field (const word &keyword, const dictionary &dict, const label len)

tmp< Field< Type > >	clone () const

void	map (const UList< Type > &mapF, const labelUList &mapAddressing)

void	map (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)

void	map (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)

void	map (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)

void	map (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)

void	map (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const bool applyFlip=true)

void	autoMap (const FieldMapper &map, const bool applyFlip=true)

void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing)

void	rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)

void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)

void	rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)

void	negate ()

tmp< Field< cmptType > >	component (const direction) const

void	replace (const direction, const UList< cmptType > &)

void	replace (const direction, const tmp< Field< cmptType >> &)

void	replace (const direction, const cmptType &)

template<class VSForm >
VSForm	block (const label start) const

tmp< Field< Type > >	T () const

void	writeEntry (const word &keyword, Ostream &os) const

SubField< Type >	slice (const label pos, label len=-1)

const SubField< Type >	slice (const label pos, label len=-1) const

SubField< Type >	slice (const labelRange &range)

const SubField< Type >	slice (const labelRange &range) const

void	operator= (const Field< Type > &)

void	operator= (const tmp< Field< Type >> &)

void	operator= (const UList< Type > &rhs)

void	operator= (const SubField< Type > &rhs)

template<class Addr >
void	operator= (const IndirectListBase< Type, Addr > &rhs)

void	operator= (Field< Type > &&rhs)

void	operator= (List< Type > &&rhs)

template<int SizeMin>
void	operator= (DynamicList< Type, SizeMin > &&rhs)

void	operator= (const Type &val)

void	operator= (const Foam::zero)

template<class Form , class Cmpt , direction nCmpt>
void	operator= (const VectorSpace< Form, Cmpt, nCmpt > &)

void	operator+= (const UList< Type > &)

void	operator+= (const tmp< Field< Type >> &)

void	operator-= (const UList< Type > &)

void	operator-= (const tmp< Field< Type >> &)

void	operator*= (const UList< scalar > &)

void	operator*= (const tmp< Field< scalar >> &)

void	operator/= (const UList< scalar > &)

void	operator/= (const tmp< Field< scalar >> &)

void	operator+= (const Type &)

void	operator-= (const Type &)

void	operator*= (const scalar &)

void	operator/= (const scalar &)

template<class Type >
	Field (const UList< Type > &mapF, const labelUList &mapAddressing)

template<class Type >
	Field (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)

template<class Type >
	Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &mapWeights)

template<class Type >
	Field (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &mapWeights)

template<class Type >
	Field (const UList< Type > &mapF, const FieldMapper &mapper, const bool applyFlip)

template<class Type >
	Field (const UList< Type > &mapF, const FieldMapper &mapper, const Type &defaultValue, const bool applyFlip)

template<class Type >
	Field (const UList< Type > &mapF, const FieldMapper &mapper, const UList< Type > &defaultValues, const bool applyFlip)

template<class Type >
	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &mapper, const bool applyFlip)

template<class Type >
	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &mapper, const Type &defaultValue, const bool applyFlip)

template<class Type >
	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &mapper, const UList< Type > &defaultValues, const bool applyFlip)

template<class Type >
	Field (const word &keyword, const dictionary &dict, const label len)

template<class Type >
void	operator= (const Field< Type > &rhs)

template<class Type >
void	operator= (const tmp< Field > &rhs)

template<class Type >
constexpr	Field () noexcept

template<class Type >
	Field (const label len)

template<class Type >
	Field (const label len, const Type &val)

template<class Type >
	Field (const label len, const Foam::zero)

template<class Type >
	Field (const Foam::one, const Type &val)

template<class Type >
	Field (const Foam::one, Type &&val)

template<class Type >
	Field (const Foam::one, const Foam::zero)

template<class Type >
	Field (const Field< Type > &fld)

template<class Type >
	Field (const UList< Type > &list)

template<class Type >
	Field (Field< Type > &&fld)

template<class Type >
	Field (List< Type > &&list)

template<class Type >
	Field (Field< Type > &fld, bool reuse)

template<class Type >
	Field (const tmp< Field< Type >> &tfld)

template<class Type >
	Field (Istream &is)

template<class Type >
void	operator= (const UList< Type > &rhs)

template<class Type >
void	operator= (const SubField< Type > &rhs)

template<class Type >
void	operator= (Field< Type > &&rhs)

template<class Type >
void	operator= (List< Type > &&rhs)

template<class Type >
void	operator= (const Type &val)

template<class Type >
void	operator= (const Foam::zero)

Additional Inherited Members
Public Types inherited from coordSet
enum	coordFormat { XYZ, X, Y, Z, DISTANCE }

Public Types inherited from Field
typedef pTraits< Type >::cmptType	cmptType

typedef SubField< Type >	subField

Static Public Member Functions inherited from sampledSet
static autoPtr< sampledSet >	New (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict)

Static Public Member Functions inherited from Field
static const Field< Type > &	null ()

static autoPtr< Field< Type > >	New (Istream &is)

template<class Type2 >
static tmp< Field< Type > >	NewCalculatedType (const Field< Type2 > &f)

Static Public Attributes inherited from coordSet
static const Enum< coordFormat >	coordFormatNames

Protected Member Functions inherited from sampledSet
void	checkDimensions () const

label	getBoundaryCell (const label) const

label	getNeighbourCell (const label) const

label	pointInCell (const point &p, const label samplei) const

scalar	calcSign (const label facei, const point &sample) const

label	findNearFace (const label celli, const point &sample, const scalar smallDist) const

point	pushIn (const point &sample, const label facei) const

bool	getTrackingPoint (const point &samplePt, const point &bPoint, const label bFacei, const scalar smallDist, point &trackPt, label &trackCelli, label &trackFacei) const

void	setSamples (const List< point > &samplingPts, const labelList &samplingCells, const labelList &samplingFaces, const labelList &samplingSegments, const scalarList &samplingCurveDist)

void	setSamples (List< point > &&samplingPts, labelList &&samplingCells, labelList &&samplingFaces, labelList &&samplingSegments, scalarList &&samplingCurveDist)

Protected Attributes inherited from sampledSet
labelList	segments_

labelList	cells_

labelList	faces_

Protected Attributes inherited from coordSet
const word	name_

const coordFormat	axis_

scalarList	curveDist_

Detailed Description

A sampler type which provides a uniform distribution of nPoints sample locations along a straight line specified between a given start and an end points.

Usage

Example specification:

sets
(
    <set>
    {
        // Mandatory entries
        type        uniform;
        axis        <options>;
        start       <vector>;
        end         <vector>;
        nPoints     <label>;

        // Optional entries
        tol         <scalar>;
    }

);

where the entries mean:

Property	Description	Type	Reqd	Deflt
`type`	Type name: uniform	word	yes	-
`axis`	Output type of sample locations	word	yes	-
`start`	Start point of sample line	vector	yes	-
`end`	End point of sample line	vector	yes	-
`nPoints`	Number of points between start/end	label	yes	-
`tol`	Relative tolerance	scalar	no	1e-3

Options for the axis entry:

      x        | x-ordinate of a sample
      y        | y-ordinate of a sample
      z        | z-ordinate of a sample
      xyz      | x-y-z coordinates of a sample
      distance | Normal distance to the first point of a sample

Source files

Definition at line 134 of file uniformSet.H.

Constructor & Destructor Documentation

◆ uniformSet() [1/2]

uniformSet	(	const word &	name,
		const polyMesh &	mesh,
		const meshSearch &	searchEngine,
		const word &	axis,
		const point &	start,
		const point &	end,
		const label	nPoints
	)

Definition at line 410 of file uniformSet.C.

◆ uniformSet() [2/2]

uniformSet	(	const word &	name,
		const polyMesh &	mesh,
		const meshSearch &	searchEngine,
		const dictionary &	dict
	)

Definition at line 431 of file uniformSet.C.

◆ ~uniformSet()

virtual ~uniformSet ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "uniform" )

The documentation for this class was generated from the following files:

src/sampling/sampledSet/uniform/uniformSet.H
src/sampling/sampledSet/uniform/uniformSet.C

Public Member Functions