Holds list of sampling points which is filled at construction time. Various implementations of this base class to e.g. get sampling points at uniform distance along a line (lineUniformSet) or directly specified (pointsSet) More...

Inheritance diagram for sampledSet:

[legend]

Collaboration diagram for sampledSet:

[legend]

Classes
class	iNew
	Class used for the read-construction of. More...

Public Member Functions
	TypeName ("sampledSet")
	Runtime type information. More...

	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 word &axis)
	Construct from components. More...

	sampledSet (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict)
	Construct from dictionary. More...

autoPtr< sampledSet >	clone () const
	Clone. More...

virtual	~sampledSet ()
	Destructor. More...

const word &	name () const
	Access the name. More...

const polyMesh &	mesh () const
	Access the mesh. More...

const meshSearch &	searchEngine () const
	Access the search engine. More...

const pointField &	positions () const
	Access the positions. More...

const labelList &	cells () const
	Access the cells. More...

const labelList &	faces () const
	Access the faces. More...

Public Member Functions inherited from coordSet
	coordSet ()
	Construct null. More...

	coordSet (const labelList &segments, const word &positionName=word::null, const pointField &positions=pointField::null(), const word &distanceName=word::null, const scalarField &distances=scalarField::null(), const word &axis=axisTypeNames_[axisType::DEFAULT])
	Construct from components. More...

	coordSet (const bool contiguous, const word &positionName, const pointField &positions, const word &axis=axisTypeNames_[axisType::DEFAULT])
	Construct from positions. More...

	coordSet (const bool contiguous, const word &distanceName, const scalarField &distances, const word &axis=axisTypeNames_[axisType::DEFAULT])
	Construct from distances. More...

label	size () const
	Return the size. More...

const labelList &	segments () const
	Return the segments. More...

word	axis () const
	Return the axis name. More...

bool	hasScalarAxis () const
	Is the coordinate axis a scalar? More...

bool	hasPointAxis () const
	Is the coordinate axis a point? More...

scalar	scalarCoord (const label index) const
	Get scalar coordinate (axis is x, y, z or distance) More...

tmp< scalarField >	scalarCoords () const
	Get scalar coordinates (axis is x, y, z or distance) More...

word	scalarName () const
	Return the name of the scalar coordinates. More...

point	pointCoord (const label index) const
	Get vector coordinate (axis is xyz) More...

tmp< pointField >	pointCoords () const
	Get vector coordinate (axis is xyz) More...

word	pointName () const
	Return the name of the point coordinates. More...

labelList	vertices () const
	Return a list of isolated vertices. These are the points that are. More...

labelPairList	edges () const
	Return a list of edges. These are adjacent pairs of points which. More...

labelListList	lines () const
	Return a list of lines. These are lists of points which are in the. More...

Tuple2< coordSet, labelList >	gather () const
	Combine coordinate sets onto the master. Return both the combined. More...

template<class Type >
Foam::tmp< Foam::Field< Type > >	gather (const Field< Type > &values, const labelList &order)

Static Public Member Functions
static autoPtr< sampledSet >	New (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict)
	Return a reference to the selected sampledSet. More...

Static Public Member Functions inherited from coordSet
template<class Type >
static tmp< Field< Type > >	gather (const Field< Type > &values, const labelList &order)
	Combine a field using the ordering obtained from the coordinate set. More...

Protected Member Functions
void	setSamples (const List< point > &samplingPositions, const labelList &samplingSegments, const labelList &samplingCells, const labelList &samplingFaces)
	Sets sample data. More...

void	setSamples (const List< point > &samplingPositions, const List< scalar > &samplingDistances, const labelList &samplingSegments, const labelList &samplingCells, const labelList &samplingFaces)
	Sets sample data. More...

Protected Attributes
labelList	cells_
	Cell numbers. More...

labelList	faces_
	Face numbers (-1 if not known) More...

Protected Attributes inherited from coordSet
labelList	segments_
	Connected segments. More...

word	positionName_
	Name of the positions. More...

autoPtr< pointField >	positions_
	Point positions. More...

word	distanceName_
	Name of the distances. More...

autoPtr< scalarField >	distances_
	Scalar distances. More...

axisType	axis_
	Axis. More...

Additional Inherited Members
Public Types inherited from coordSet
enum class	axisType { XYZ , X , Y , Z , DISTANCE , DEFAULT }
	Enumeration defining the output format for coordinates. More...

Static Public Attributes inherited from coordSet
static const NamedEnum< axisType, 6 >	axisTypeNames_
	String representation of axis enums. More...

Detailed Description

Holds list of sampling points which is filled at construction time. Various implementations of this base class to e.g. get sampling points at uniform distance along a line (lineUniformSet) or directly specified (pointsSet)

Each 'sampledSet' has a name and a specifier of how the axis should be write (x/y/z component or all 3 components)

Source files

Definition at line 61 of file sampledSet.H.

Constructor & Destructor Documentation

◆ sampledSet() [1/2]

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

Construct from components.

Definition at line 135 of file sampledSet.C.

References coordSet::axis(), coordSet::axis_, and coordSet::axisTypeNames_.

Here is the call graph for this function:

◆ sampledSet() [2/2]

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

Construct from dictionary.

Definition at line 154 of file sampledSet.C.

References coordSet::axis_, coordSet::axisTypeNames_, coordSet::DEFAULT, and dict.

◆ ~sampledSet()

~sampledSet ( )

virtual

Destructor.

Definition at line 183 of file sampledSet.C.

Member Function Documentation

◆ setSamples() [1/2]

void setSamples	(	const List< point > &	samplingPositions,
		const labelList &	samplingSegments,
		const labelList &	samplingCells,
		const labelList &	samplingFaces
	)

protected

Sets sample data.

Definition at line 46 of file sampledSet.C.

References Foam::abort(), coordSet::axis_, coordSet::axisTypeNames_, sampledSet::cells_, coordSet::coordSet(), coordSet::DISTANCE, sampledSet::faces_, Foam::FatalError, FatalErrorInFunction, Field< scalar >::null(), word::null, and List< T >::size().

Here is the call graph for this function:

◆ setSamples() [2/2]

void setSamples	(	const List< point > &	samplingPositions,
		const List< scalar > &	samplingDistances,
		const labelList &	samplingSegments,
		const labelList &	samplingCells,
		const labelList &	samplingFaces
	)

protected

Sets sample data.

Definition at line 88 of file sampledSet.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, word::null, and List< T >::size().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "sampledSet" )

Runtime type information.

◆ declareRunTimeSelectionTable()

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