Particle class that finds cells by tracking. More...

Inheritance diagram for findCellParticle:

Collaboration diagram for findCellParticle:

Classes
class	iNew

class	trackingData

Public Member Functions
	findCellParticle (const polyMesh &mesh, const barycentric &coordinates, const label celli, const label tetFacei, const label tetPti, const point &end, const label data)

	findCellParticle (const polyMesh &mesh, const vector &position, const label celli, const point &end, const label data)

	findCellParticle (const polyMesh &mesh, Istream &is, bool readFields=true, bool newFormat=true)

autoPtr< particle >	clone () const

const point &	start () const

point &	start ()

const point &	end () const

point &	end ()

label	data () const

label &	data ()

bool	move (Cloud< findCellParticle > &, trackingData &, const scalar)

bool	hitPatch (Cloud< findCellParticle > &, trackingData &)

void	hitWedgePatch (Cloud< findCellParticle > &, trackingData &)

void	hitSymmetryPlanePatch (Cloud< findCellParticle > &, trackingData &)

void	hitSymmetryPatch (Cloud< findCellParticle > &, trackingData &)

void	hitCyclicPatch (Cloud< findCellParticle > &, trackingData &)

void	hitCyclicAMIPatch (Cloud< findCellParticle > &, trackingData &, const vector &)

void	hitCyclicACMIPatch (Cloud< findCellParticle > &, trackingData &, const vector &)

void	hitProcessorPatch (Cloud< findCellParticle > &, trackingData &)

void	hitWallPatch (Cloud< findCellParticle > &, trackingData &)

Public Member Functions inherited from particle< Type >
	TypeName ("particle")

	particle (const polyMesh &mesh, const barycentric &coordinates, const label celli, const label tetFacei, const label tetPti)

	particle (const polyMesh &mesh, const vector &position, const label celli=-1)

	particle (const polyMesh &mesh, const vector &position, const label celli, const label tetFacei, const label tetPti, const bool doLocate=true)

	particle (const polyMesh &mesh, Istream &, bool readFields=true, bool newFormat=true)

	particle (const particle &p)

	particle (const particle &p, const polyMesh &mesh)

virtual	~particle ()=default

label	getNewParticleID () const

const polyMesh &	mesh () const

const barycentric &	coordinates () const

label	cell () const

label &	cell ()

label	tetFace () const

label &	tetFace ()

label	tetPt () const

label &	tetPt ()

label	face () const

label &	face ()

scalar	stepFraction () const

scalar &	stepFraction ()

label	origProc () const

label &	origProc ()

label	origId () const

label &	origId ()

Pair< scalar >	stepFractionSpan () const

scalar	currentTimeFraction () const

tetIndices	currentTetIndices () const

barycentricTensor	currentTetTransform () const

vector	normal () const

bool	onFace () const

bool	onInternalFace () const

bool	onBoundaryFace () const

label	patch () const

vector	position () const

void	reset ()

scalar	track (const vector &displacement, const scalar fraction)

scalar	trackToFace (const vector &displacement, const scalar fraction)

scalar	trackToTri (const vector &displacement, const scalar fraction, label &tetTriI)

scalar	trackToStationaryTri (const vector &displacement, const scalar fraction, label &tetTriI)

scalar	trackToMovingTri (const vector &displacement, const scalar fraction, label &tetTriI)

template<class TrackCloudType >
void	hitFace (const vector &direction, TrackCloudType &cloud, trackingData &td)

template<class TrackCloudType >
void	trackToAndHitFace (const vector &direction, const scalar fraction, TrackCloudType &cloud, trackingData &td)

vector	deviationFromMeshCentre () const

void	patchData (vector &n, vector &U) const

virtual void	transformProperties (const tensor &T)

virtual void	transformProperties (const vector &separation)

void	prepareForParallelTransfer ()

void	correctAfterParallelTransfer (const label patchi, trackingData &td)

void	prepareForInteractionListReferral (const vectorTensorTransform &transform)

void	correctAfterInteractionListReferral (const label celli)

label	procTetPt (const polyMesh &procMesh, const label procCell, const label procTetFace) const

void	autoMap (const vector &position, const mapPolyMesh &mapper)

void	relocate (const point &position, const label celli=-1)

void	writeProperties (Ostream &os, const wordRes &filters, const word &delim, const bool namesOnly) const

void	writeCoordinates (Ostream &os) const

virtual void	writePosition (Ostream &os) const

Friends
class	Cloud< findCellParticle >

Ostream &	operator<< (Ostream &, const findCellParticle &)

Additional Inherited Members
Static Public Member Functions inherited from particle< Type >
static string	propertyList ()

template<class Type >
static void	writePropertyName (Ostream &os, const word &name, const word &delim)

template<class Type >
static void	writeProperty (Ostream &os, const word &name, const Type &value, const bool nameOnly, const word &delim, const wordRes &filters=wordRes::null())

template<class Type >
static void	writeProperty (Ostream &os, const word &name, const Field< Type > &values, const bool nameOnly, const word &delim, const wordRes &filters=wordRes::null())

template<class TrackCloudType >
static void	readFields (TrackCloudType &c)

template<class TrackCloudType >
static void	writeFields (const TrackCloudType &c)

template<class CloudType >
static void	readObjects (CloudType &c, const objectRegistry &obr)

template<class CloudType >
static void	writeObjects (const CloudType &c, objectRegistry &obr)

Static Public Attributes inherited from particle< Type >
static string	propertyList_ = Foam::particle::propertyList()

static label	particleCount_ = 0

static bool	writeLagrangianCoordinates = true

static bool	writeLagrangianPositions

Protected Member Functions inherited from particle< Type >
template<class TrackCloudType >
bool	hitPatch (TrackCloudType &, trackingData &)

template<class TrackCloudType >
void	hitWedgePatch (TrackCloudType &, trackingData &)

template<class TrackCloudType >
void	hitSymmetryPlanePatch (TrackCloudType &, trackingData &)

template<class TrackCloudType >
void	hitSymmetryPatch (TrackCloudType &, trackingData &)

template<class TrackCloudType >
void	hitCyclicPatch (TrackCloudType &, trackingData &)

template<class TrackCloudType >
void	hitCyclicAMIPatch (TrackCloudType &, trackingData &, const vector &)

template<class TrackCloudType >
void	hitCyclicACMIPatch (TrackCloudType &, trackingData &, const vector &)

template<class TrackCloudType >
void	hitProcessorPatch (TrackCloudType &, trackingData &)

template<class TrackCloudType >
void	hitWallPatch (TrackCloudType &, trackingData &)

Detailed Description

Particle class that finds cells by tracking.

Source files

Definition at line 55 of file findCellParticle.H.

Constructor & Destructor Documentation

◆ findCellParticle() [1/3]

findCellParticle	(	const polyMesh &	mesh,
		const barycentric &	coordinates,
		const label	celli,
		const label	tetFacei,
		const label	tetPti,
		const point &	end,
		const label	data
	)

Definition at line 27 of file findCellParticle.C.

Referenced by findCellParticle::clone(), and findCellParticle::iNew::operator()().

Here is the caller graph for this function:

◆ findCellParticle() [2/3]

findCellParticle	(	const polyMesh &	mesh,
		const vector &	position,
		const label	celli,
		const point &	end,
		const label	data
	)

Definition at line 45 of file findCellParticle.C.

◆ findCellParticle() [3/3]

findCellParticle	(	const polyMesh &	mesh,
		Istream &	is,
		bool	readFields = `true`,
		bool	newFormat = `true`
	)

Definition at line 61 of file findCellParticle.C.

References Istream::beginRawRead(), IOstream::check(), IOstream::checkLabelSize(), IOstream::checkScalarSize(), Istream::endRawRead(), IOstreamOption::format(), FUNCTION_NAME, Istream::read(), Foam::readFields(), and Foam::readRawLabel().

Here is the call graph for this function:

Member Function Documentation

◆ clone()

autoPtr<particle> clone ( ) const

inlinevirtual

Reimplemented from particle< Type >.

Definition at line 149 of file findCellParticle.H.

References findCellParticle::findCellParticle().

Here is the call graph for this function:

◆ start() [1/2]

const point& start ( ) const

inline

Definition at line 180 of file findCellParticle.H.

◆ start() [2/2]

point& start ( )

inline

Definition at line 186 of file findCellParticle.H.

◆ end() [1/2]

const point& end ( ) const

inline

Definition at line 192 of file findCellParticle.H.

◆ end() [2/2]

point& end ( )

inline

Definition at line 198 of file findCellParticle.H.

◆ data() [1/2]

label data ( ) const

inline

Definition at line 204 of file findCellParticle.H.

◆ data() [2/2]

label& data ( )

inline

Definition at line 210 of file findCellParticle.H.

◆ move()

bool move	(	Cloud< findCellParticle > &	cloud,
		trackingData &	td,
		const scalar	maxTrackLen
	)

Definition at line 104 of file findCellParticle.C.

References List::append(), findCellParticle::trackingData::cellToData(), findCellParticle::trackingData::cellToEnd(), f(), particle< Type >::trackingData::keepParticle, and particle< Type >::trackingData::switchProcessor.

Here is the call graph for this function:

◆ hitPatch()

bool hitPatch	(	Cloud< findCellParticle > &	,
		trackingData &
	)

Definition at line 134 of file findCellParticle.C.

◆ hitWedgePatch()

void hitWedgePatch	(	Cloud< findCellParticle > &	,
		trackingData &	td
	)

Definition at line 141 of file findCellParticle.C.

References particle< Type >::trackingData::keepParticle.

◆ hitSymmetryPlanePatch()

void hitSymmetryPlanePatch	(	Cloud< findCellParticle > &	,
		trackingData &	td
	)

Definition at line 152 of file findCellParticle.C.

References particle< Type >::trackingData::keepParticle.

◆ hitSymmetryPatch()

void hitSymmetryPatch	(	Cloud< findCellParticle > &	,
		trackingData &	td
	)

Definition at line 163 of file findCellParticle.C.

References particle< Type >::trackingData::keepParticle.

◆ hitCyclicPatch()

void hitCyclicPatch	(	Cloud< findCellParticle > &	,
		trackingData &	td
	)

Definition at line 174 of file findCellParticle.C.

References particle< Type >::trackingData::keepParticle.

◆ hitCyclicAMIPatch()

void hitCyclicAMIPatch	(	Cloud< findCellParticle > &	,
		trackingData &	td,
		const vector &
	)

Definition at line 185 of file findCellParticle.C.

References particle< Type >::trackingData::keepParticle.

◆ hitCyclicACMIPatch()

void hitCyclicACMIPatch	(	Cloud< findCellParticle > &	,
		trackingData &	td,
		const vector &
	)

Definition at line 197 of file findCellParticle.C.

References particle< Type >::trackingData::keepParticle.

◆ hitProcessorPatch()

void hitProcessorPatch	(	Cloud< findCellParticle > &	,
		trackingData &	td
	)

Definition at line 209 of file findCellParticle.C.

References particle< Type >::trackingData::switchProcessor.

◆ hitWallPatch()

void hitWallPatch	(	Cloud< findCellParticle > &	,
		trackingData &	td
	)

Definition at line 220 of file findCellParticle.C.

References particle< Type >::trackingData::keepParticle.

Friends And Related Function Documentation

◆ Cloud< findCellParticle >

friend class Cloud< findCellParticle >

friend

Definition at line 73 of file findCellParticle.H.

◆ operator<<

Ostream& operator<<	(	Ostream &	,
		const findCellParticle &
	)

friend

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

src/functionObjects/field/nearWallFields/findCellParticle.H
src/functionObjects/field/nearWallFields/findCellParticle.C

Classes

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ findCellParticle() [1/3]

◆ findCellParticle() [2/3]

◆ findCellParticle() [3/3]

Member Function Documentation

◆ clone()

◆ start() [1/2]

◆ start() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ data() [1/2]

◆ data() [2/2]

◆ move()

◆ hitPatch()

◆ hitWedgePatch()

◆ hitSymmetryPlanePatch()

◆ hitSymmetryPatch()

◆ hitCyclicPatch()

◆ hitCyclicAMIPatch()

◆ hitCyclicACMIPatch()

◆ hitProcessorPatch()

◆ hitWallPatch()

Friends And Related Function Documentation

◆ Cloud< findCellParticle >

◆ operator<<