Particle class that marks cells it passes through. Used to mark cells visited by feature edges. More...

Inheritance diagram for trackedParticle:

Collaboration diagram for trackedParticle:

Classes
class	iNew
	Factory class to read-construct particles (for parallel transfer) More...

class	trackingData
	Class used to pass tracking data to the trackToFace function. More...

Public Member Functions
	trackedParticle (const polyMesh &mesh, const barycentric &coordinates, const label celli, const label tetFacei, const label tetPtI, const point &end, const label level, const label i, const label j, const label k)
	Construct from components. More...

	trackedParticle (const polyMesh &mesh, const vector &position, const label celli, const point &end, const label level, const label i, const label j, const label k)
	Construct from a position and a cell, searching for the rest of the required topology. More...

	trackedParticle (const polyMesh &mesh, Istream &is, bool readFields=true, bool newFormat=true)
	Construct from Istream. More...

virtual autoPtr< particle >	clone () const
	Return a clone. More...

point &	start () noexcept
	Point to track from. More...

point &	end () noexcept
	Point to track to. More...

label	i () const noexcept
	Transported label. More...

label &	i () noexcept
	Transported label. More...

label	j () const noexcept
	Transported label. More...

label &	j () noexcept
	Transported label. More...

label	k () const noexcept
	Transported label. More...

label &	k () noexcept
	Transported label. More...

bool	move (Cloud< trackedParticle > &, trackingData &, const scalar)
	Track all particles to their end point. More...

bool	hitPatch (Cloud< trackedParticle > &, trackingData &)
	Overridable function to handle the particle hitting a patch. More...

void	hitWedgePatch (Cloud< trackedParticle > &, trackingData &)
	Overridable function to handle the particle hitting a wedge. More...

void	hitSymmetryPlanePatch (Cloud< trackedParticle > &, trackingData &)
	Overridable function to handle the particle hitting a. More...

void	hitSymmetryPatch (Cloud< trackedParticle > &, trackingData &)
	Overridable function to handle the particle hitting a. More...

void	hitCyclicPatch (Cloud< trackedParticle > &, trackingData &)
	Overridable function to handle the particle hitting a cyclic. More...

void	hitCyclicAMIPatch (Cloud< trackedParticle > &, trackingData &, const vector &)
	Overridable function to handle the particle hitting a cyclicAMI. More...

void	hitCyclicACMIPatch (Cloud< trackedParticle > &, trackingData &, const vector &)
	Overridable function to handle the particle hitting a cyclicACMI. More...

void	hitProcessorPatch (Cloud< trackedParticle > &, trackingData &)
	Overridable function to handle the particle hitting a processorPatch. More...

void	hitWallPatch (Cloud< trackedParticle > &, trackingData &)
	Overridable function to handle the particle hitting a wallPatch. More...

void	correctAfterParallelTransfer (const label, trackingData &)
	Convert processor patch addressing to the global equivalents. More...

Public Member Functions inherited from particle< Type >
	TypeName ("particle")
	Runtime type information. More...

	particle (const polyMesh &mesh, const barycentric &coordinates, const label celli, const label tetFacei, const label tetPti)
	Construct from components. More...

	particle (const polyMesh &mesh, const vector &position, const label celli=-1)
	Construct from a position and a cell. More...

	particle (const polyMesh &mesh, const vector &position, const label celli, const label tetFacei, const label tetPti, const bool doLocate=true)
	Construct from position components. More...

	particle (const polyMesh &mesh, Istream &, const bool readFields=true, const bool newFormat=true, const bool doLocate=true)
	Construct from Istream. More...

	particle (const particle &p, const polyMesh &mesh)
	Construct as a copy with reference to a mesh. More...

	particle (const particle &p)
	Copy construct. More...

virtual	~particle ()=default
	Destructor. More...

label	getNewParticleID () const
	Get unique particle creation id. More...

const polyMesh &	mesh () const noexcept
	Return the mesh database. More...

const barycentric &	coordinates () const noexcept
	Return current particle coordinates. More...

label	cell () const noexcept
	Return current cell particle is in. More...

label &	cell () noexcept
	Return current cell particle is in for manipulation. More...

label	tetFace () const noexcept
	Return current tet face particle is in. More...

label &	tetFace () noexcept
	Return current tet face particle is in for manipulation. More...

label	tetPt () const noexcept
	Return current tet face particle is in. More...

label &	tetPt () noexcept
	Return current tet face particle is in for manipulation. More...

label	face () const noexcept
	Return current face particle is on otherwise -1. More...

label &	face () noexcept
	Return current face particle is on for manipulation. More...

scalar	stepFraction () const noexcept
	Return the fraction of time-step completed. More...

scalar &	stepFraction () noexcept
	Return the fraction of time-step completed. More...

label	origProc () const noexcept
	Return the originating processor ID. More...

label &	origProc () noexcept
	Return the originating processor ID. More...

label	origId () const noexcept
	Return the particle ID on the originating processor. More...

label &	origId () noexcept
	Return the particle ID on the originating processor. More...

Pair< scalar >	stepFractionSpan () const
	Return the step fraction change within the overall time-step. More...

scalar	currentTimeFraction () const
	Return the current fraction within the timestep. This differs. More...

tetIndices	currentTetIndices () const noexcept
	Return indices of the current tet that the particle occupies. More...

barycentricTensor	currentTetTransform () const
	Return the current tet transformation tensor. More...

vector	normal () const
	The (unit) normal of the tri on tetFacei_ for the current tet. More...

bool	onFace () const noexcept
	Is the particle on a face? More...

bool	onInternalFace () const noexcept
	Is the particle on an internal face? More...

bool	onBoundaryFace () const noexcept
	Is the particle on a boundary face? More...

label	patch () const
	Return the index of patch that the particle is on. More...

vector	position () const
	Return current particle position. More...

void	reset ()
	Reset particle data. More...

scalar	track (const vector &displacement, const scalar fraction)
	Track along the displacement for a given fraction of the overall. More...

scalar	trackToFace (const vector &displacement, const scalar fraction)
	As particle::track, but also stops on internal faces. More...

scalar	trackToTri (const vector &displacement, const scalar fraction, label &tetTriI)
	As particle::trackToFace, but also stops on tet triangles. On. More...

scalar	trackToStationaryTri (const vector &displacement, const scalar fraction, label &tetTriI)
	As particle::trackToTri, but for stationary meshes. More...

scalar	trackToMovingTri (const vector &displacement, const scalar fraction, label &tetTriI)
	As particle::trackToTri, but for moving meshes. More...

template<class TrackCloudType >
void	hitFace (const vector &direction, TrackCloudType &cloud, trackingData &td)
	Hit the current face. If the current face is internal than this. More...

template<class TrackCloudType >
void	trackToAndHitFace (const vector &direction, const scalar fraction, TrackCloudType &cloud, trackingData &td)
	Convenience function. Combines trackToFace and hitFace. More...

vector	deviationFromMeshCentre () const
	Get the displacement from the mesh centre. Used to correct the. More...

void	patchData (vector &n, vector &U) const
	Get the normal and velocity of the current patch location. More...

virtual void	transformProperties (const tensor &T)
	Transform the physical properties of the particle. More...

virtual void	transformProperties (const vector &separation)
	Transform the physical properties of the particle. More...

void	prepareForParallelTransfer ()
	Convert global addressing to the processor patch local equivalents. More...

void	correctAfterParallelTransfer (const label patchi, trackingData &td)
	Convert processor patch addressing to the global equivalents. More...

void	prepareForInteractionListReferral (const vectorTensorTransform &transform)
	Break the topology and store the particle position so that the. More...

void	correctAfterInteractionListReferral (const label celli)
	Correct the topology after referral. The particle may still be. More...

label	procTetPt (const polyMesh &procMesh, const label procCell, const label procTetFace) const
	Return the tet point appropriate for decomposition or reconstruction. More...

void	autoMap (const vector &position, const mapPolyMesh &mapper)
	Map after a topology change. More...

void	relocate (const point &position, const label celli=-1)
	Set the addressing based on the provided position. More...

void	writeProperties (Ostream &os, const wordRes &filters, const word &delim, const bool namesOnly) const
	Write individual particle properties to stream. More...

void	writeCoordinates (Ostream &os) const
	Write the particle barycentric coordinates and cell info. More...

virtual void	writePosition (Ostream &os) const
	Write the particle position and cell id. More...

Static Public Attributes
static const std::size_t	sizeofFields_
	Size in bytes of the fields. More...

Static Public Attributes inherited from particle< Type >
static string	propertyList_ = Foam::particle::propertyList()
	String representation of properties. More...

static label	particleCount_ = 0
	Cumulative particle counter - used to provide unique ID. More...

static bool	writeLagrangianCoordinates = true
	Write particle coordinates file (v1712 and later) Default is true. More...

static bool	writeLagrangianPositions
	Write particle positions file (v1706 format and earlier) Default is true (disable in etc/controlDict) More...

Friends
class	Cloud< trackedParticle >

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

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

template<class Derived >
static autoPtr< particle >	Clone (const Derived &p)
	Clone a particle. More...

template<class Derived >
static autoPtr< particle >	Clone (const Derived &p, const polyMesh &mesh)
	Clone a particle with a mesh reference. More...

template<class Type >
static void	writePropertyName (Ostream &os, const word &name, const word &delim)
	Write the name representation to stream. More...

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())
	Write a named particle property to stream, optionally filtered based on its name. More...

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())
	Write a named particle property list to stream, optionally filtered based on its name. More...

template<class TrackCloudType >
static void	readFields (TrackCloudType &c)
	Read the fields associated with the owner cloud. More...

template<class TrackCloudType >
static void	writeFields (const TrackCloudType &c)
	Write the fields associated with the owner cloud. More...

template<class CloudType >
static void	readObjects (CloudType &c, const objectRegistry &obr)
	Read particle fields as objects from the obr registry. More...

template<class CloudType >
static void	writeObjects (const CloudType &c, objectRegistry &obr)
	Write particle fields as objects into the obr registry. More...

Protected Member Functions inherited from particle< Type >
void	readData (Istream &is, point &position, const bool readFields, const bool newFormat, const bool doLocate)
	Read particle from stream. Optionally (for old format) return. More...

template<class TrackCloudType >
bool	hitPatch (TrackCloudType &, trackingData &)
	Overridable function to handle the particle hitting a patch. More...

template<class TrackCloudType >
void	hitWedgePatch (TrackCloudType &, trackingData &)
	Overridable function to handle the particle hitting a wedgePatch. More...

template<class TrackCloudType >
void	hitSymmetryPlanePatch (TrackCloudType &, trackingData &)
	Overridable function to handle the particle hitting a. More...

template<class TrackCloudType >
void	hitSymmetryPatch (TrackCloudType &, trackingData &)
	Overridable function to handle the particle hitting a symmetryPatch. More...

template<class TrackCloudType >
void	hitCyclicPatch (TrackCloudType &, trackingData &)
	Overridable function to handle the particle hitting a cyclicPatch. More...

template<class TrackCloudType >
void	hitCyclicAMIPatch (TrackCloudType &, trackingData &, const vector &)
	Overridable function to handle the particle hitting a cyclicAMIPatch. More...

template<class TrackCloudType >
void	hitCyclicACMIPatch (TrackCloudType &, trackingData &, const vector &)
	Overridable function to handle the particle hitting a. More...

template<class TrackCloudType >
void	hitProcessorPatch (TrackCloudType &, trackingData &)
	Overridable function to handle the particle hitting a processorPatch. More...

template<class TrackCloudType >
void	hitWallPatch (TrackCloudType &, trackingData &)
	Overridable function to handle the particle hitting a wallPatch. More...

template<class TrackCloudType >
void	hitBoundaryFace (const vector &direction, TrackCloudType &cloud, trackingData &td)
	Dispatch function for boundary face interaction. Calls one of. More...

Detailed Description

Particle class that marks cells it passes through. Used to mark cells visited by feature edges.

Source files

Definition at line 57 of file trackedParticle.H.

Constructor & Destructor Documentation

◆ trackedParticle() [1/3]

trackedParticle	(	const polyMesh &	mesh,
		const barycentric &	coordinates,
		const label	celli,
		const label	tetFacei,
		const label	tetPtI,
		const point &	end,
		const label	level,
		const label	i,
		const label	j,
		const label	k
	)

Construct from components.

Definition at line 35 of file trackedParticle.C.

◆ trackedParticle() [2/3]

trackedParticle	(	const polyMesh &	mesh,
		const vector &	position,
		const label	celli,
		const point &	end,
		const label	level,
		const label	i,
		const label	j,
		const label	k
	)

Construct from a position and a cell, searching for the rest of the required topology.

Definition at line 59 of file trackedParticle.C.

◆ trackedParticle() [3/3]

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

Construct from Istream.

Definition at line 81 of file trackedParticle.C.

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

Here is the call graph for this function:

Member Function Documentation

◆ clone()

virtual autoPtr<particle> clone ( ) const

inlinevirtual

Return a clone.

Reimplemented from particle< Type >.

Definition at line 186 of file trackedParticle.H.

References particle< Type >::Clone().

Here is the call graph for this function:

◆ start()

point& start ( )

inlinenoexcept

Point to track from.

Definition at line 217 of file trackedParticle.H.

◆ end()

point& end ( )

inlinenoexcept

Point to track to.

Definition at line 222 of file trackedParticle.H.

◆ i() [1/2]

label i ( ) const

inlinenoexcept

Transported label.

Definition at line 227 of file trackedParticle.H.

◆ i() [2/2]

label& i ( )

inlinenoexcept

Transported label.

Definition at line 232 of file trackedParticle.H.

◆ j() [1/2]

label j ( ) const

inlinenoexcept

Transported label.

Definition at line 237 of file trackedParticle.H.

◆ j() [2/2]

label& j ( )

inlinenoexcept

Transported label.

Definition at line 242 of file trackedParticle.H.

◆ k() [1/2]

label k ( ) const

inlinenoexcept

Transported label.

Definition at line 247 of file trackedParticle.H.

◆ k() [2/2]

label& k ( )

inlinenoexcept

Transported label.

Definition at line 252 of file trackedParticle.H.

◆ move()

bool move	(	Cloud< trackedParticle > &	cloud,
		trackingData &	td,
		const scalar	trackTime
	)

Track all particles to their end point.

Definition at line 127 of file trackedParticle.C.

References f(), Foam::max(), s, and td().

Here is the call graph for this function:

◆ hitPatch()

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

Overridable function to handle the particle hitting a patch.

Executed before other patch-hitting functions

Definition at line 165 of file trackedParticle.C.

◆ hitWedgePatch()

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

Overridable function to handle the particle hitting a wedge.

Definition at line 172 of file trackedParticle.C.

References td().

Here is the call graph for this function:

◆ hitSymmetryPlanePatch()

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

Overridable function to handle the particle hitting a.

symmetry plane

Definition at line 183 of file trackedParticle.C.

References td().

Here is the call graph for this function:

◆ hitSymmetryPatch()

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

Overridable function to handle the particle hitting a.

symmetry patch

Definition at line 194 of file trackedParticle.C.

References td().

Here is the call graph for this function:

◆ hitCyclicPatch()

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

Overridable function to handle the particle hitting a cyclic.

Definition at line 205 of file trackedParticle.C.

References td().

Here is the call graph for this function:

◆ hitCyclicAMIPatch()

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

Overridable function to handle the particle hitting a cyclicAMI.

Definition at line 216 of file trackedParticle.C.

References td().

Here is the call graph for this function:

◆ hitCyclicACMIPatch()

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

Overridable function to handle the particle hitting a cyclicACMI.

Definition at line 228 of file trackedParticle.C.

References td().

Here is the call graph for this function:

◆ hitProcessorPatch()

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

Overridable function to handle the particle hitting a processorPatch.

Definition at line 240 of file trackedParticle.C.

References td().

Here is the call graph for this function:

◆ hitWallPatch()

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

Overridable function to handle the particle hitting a wallPatch.

Definition at line 251 of file trackedParticle.C.

References td().

Here is the call graph for this function:

◆ correctAfterParallelTransfer()

void correctAfterParallelTransfer	(	const label	patchi,
		trackingData &	td
	)

Convert processor patch addressing to the global equivalents.

and set the celli to the face-neighbour

Definition at line 262 of file trackedParticle.C.

References particle< Type >::correctAfterParallelTransfer(), k, and td().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ Cloud< trackedParticle >

friend class Cloud< trackedParticle >

friend

Definition at line 96 of file trackedParticle.H.

◆ operator<<

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

friend

Member Data Documentation

◆ sizeofFields_

const std::size_t sizeofFields_

static

Size in bytes of the fields.

Definition at line 134 of file trackedParticle.H.

Referenced by Foam::operator<<().

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

src/mesh/snappyHexMesh/trackedParticle/trackedParticle.H
src/mesh/snappyHexMesh/trackedParticle/trackedParticle.C

Classes

Public Member Functions

Static Public Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ trackedParticle() [1/3]

◆ trackedParticle() [2/3]

◆ trackedParticle() [3/3]

Member Function Documentation

◆ clone()

◆ start()

◆ end()

◆ i() [1/2]

◆ i() [2/2]

◆ j() [1/2]

◆ j() [2/2]

◆ k() [1/2]

◆ k() [2/2]

◆ move()

◆ hitPatch()

◆ hitWedgePatch()

◆ hitSymmetryPlanePatch()

◆ hitSymmetryPatch()

◆ hitCyclicPatch()

◆ hitCyclicAMIPatch()

◆ hitCyclicACMIPatch()

◆ hitProcessorPatch()

◆ hitWallPatch()

◆ correctAfterParallelTransfer()

Friends And Related Function Documentation

◆ Cloud< trackedParticle >

◆ operator<<

Member Data Documentation

◆ sizeofFields_