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]

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

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

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

	sampledSet (const word &name, const polyMesh &mesh, const word &axis)
	Construct from components. More...

	sampledSet (const word &name, const polyMesh &mesh, 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 coordSet &	coords () const
	Access the coordinate set. More...

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

const labelList &	segments () const
	Return the size. 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...

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...

	operator const coordSet & () const
	Cast to the coordinate set. More...

Static Public Member Functions
static autoPtr< sampledSet >	New (const word &name, const polyMesh &mesh, const dictionary &dict)
	Return a reference to the selected sampledSet. 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 63 of file sampledSet.H.

Constructor & Destructor Documentation

◆ sampledSet() [1/2]

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

Construct from components.

Definition at line 111 of file sampledSet.C.

◆ sampledSet() [2/2]

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

Construct from dictionary.

Definition at line 127 of file sampledSet.C.

◆ ~sampledSet()

~sampledSet ( )

virtual

Destructor.

Definition at line 155 of file sampledSet.C.

Member Function Documentation

◆ TypeName()

TypeName ( "sampledSet" )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

◆ clone()

autoPtr<sampledSet> clone ( ) const

inline

Clone.

Definition at line 164 of file sampledSet.H.

References NotImplemented.

◆ New()

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

static

Return a reference to the selected sampledSet.

Definition at line 161 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, dictionary::optionalTypeDict(), and Foam::typeName().

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 Foam::word & name ( ) const

inline

Access the name.

Definition at line 30 of file sampledSetI.H.

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

Here is the caller graph for this function:

◆ mesh()

const Foam::polyMesh & mesh ( ) const

inline

Access the mesh.

Definition at line 36 of file sampledSetI.H.

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

Here is the caller graph for this function:

◆ coords()

const Foam::coordSet & coords ( ) const

inline

Access the coordinate set.

Definition at line 42 of file sampledSetI.H.

◆ size()

Foam::label size ( ) const

inline

Return the size.

Definition at line 52 of file sampledSetI.H.

Referenced by points::calcSamples().

Here is the caller graph for this function:

◆ segments()

const Foam::labelList & segments ( ) const

inline

Return the size.

Definition at line 58 of file sampledSetI.H.

◆ positions()

const Foam::pointField & positions ( ) const

inline

Access the positions.

Definition at line 64 of file sampledSetI.H.

◆ cells()

const Foam::labelList & cells ( ) const

inline

Access the cells.

Definition at line 70 of file sampledSetI.H.

◆ faces()

const Foam::labelList & faces ( ) const

inline

Access the faces.

Definition at line 80 of file sampledSetI.H.

◆ movePoints()

void movePoints ( )

virtual

Update for mesh point-motion.

Definition at line 223 of file sampledSet.C.

◆ topoChange()

void topoChange ( const polyTopoChangeMap & map )

virtual

Update topology using the given map.

Definition at line 231 of file sampledSet.C.

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

virtual

Update from another mesh using the given map.

Definition at line 239 of file sampledSet.C.

◆ distribute()

void distribute ( const polyDistributionMap & map )

virtual

Redistribute or update using the given distribution map.

Definition at line 247 of file sampledSet.C.

◆ operator const coordSet &()

operator const coordSet & ( ) const

inline

Cast to the coordinate set.

Definition at line 92 of file sampledSetI.H.

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

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

Classes

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ sampledSet() [1/2]

◆ sampledSet() [2/2]

◆ ~sampledSet()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ clone()

◆ New()

◆ name()

◆ mesh()

◆ coords()

◆ size()

◆ segments()

◆ positions()

◆ cells()

◆ faces()

◆ movePoints()

◆ topoChange()

◆ mapMesh()

◆ distribute()

◆ operator const coordSet &()