Helper class used by fvc::sweep function. More...

Public Member Functions
	sweepData ()
	Construct null. More...

	sweepData (const scalar value, const point &origin)
	Construct from component. More...

scalar	value () const
	Return value. More...

const point &	origin () const
	Return origin. More...

template<class TrackingData >
bool	valid (TrackingData &td) const
	Check whether origin has been changed at all or. More...

template<class TrackingData >
bool	sameGeometry (const fvMesh &, const sweepData &, const scalar, TrackingData &td) const
	Check for identical geometrical data. More...

template<class TrackingData >
void	transform (const fvPatch &patch, const label patchFacei, const transformer &transform, TrackingData &td)
	Transform across an interface. More...

template<class TrackingData >
bool	updateCell (const fvMesh &, const label thisCelli, const labelPair &neighbourPatchAndFacei, const sweepData &svf, const scalar tol, TrackingData &td)
	Influence of neighbouring face. More...

template<class TrackingData >
bool	updateFace (const fvMesh &, const labelPair &thisPatchAndFacei, const label neighbourCelli, const sweepData &svf, const scalar tol, TrackingData &td)
	Influence of neighbouring cell. More...

template<class TrackingData >
bool	updateFace (const fvMesh &, const labelPair &thisPatchAndFacei, const sweepData &svf, const scalar tol, TrackingData &td)
	Influence of different value on same face. More...

template<class TrackingData >
bool	equal (const sweepData &, TrackingData &td) const
	Same (like operator==) More...

void	operator= (const scalar value)

bool	operator== (const sweepData &) const

bool	operator!= (const sweepData &) const

Friends
Ostream &	operator<< (Ostream &os, const sweepData &svf)

Istream &	operator>> (Istream &is, sweepData &svf)

Detailed Description

Helper class used by fvc::sweep function.

Source files

Definition at line 56 of file sweepData.H.

Constructor & Destructor Documentation

◆ sweepData() [1/2]

sweepData ( )

inline

Construct null.

Definition at line 77 of file sweepDataI.H.

◆ sweepData() [2/2]

sweepData	(	const scalar	value,
		const point &	origin
	)

inline

Construct from component.

Definition at line 84 of file sweepDataI.H.

Member Function Documentation

◆ value()

scalar value ( ) const

inline

Return value.

Definition at line 97 of file sweepData.H.

Referenced by sweepData::operator=().

Here is the caller graph for this function:

◆ origin()

const point& origin ( ) const

inline

Return origin.

Definition at line 103 of file sweepData.H.

References sweepData::equal(), sweepData::operator!=(), sweepData::operator=(), sweepData::operator==(), sweepData::sameGeometry(), sweepData::transform(), sweepData::updateCell(), sweepData::updateFace(), and sweepData::valid().

Referenced by sweepData::operator==().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ valid()

bool valid ( TrackingData & td ) const

inline

Check whether origin has been changed at all or.

still contains original (invalid) value

Definition at line 94 of file sweepDataI.H.

References sweepData::sameGeometry().

Referenced by sweepData::origin().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sameGeometry()

bool sameGeometry	(	const fvMesh &	,
		const sweepData &	,
		const scalar	,
		TrackingData &	td
	)		const

inline

Check for identical geometrical data.

Used for cyclics checking

Definition at line 102 of file sweepDataI.H.

References sweepData::transform().

Referenced by sweepData::origin(), and sweepData::valid().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ transform()

void transform	(	const fvPatch &	patch,
		const label	patchFacei,
		const transformer &	transform,
		TrackingData &	td
	)

inline

Transform across an interface.

Definition at line 115 of file sweepDataI.H.

References transformer::transformPosition(), and sweepData::updateCell().

Referenced by sweepData::origin(), and sweepData::sameGeometry().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateCell()

bool updateCell	(	const fvMesh &	mesh,
		const label	thisCelli,
		const labelPair &	neighbourPatchAndFacei,
		const sweepData &	svf,
		const scalar	tol,
		TrackingData &	td
	)

inline

Influence of neighbouring face.

Definition at line 128 of file sweepDataI.H.

References fvMesh::C(), and sweepData::updateFace().

Referenced by sweepData::origin(), and sweepData::transform().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateFace() [1/2]

bool updateFace	(	const fvMesh &	mesh,
		const labelPair &	thisPatchAndFacei,
		const label	neighbourCelli,
		const sweepData &	svf,
		const scalar	tol,
		TrackingData &	td
	)