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

Collaboration diagram for sweepData:

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 polyMesh &, const sweepData &, const scalar, TrackingData &td) const
	Check for identical geometrical data. More...

template<class TrackingData >
void	leaveDomain (const polyMesh &, const polyPatch &, const label patchFaceI, const point &faceCentre, TrackingData &td)
	Convert any absolute coordinates into relative to. More...

template<class TrackingData >
void	enterDomain (const polyMesh &, const polyPatch &, const label patchFaceI, const point &faceCentre, TrackingData &td)
	Reverse of leaveDomain. More...

template<class TrackingData >
void	transform (const polyMesh &, const tensor &, TrackingData &td)
	Apply rotation matrix to any coordinates. More...

template<class TrackingData >
bool	updateCell (const polyMesh &, const label thisCellI, const label neighbourFaceI, const sweepData &svf, const scalar tol, TrackingData &td)
	Influence of neighbouring face. More...

template<class TrackingData >
bool	updateFace (const polyMesh &, const label thisFaceI, const label neighbourCellI, const sweepData &svf, const scalar tol, TrackingData &td)
	Influence of neighbouring cell. More...

template<class TrackingData >
bool	updateFace (const polyMesh &, const label thisFaceI, 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

Private Member Functions
template<class TrackingData >
bool	update (const sweepData &svf, const point &position, const scalar tol, TrackingData &td)
	Update - gets information from neighbouring face/cell and. More...

Private Attributes
scalar	value_

point	origin_

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 47 of file sweepData.H.

Constructor & Destructor Documentation

◆ sweepData() [1/2]

sweepData ( )

inline

Construct null.

Definition at line 74 of file sweepDataI.H.

◆ sweepData() [2/2]

sweepData	(	const scalar	value,
		const point &	origin
	)

inline

Construct from component.

Definition at line 81 of file sweepDataI.H.

Member Function Documentation

◆ update()

bool update	(	const sweepData &	svf,
		const point &	position,
		const scalar	tol,
		TrackingData &	td
	)

inlineprivate

Update - gets information from neighbouring face/cell and.

uses this to update itself (if necessary) and return true

Definition at line 32 of file sweepDataI.H.

References Foam::magSqr(), sweepData::origin(), and sweepData::value().

Here is the call graph for this function:

◆ value()

scalar value ( ) const

inline

Return value.

Definition at line 82 of file sweepData.H.

References sweepData::value_.

Referenced by sweepData::update().

Here is the caller graph for this function:

◆ origin()

const point& origin ( ) const

inline

Return origin.

Definition at line 88 of file sweepData.H.

References sweepData::origin_.

Referenced by sweepData::operator==(), and sweepData::update().

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 91 of file sweepDataI.H.

◆ sameGeometry()

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

inline

Check for identical geometrical data.

Used for cyclics checking

Definition at line 99 of file sweepDataI.H.

◆ leaveDomain()

void leaveDomain	(	const polyMesh &	,
		const polyPatch &	,
		const label	patchFaceI,
		const point &	faceCentre,
		TrackingData &	td
	)

inline

Convert any absolute coordinates into relative to.

(patch)face centre

Definition at line 112 of file sweepDataI.H.

◆ enterDomain()

void enterDomain	(	const polyMesh &	,
		const polyPatch &	,
		const label	patchFaceI,
		const point &	faceCentre,
		TrackingData &	td
	)

inline

Reverse of leaveDomain.

Definition at line 138 of file sweepDataI.H.

◆ transform()

void transform	(	const polyMesh &	,
		const tensor &	rotTensor,
		TrackingData &	td
	)

inline

Apply rotation matrix to any coordinates.

Definition at line 126 of file sweepDataI.H.

References Foam::transform().

Here is the call graph for this function:

◆ updateCell()

bool updateCell	(	const polyMesh &	mesh,
		const label	thisCellI,
		const label	neighbourFaceI,
		const sweepData &	svf,
		const scalar	tol,
		TrackingData &	td
	)

inline

Influence of neighbouring face.

Definition at line 153 of file sweepDataI.H.

References primitiveMesh::cellCentres(), and mesh.

Here is the call graph for this function:

◆ updateFace() [1/2]

bool updateFace	(	const polyMesh &	mesh,
		const label	thisFaceI,
		const label	neighbourCellI,
		const sweepData &	svf,
		const scalar	tol,
		TrackingData &	td
	)

inline

Influence of neighbouring cell.

Definition at line 168 of file sweepDataI.H.

References primitiveMesh::faceCentres(), and mesh.

Here is the call graph for this function:

◆ updateFace() [2/2]

bool updateFace	(	const polyMesh &	mesh,
		const label	thisFaceI,
		const sweepData &	svf,
		const scalar	tol,
		TrackingData &	td
	)

inline

Influence of different value on same face.

Definition at line 184 of file sweepDataI.H.

References primitiveMesh::faceCentres(), and mesh.

Here is the call graph for this function:

◆ equal()

bool equal	(	const sweepData &	rhs,
		TrackingData &	td
	)		const

inline

Same (like operator==)

Definition at line 198 of file sweepDataI.H.

References Foam::operator==().

Here is the call graph for this function:

◆ operator=()

void operator= ( const scalar value )

inline

Definition at line 210 of file sweepDataI.H.

◆ operator==()

bool operator== ( const sweepData & rhs ) const

inline

Definition at line 219 of file sweepDataI.H.

References sweepData::origin().

Here is the call graph for this function:

◆ operator!=()

bool operator!= ( const sweepData & rhs ) const

inline

Definition at line 228 of file sweepDataI.H.

Friends And Related Function Documentation

◆ operator<<

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

friend

Definition at line 197 of file sweepData.H.

◆ operator>>

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

friend

Definition at line 205 of file sweepData.H.

Field Documentation

◆ value_

scalar value_

private

Definition at line 49 of file sweepData.H.

Referenced by sweepData::value().

◆ origin_

point origin_

private

Definition at line 50 of file sweepData.H.

Referenced by sweepData::origin().

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

src/finiteVolume/finiteVolume/fvc/fvcSmooth/sweepData.H
src/finiteVolume/finiteVolume/fvc/fvcSmooth/sweepDataI.H

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ sweepData() [1/2]

◆ sweepData() [2/2]

Member Function Documentation

◆ update()

◆ value()

◆ origin()

◆ valid()

◆ sameGeometry()

◆ leaveDomain()

◆ enterDomain()

◆ transform()

◆ updateCell()

◆ updateFace() [1/2]

◆ updateFace() [2/2]

◆ equal()

◆ operator=()

◆ operator==()

◆ operator!=()

Friends And Related Function Documentation

◆ operator<<

◆ operator>>

Field Documentation

◆ value_

◆ origin_