Adds label index to base particle. More...

Inheritance diagram for indexedParticle:

Collaboration diagram for indexedParticle:

Public Member Functions
	indexedParticle (const polyMesh &mesh, const barycentric &coordinates, const label celli, const label tetFacei, const label tetPti, const label index=0)
	Construct from components. More...

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

	indexedParticle (const indexedParticle &p)
	Construct as a copy. More...

virtual autoPtr< particle >	clone () const
	Construct and return a clone. More...

label	index () const

label &	index ()

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)
	Construct from a position and a cell, searching for the rest of the. More...

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

	particle (const particle &p)
	Construct as a copy. More...

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

virtual	~particle ()
	Destructor. More...

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

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

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

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

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

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

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

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

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

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

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

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

label &	origId ()
	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
	Return the indices of the current tet that the. More...

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

vector	normal () const
	Return the normal of the tri on tetFacei_ for the. More...

vector	oldNormal () const
	Return the normal of the tri on tetFacei_ for the. More...

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

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

bool	onBoundaryFace () const
	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...

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 TrackData >
void	trackToFace (const vector &displacement, const scalar fraction, TrackData &td)
	As non-templated particle::trackToFace, but with additional. More...

void	constrainToMeshCentre ()
	Set the constrained components of the particle position to 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...

virtual scalar	wallImpactDistance (const vector &n) const
	The nearest distance to a wall that. More...

template<class TrackData >
void	prepareForParallelTransfer (const label patchi, TrackData &td)
	Convert global addressing to the processor patch. More...

template<class TrackData >
void	correctAfterParallelTransfer (const label patchi, TrackData &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 approproate for decomposition or reconstruction. More...

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

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

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

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

template<class CloudType >
static void	writeFields (const CloudType &c)
	Write the fields associated with the owner cloud. 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 provode unique ID. More...

Protected Member Functions inherited from particle< Type >
template<class TrackData >
void	hitFace (TrackData &td)
	Overridable function to handle the particle hitting a face. More...

template<class TrackData >
bool	hitPatch (const polyPatch &, TrackData &td, const label patchi, const scalar trackFraction, const tetIndices &tetIs)
	Overridable function to handle the particle hitting a. More...

template<class TrackData >
void	hitWedgePatch (const wedgePolyPatch &, TrackData &td)
	Overridable function to handle the particle hitting a wedgePatch. More...

template<class TrackData >
void	hitSymmetryPlanePatch (const symmetryPlanePolyPatch &, TrackData &td)
	Overridable function to handle the particle hitting a. More...

template<class TrackData >
void	hitSymmetryPatch (const symmetryPolyPatch &, TrackData &td)
	Overridable function to handle the particle hitting a. More...

template<class TrackData >
void	hitCyclicPatch (const cyclicPolyPatch &, TrackData &td)
	Overridable function to handle the particle hitting a cyclicPatch. More...

template<class TrackData >
void	hitCyclicAMIPatch (const cyclicAMIPolyPatch &, TrackData &td, const vector &direction)
	Overridable function to handle the particle hitting a cyclicAMIPatch. More...

template<class TrackData >
void	hitProcessorPatch (const processorPolyPatch &, TrackData &td)
	Overridable function to handle the particle hitting a. More...

template<class TrackData >
void	hitWallPatch (const wallPolyPatch &, TrackData &td, const tetIndices &tetIs)
	Overridable function to handle the particle hitting a wallPatch. More...

template<class TrackData >
void	hitPatch (const polyPatch &, TrackData &td)
	Overridable function to handle the particle hitting a. More...

Detailed Description

Adds label index to base particle.

Source files

Definition at line 50 of file indexedParticle.H.

Constructor & Destructor Documentation

◆ indexedParticle() [1/3]

indexedParticle	(	const polyMesh &	mesh,
		const barycentric &	coordinates,
		const label	celli,
		const label	tetFacei,
		const label	tetPti,
		const label	index = `0`
	)

inline

Construct from components.

Definition at line 65 of file indexedParticle.H.

Referenced by indexedParticle::clone().

Here is the caller graph for this function:

◆ indexedParticle() [2/3]

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

inline

Construct from Istream.

Definition at line 80 of file indexedParticle.H.

◆ indexedParticle() [3/3]

indexedParticle ( const indexedParticle & p )

inline

Construct as a copy.

Definition at line 90 of file indexedParticle.H.

Member Function Documentation

◆ clone()

virtual autoPtr<particle> clone ( ) const

inlinevirtual

Construct and return a clone.

Reimplemented from particle< Type >.

Definition at line 96 of file indexedParticle.H.

References indexedParticle::indexedParticle().

Here is the call graph for this function:

◆ index() [1/2]

label index ( ) const

inline

Definition at line 104 of file indexedParticle.H.

◆ index() [2/2]

label& index ( )

inline

Definition at line 109 of file indexedParticle.H.

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

src/lagrangian/basic/indexedParticle/indexedParticle.H

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ indexedParticle() [1/3]

◆ indexedParticle() [2/3]

◆ indexedParticle() [3/3]

Member Function Documentation

◆ clone()

◆ index() [1/2]

◆ index() [2/2]