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

Public Member Functions
	sweepData (const sweepData &)=default
	Copy construct. More...

sweepData &	operator= (const sweepData &)=default
	Copy assignment. More...

	sweepData ()
	Default construct. More...

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

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

scalar &	value ()
	The value. More...

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

template<class TrackingData >
bool	valid (TrackingData &td) const
	Changed or contains original (invalid) value. More...

template<class TrackingData >
bool	sameGeometry (const polyMesh &, const sweepData &, const scalar, TrackingData &td) const
	Check for identical geometrical data (eg, cyclics checking) 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
	Test for equality, with TrackingData. More...

void	operator= (const scalar value)
	Assign new value. More...

bool	operator== (const sweepData &) const
	Test for equality. More...

bool	operator!= (const sweepData &) const
	Test for inequality. More...

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

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

Detailed Description

Helper class used by fvc::sweep function.

Source files

Definition at line 52 of file sweepData.H.

Constructor & Destructor Documentation

◆ sweepData() [1/3]

sweepData ( const sweepData & )

default

Copy construct.

◆ sweepData() [2/3]

sweepData ( )

inline

Default construct.

Definition at line 69 of file sweepDataI.H.

◆ sweepData() [3/3]

sweepData	(	const scalar	value,
		const point &	origin
	)

inline

Construct from components.

Definition at line 77 of file sweepDataI.H.

Member Function Documentation

◆ operator=() [1/2]

sweepData& operator= ( const sweepData & )

default

Copy assignment.

◆ value() [1/2]

scalar value ( ) const

inline

Return value.

Definition at line 112 of file sweepData.H.

Referenced by sweepData::operator=().

Here is the caller graph for this function:

◆ value() [2/2]

scalar& value ( )

inline

The value.

Definition at line 120 of file sweepData.H.

◆ origin()

const point& origin ( ) const

inline

Return origin.

Definition at line 128 of file sweepData.H.

◆ valid()

bool valid ( TrackingData & td ) const

inline

Changed or contains original (invalid) value.

Definition at line 90 of file sweepDataI.H.

◆ sameGeometry()

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

inline

Check for identical geometrical data (eg, cyclics checking)

Definition at line 98 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 111 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 137 of file sweepDataI.H.

◆ transform()

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

inline

Apply rotation matrix to any coordinates.

Definition at line 125 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 152 of file sweepDataI.H.

References primitiveMesh::cellCentres(), mesh, and update().

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

References primitiveMesh::faceCentres(), mesh, and update().

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

References primitiveMesh::faceCentres(), mesh, and update().

Here is the call graph for this function:

◆ equal()

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

inline

Test for equality, with TrackingData.

Definition at line 197 of file sweepDataI.H.

References Foam::operator==().

Here is the call graph for this function:

◆ operator=() [2/2]

void operator= ( const scalar value )

inline

Assign new value.

Definition at line 246 of file sweepData.H.

References sweepData::value().

Here is the call graph for this function:

◆ operator==()

bool operator== ( const sweepData & rhs ) const

inline

Test for equality.

Definition at line 209 of file sweepDataI.H.

◆ operator!=()

bool operator!= ( const sweepData & rhs ) const

inline

Test for inequality.

Definition at line 218 of file sweepDataI.H.

Friends And Related Function Documentation

◆ operator<<

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

friend

Definition at line 264 of file sweepData.H.

◆ operator>>

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

friend

Definition at line 269 of file sweepData.H.

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

Friends

Detailed Description

Constructor & Destructor Documentation

◆ sweepData() [1/3]

◆ sweepData() [2/3]

◆ sweepData() [3/3]

Member Function Documentation

◆ operator=() [1/2]

◆ value() [1/2]

◆ value() [2/2]

◆ origin()

◆ valid()

◆ sameGeometry()

◆ leaveDomain()

◆ enterDomain()

◆ transform()

◆ updateCell()

◆ updateFace() [1/2]

◆ updateFace() [2/2]

◆ equal()

◆ operator=() [2/2]

◆ operator==()

◆ operator!=()

Friends And Related Function Documentation

◆ operator<<

◆ operator>>