Samples along a circular path. More...

Inheritance diagram for circleSet:

Collaboration diagram for circleSet:

[legend]

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

	circleSet (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const word &axis, const point &origin, const vector &circleAxis, const point &startPoint, const scalar dTheta)
	Construct from components. More...

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

virtual	~circleSet ()

virtual point	getRefPoint (const List< point > &) const
	Get reference point. More...

Public Member Functions inherited from sampledSet
	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 polyMesh &	mesh () const

const meshSearch &	searchEngine () const

const labelList &	segments () const

const labelList &	cells () const

const labelList &	faces () const

Ostream &	write (Ostream &) const
	Output for debugging. More...

Public Member Functions inherited from coordSet
	coordSet (const word &name, const word &axis)
	Construct from components. More...

	coordSet (const word &name, const word &axis, const List< point > &points, const scalarList &curveDist)
	Construct from components. More...

const word &	name () const

word	axis () const

const scalarList &	curveDist () const
	Cumulative distance. More...

bool	hasVectorAxis () const
	Is axis specification a vector. More...

scalar	scalarCoord (const label index) const
	Get coordinate of point according to axis specification. More...

vector	vectorCoord (const label index) const
	Get point according to axis="xyz" specification. More...

Ostream &	write (Ostream &os) const

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

	Field (const label)
	Construct given size. More...

	Field (const label, const Type &)
	Construct given size and initial value. More...

	Field (const UList< Type > &)
	Construct as copy of a UList<Type> More...

	Field (const Xfer< List< Type > > &)
	Construct by transferring the List contents. More...

	Field (const UList< Type > &mapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given field. More...

	Field (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given tmp field. More...

	Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given field. More...

	Field (const tmp< Field< Type > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given tmp field. More...

	Field (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given field. More...

	Field (const UList< Type > &mapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)
	Construct by mapping from the given field. More...

	Field (const UList< Type > &mapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)
	Construct by mapping from the given field. More...

	Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given tmp field. More...

	Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)
	Construct by mapping from the given tmp field. Supplied uniform. More...

	Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)
	Construct by mapping from the given tmp field. Supplied values. More...

	Field (const Field< Type > &)
	Construct as copy. More...

	Field (Field< Type > &, bool reUse)
	Construct as copy or re-use as specified. More...

	Field (const Xfer< Field< Type > > &)
	Construct by transferring the Field contents. More...

	Field (const tmp< Field< Type > > &)
	Construct as copy of tmp<Field> More...

	Field (Istream &)
	Construct from Istream. More...

	Field (const word &keyword, const dictionary &, const label size)
	Construct from a dictionary entry. More...

tmp< Field< Type > >	clone () const
	Clone. More...

void	map (const UList< Type > &mapF, const labelUList &mapAddressing)
	1 to 1 map from the given field More...

void	map (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing)
	1 to 1 map from the given tmp field More...

void	map (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given field. More...

void	map (const tmp< Field< Type > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given tmp field. More...

void	map (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Map from the given field. More...

void	map (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Map from the given tmp field. More...

void	autoMap (const FieldMapper &map, const bool applyFlip=true)
	Map from self. More...

void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given field More...

void	rmap (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given tmp field More...

void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given field. More...

void	rmap (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given tmp field. More...

void	negate ()
	Negate this field. More...

tmp< Field< cmptType > >	component (const direction) const
	Return a component field of the field. More...

void	replace (const direction, const UList< cmptType > &)
	Replace a component field of the field. More...

void	replace (const direction, const tmp< Field< cmptType > > &)
	Replace a component field of the field. More...

void	replace (const direction, const cmptType &)
	Replace a component field of the field. More...

tmp< Field< Type > >	T () const
	Return the field transpose (only defined for second rank tensors) More...

void	writeEntry (const word &keyword, Ostream &os) const
	Write the field as a dictionary entry. More...

void	operator= (const Field< Type > &)

void	operator= (const UList< Type > &)

void	operator= (const SubField< Type > &)

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

void	operator= (const Type &)

template<class Form , class Cmpt , int 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 >
void	operator= (const Field< Type > &rhs)

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

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

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

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

Private Member Functions
void	calcSamples (DynamicList< point > &samplingPts, DynamicList< label > &samplingCells, DynamicList< label > &samplingFaces, DynamicList< label > &samplingSegments, DynamicList< scalar > &samplingCurveDist) const
	Samples all points in sampleCoords. More...

void	genSamples ()
	Uses calcSamples to obtain samples. Copies them into *this. More...

Private Attributes
point	origin_
	Origin (x, y, z) in global cartesian co-ordinates. More...

vector	circleAxis_
	Axis of the circle. More...

point	startPoint_
	Point on circle (x, y, z) in global cartesian co-ordinates. More...

scalar	dTheta_
	Sampling interval in degrees about the origin. More...

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

Public Types inherited from Field
typedef pTraits< Type >::cmptType	cmptType
	Component type. More...

typedef SubField< Type >	subField
	Declare type of subField. More...

Static Public Member Functions inherited from sampledSet
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 Field
static const Field< Type > &	null ()
	Return a null field. More...

template<class Type2 >
static tmp< Field< Type > >	NewCalculatedType (const Field< Type2 > &f)
	Return a pointer to a new calculatedFvPatchFieldField created on. More...

Static Public Attributes inherited from sampledSet
static const scalar	tol = 1e-6
	Tolerance when comparing points. Usually relative to difference. More...

Static Public Attributes inherited from Field
static const char *const	typeName

Protected Member Functions inherited from sampledSet
label	getBoundaryCell (const label) const
	Returns cell next to boundary face. More...

label	getCell (const label faceI, const point &sample) const
	Returns cell using face and containing sample. More...

scalar	calcSign (const label faceI, const point &sample) const
	Calculates inproduct of face normal and vector sample-face centre. More...

label	findNearFace (const label cellI, const point &sample, const scalar smallDist) const
	Returns face label (or -1) of face which is close to sample. More...

point	pushIn (const point &sample, const label faceI) const
	Moves sample in direction of -n to it is 'inside' of faceI. More...

bool	getTrackingPoint (const vector &offset, const point &samplePt, const point &bPoint, const label bFaceI, point &trackPt, label &trackCellI, label &trackFaceI) const
	Calculates start of tracking given samplePt and first boundary. More...

void	setSamples (const List< point > &samplingPts, const labelList &samplingCells, const labelList &samplingFaces, const labelList &samplingSegments, const scalarList &samplingCurveDist)
	Sets sample data. More...

Protected Attributes inherited from sampledSet
labelList	segments_
	Segment numbers. More...

labelList	cells_
	Cell numbers. More...

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

Protected Attributes inherited from coordSet
const word	name_
	Name. More...

const coordFormat	axis_
	Axis write type. More...

scalarList	curveDist_
	Cumulative distance "distance" write specifier. More...

Detailed Description

Samples along a circular path.

Source files

Definition at line 52 of file circleSet.H.

Constructor & Destructor Documentation

◆ circleSet() [1/2]

circleSet	(	const word &	name,
		const polyMesh &	mesh,
		const meshSearch &	searchEngine,
		const word &	axis,
		const point &	origin,
		const vector &	circleAxis,
		const point &	startPoint,
		const scalar	dTheta
	)

Construct from components.

Definition at line 177 of file circleSet.C.

References Foam::Info, and write().

Here is the call graph for this function:

◆ circleSet() [2/2]

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

Construct from dictionary.

Definition at line 204 of file circleSet.C.

References Foam::Info, Foam::mag(), and write().

Here is the call graph for this function:

◆ ~circleSet()

~circleSet ( )

virtual

Definition at line 231 of file circleSet.C.

Member Function Documentation

◆ calcSamples()

void calcSamples	(	DynamicList< point > &	samplingPts,
		DynamicList< label > &	samplingCells,
		DynamicList< label > &	samplingFaces,
		DynamicList< label > &	samplingSegments,
		DynamicList< scalar > &	samplingCurveDist
	)		const

private

Samples all points in sampleCoords.

Definition at line 47 of file circleSet.C.

References Foam::constant::atomic::alpha, DynamicList::append(), Foam::cos(), Foam::endl(), Foam::mag(), Foam::nl, Foam::constant::mathematical::pi(), Foam::sin(), and WarningInFunction.

Referenced by circleSet::genSamples().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ genSamples()

void genSamples ( )

private

Uses calcSamples to obtain samples. Copies them into *this.

Definition at line 139 of file circleSet.C.

References circleSet::calcSamples(), sampledSet::setSamples(), and DynamicList::shrink().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "circle" )

Runtime type information.

◆ getRefPoint()

Foam::point getRefPoint ( const List< point > & pts ) const

virtual

Get reference point.

Definition at line 237 of file circleSet.C.

Field Documentation

◆ origin_

point origin_

private

Origin (x, y, z) in global cartesian co-ordinates.

Definition at line 61 of file circleSet.H.

◆ circleAxis_

vector circleAxis_

private

Axis of the circle.

Definition at line 64 of file circleSet.H.

◆ startPoint_

point startPoint_

private

Point on circle (x, y, z) in global cartesian co-ordinates.

Defines start point

Definition at line 68 of file circleSet.H.

◆ dTheta_

scalar dTheta_

private

Sampling interval in degrees about the origin.

Definition at line 74 of file circleSet.H.

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

src/sampling/sampledSet/circle/circleSet.H
src/sampling/sampledSet/circle/circleSet.C

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ circleSet() [1/2]

◆ circleSet() [2/2]

◆ ~circleSet()

Member Function Documentation

◆ calcSamples()

◆ genSamples()

◆ TypeName()

◆ getRefPoint()

Field Documentation

◆ origin_

◆ circleAxis_

◆ startPoint_

◆ dTheta_