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 labelList &	cells () const
	Access the cells. More...

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

virtual void	movePoints ()
	Update for mesh point-motion. More...

virtual void	topoChange (const polyTopoChangeMap &)
	Update topology using the given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

virtual void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution map. 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...

const pointField &	positions () const
	Get the positions. 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...

virtual void	genSamples ()=0
	Generate the samples. 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 64 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:

◆ genSamples()

virtual void genSamples ( )

protectedpure virtual

Generate the samples.

◆ 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)
	)

◆ clone()

autoPtr<sampledSet> clone ( ) const

inline

Clone.

Definition at line 184 of file sampledSet.H.

References NotImplemented.

◆ New()

Foam::autoPtr< Foam::sampledSet > New	(	const word &	name,
		const polyMesh &	mesh,
		const meshSearch &	searchEngine,
		const dictionary &	dict
	)

static

Return a reference to the selected sampledSet.

Definition at line 189 of file sampledSet.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, HashTable< T, Key, Hash >::found(), dictionary::lookup(), mesh, dictionaryName::name(), Foam::name(), Foam::nl, and dictionary::optionalSubDict().

Referenced by sampledSet::iNew::operator()(), streamlines::read(), and sampledSets::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ name()

const word& name ( ) const

inline

Access the name.

Definition at line 210 of file sampledSet.H.

Referenced by sampledSet::iNew::operator()().

Here is the caller graph for this function:

◆ mesh()

const polyMesh& mesh ( ) const

inline

Access the mesh.

Definition at line 216 of file sampledSet.H.

Referenced by points::calcSamples(), and lineFace::calcSamples().

Here is the caller graph for this function:

◆ searchEngine()

const meshSearch& searchEngine ( ) const

inline

Access the search engine.

Definition at line 222 of file sampledSet.H.

Referenced by points::calcSamples(), and lineFace::calcSamples().

Here is the caller graph for this function:

◆ cells()

const labelList& cells ( ) const

inline

Access the cells.

Definition at line 228 of file sampledSet.H.

References sampledSet::cells_.

◆ faces()

const labelList& faces ( ) const

inline

Access the faces.

Definition at line 234 of file sampledSet.H.

References sampledSet::faces_.

◆ movePoints()

void movePoints ( )

virtual

Update for mesh point-motion.

Definition at line 253 of file sampledSet.C.

◆ topoChange()

void topoChange ( const polyTopoChangeMap & map )

virtual

Update topology using the given map.

Definition at line 259 of file sampledSet.C.

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

virtual

Update from another mesh using the given map.

Definition at line 265 of file sampledSet.C.

◆ distribute()

void distribute ( const polyDistributionMap & map )

virtual

Redistribute or update using the given distribution map.

Definition at line 271 of file sampledSet.C.

Member Data Documentation

◆ cells_

labelList cells_

protected

Cell numbers.

Definition at line 85 of file sampledSet.H.

Referenced by sampledSet::cells(), and sampledSet::setSamples().

◆ faces_

labelList faces_

protected

Face numbers (-1 if not known)

Definition at line 88 of file sampledSet.H.

Referenced by sampledSet::faces(), and sampledSet::setSamples().

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

src/sampling/sampledSet/sampledSet/sampledSet.H
src/sampling/sampledSet/sampledSet/sampledSet.C

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ sampledSet() [1/2]

◆ sampledSet() [2/2]

◆ ~sampledSet()

Member Function Documentation

◆ setSamples() [1/2]

◆ setSamples() [2/2]

◆ genSamples()

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ clone()

◆ New()

◆ name()

◆ mesh()

◆ searchEngine()

◆ cells()

◆ faces()

◆ movePoints()

◆ topoChange()

◆ mapMesh()

◆ distribute()

Member Data Documentation

◆ cells_

◆ faces_