Base particle class. More...

Inheritance diagram for particle< Type >:

[legend]

Collaboration diagram for particle< Type >:

[legend]

Data Structures
class	iNew
	Factory class to read-construct particles used for. More...

class	TrackingData

Public Member Functions
	TypeName ("particle")
	Runtime type information. More...

	particle (const polyMesh &mesh, const vector &position, const label cellI, const label tetFaceI, const label tetPtI)
	Construct from components. More...

	particle (const polyMesh &mesh, const vector &position, const label cellI, bool doCellFacePt=true)
	Construct from components, tetFaceI_ and tetPtI_ are not. 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 autoPtr< particle >	clone () const
	Construct a clone. More...

virtual	~particle ()
	Destructor. More...

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

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

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

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

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

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

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

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

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

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

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

tetPointRef	currentTet () const
	Return the geometry of the current tet that the. 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...

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

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

bool	softImpact () const
	Return the impact model to be used, soft or hard (default). More...

scalar	currentTime () const
	Return the particle current time. More...

void	initCellFacePt ()
	Check the stored cell value (setting if necessary) and. More...

bool	onBoundary () const
	Is the particle on the boundary/(or outside the domain)? More...

bool	internalFace (const label faceI) const
	Is this global face an internal face? More...

bool	boundaryFace (const label faceI) const
	Is this global face a boundary face? More...

label	patch (const label faceI) const
	Which patch is particle on. More...

label	patchFace (const label patchI, const label faceI) const
	Which face of this patch is this particle on. More...

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

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

label	origProc () const
	Return const access to the originating processor id. More...

label &	origProc ()
	Return the originating processor id for manipulation. More...

label	origId () const
	Return const access to the particle id on originating processor. More...

label &	origId ()
	Return the particle id on originating processor for manipulation. More...

template<class TrackData >
label	track (const vector &endPosition, TrackData &td)
	Track particle to end of trajectory. More...

template<class TrackData >
scalar	trackToFace (const vector &endPosition, TrackData &td)
	Track particle to a given position and returns 1.0 if the. More...

label	faceInterpolation () const
	Return the index of the face to be used in the interpolation. 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	writePosition (Ostream &) const
	Write the particle position and cell. More...

template<class TrackData >
Foam::label	track (const vector &endPosition, TrackData &td)

template<class TrackData >
Foam::scalar	trackToFace (const vector &endPosition, TrackData &td)

Static Public Member Functions
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
static string	propertyList_ = Foam::particle::propertyList()
	String representation of properties. More...

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

static const scalar	trackingCorrectionTol = 1e-5
	Fraction of distance to tet centre to move a particle to. More...

static const scalar	lambdaDistanceToleranceCoeff = 1e3*SMALL
	Fraction of the cell volume to use in determining tolerance values. More...

static const scalar	minStepFractionTol = 1e5*SMALL
	Minimum stepFraction tolerance. More...

Protected Member Functions
void	findTris (const vector &position, DynamicList< label > &faceList, const tetPointRef &tet, const FixedList< vector, 4 > &tetAreas, const FixedList< label, 4 > &tetPlaneBasePtIs, const scalar tol) const
	Find the tet tri faces between position and tet centre. More...

scalar	tetLambda (const vector &from, const vector &to, const label triI, const vector &tetArea, const label tetPlaneBasePtI, const label cellI, const label tetFaceI, const label tetPtI, const scalar tol) const
	Find the lambda value for the line to-from across the. More...

scalar	movingTetLambda (const vector &from, const vector &to, const label triI, const vector &tetArea, const label tetPlaneBasePtI, const label cellI, const label tetFaceI, const label tetPtI, const scalar tol) const
	Find the lambda value for a moving tri face. More...

void	tetNeighbour (label triI)
	Modify the tet owner data by crossing triI. More...

void	crossEdgeConnectedFace (const label &cellI, label &tetFaceI, label &tetPtI, const edge &e)
	Cross the from the given face across the given edge of the. More...

template<class CloudType >
void	hitWallFaces (const CloudType &td, const vector &from, const vector &to, scalar &lambdaMin, tetIndices &closestTetIs)

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...

Protected Attributes
const polyMesh &	mesh_
	Reference to the polyMesh database. More...

vector	position_
	Position of particle. More...

label	cellI_
	Index of the cell it is in. More...

label	faceI_
	Face index if the particle is on a face otherwise -1. More...

scalar	stepFraction_
	Fraction of time-step completed. More...

label	tetFaceI_
	Index of the face that owns the decomposed tet that the. More...

label	tetPtI_
	Index of the point on the face that defines the decomposed. More...

label	origProc_
	Originating processor id. More...

label	origId_
	Local particle id on originating processor. More...

Static Private Attributes
static const std::size_t	sizeofPosition_
	Size in bytes of the position data. More...

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

Friends
Ostream &	operator<< (Ostream &, const particle &)

bool	operator== (const particle &pA, const particle &pB)

bool	operator!= (const particle &pA, const particle &pB)

Detailed Description

template<class Type>
class Foam::particle< Type >

Base particle class.

Definition at line 78 of file particle.H.

Constructor & Destructor Documentation

◆ particle() [1/5]

particle	(	const polyMesh &	mesh,
		const vector &	position,
		const label	cellI,
		const label	tetFaceI,
		const label	tetPtI
	)

Construct from components.

Definition at line 48 of file particle.C.

Referenced by particle< Type >::clone(), and particle< Type >::iNew::operator()().

Here is the caller graph for this function:

◆ particle() [2/5]

particle	(	const polyMesh &	mesh,
		const vector &	position,
		const label	cellI,
		bool	doCellFacePt = `true`
	)

Construct from components, tetFaceI_ and tetPtI_ are not.

supplied so they will be deduced by a search

Definition at line 69 of file particle.C.

◆ particle() [3/5]

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

Construct from Istream.

Definition at line 46 of file particleIO.C.

References IOstream::ASCII, particle< Type >::cellI_, IOstream::check(), particle< Type >::faceI_, IOstream::format(), particle< Type >::origId_, particle< Type >::origProc_, particle< Type >::position_, Istream::read(), particle< Type >::sizeofFields_, particle< Type >::sizeofPosition_, particle< Type >::stepFraction_, particle< Type >::tetFaceI_, and particle< Type >::tetPtI_.

Here is the call graph for this function:

◆ particle() [4/5]

particle ( const particle< Type > & p )

Construct as a copy.

Definition at line 93 of file particle.C.

◆ particle() [5/5]

particle	(	const particle< Type > &	p,
		const polyMesh &	mesh
	)

Construct as a copy with refernce to a new mesh.

Definition at line 107 of file particle.C.

◆ ~particle()

virtual ~particle ( )

inlinevirtual

Destructor.

Definition at line 390 of file particle.H.

Member Function Documentation

◆ findTris()

void findTris	(	const vector &	position,
		DynamicList< label > &	faceList,
		const tetPointRef &	tet,
		const FixedList< vector, 4 > &	tetAreas,
		const FixedList< label, 4 > &	tetPlaneBasePtIs,
		const scalar	tol
	)		const

inlineprotected

Find the tet tri faces between position and tet centre.

Definition at line 32 of file particleI.H.

References List::append(), tetrahedron::centre(), List::clear(), and lambda().

Here is the call graph for this function:

◆ tetLambda()

Foam::scalar tetLambda	(	const vector &	from,
		const vector &	to,
		const label	triI,
		const vector &	tetArea,
		const label	tetPlaneBasePtI,
		const label	cellI,
		const label	tetFaceI,
		const label	tetPtI,
		const scalar	tol
	)		const

inlineprotected

Find the lambda value for the line to-from across the.

given tri face, where p = from + lambda*(to - from)

Definition at line 69 of file particleI.H.

References Foam::mag(), n, and Foam::sign().

Here is the call graph for this function:

◆ movingTetLambda()

Foam::scalar movingTetLambda	(	const vector &	from,
		const vector &	to,
		const label	triI,
		const vector &	tetArea,
		const label	tetPlaneBasePtI,
		const label	cellI,
		const label	tetFaceI,
		const label	tetPtI,
		const scalar	tol
	)		const

inlineprotected

Find the lambda value for a moving tri face.

Definition at line 141 of file particleI.H.

References tetrahedron::a(), Foam::constant::physicoChemical::b, tetrahedron::b(), Foam::constant::universal::c, tetrahedron::c(), tetrahedron::d(), Foam::mag(), n, tetIndices::oldTet(), Foam::sign(), Foam::sqr(), Foam::sqrt(), and tetIndices::tet().

Here is the call graph for this function:

◆ tetNeighbour()

void tetNeighbour ( label triI )

inlineprotected

Modify the tet owner data by crossing triI.

Definition at line 321 of file particleI.H.

References Foam::abort(), particle< Type >::cellI_, particle< Type >::crossEdgeConnectedFace(), f(), polyMesh::faceOwner(), polyMesh::faces(), Foam::FatalError, FatalErrorInFunction, particle< Type >::mesh_, pFaces, polyMesh::tetBasePtIs(), particle< Type >::tetFaceI_, and particle< Type >::tetPtI_.

Here is the call graph for this function:

◆ crossEdgeConnectedFace()

void crossEdgeConnectedFace	(	const label &	cellI,
		label &	tetFaceI,
		label &	tetPtI,
		const edge &	e
	)

inlineprotected

Cross the from the given face across the given edge of the.

given cell to find the resulting face and tetPtI

Definition at line 458 of file particleI.H.

References Foam::abort(), Foam::e, f(), Foam::FatalError, FatalErrorInFunction, Foam::findIndex(), forAll, Foam::neg(), Foam::meshTools::otherFace(), and pFaces.

Referenced by wallBoundedParticle::crossEdgeConnectedFace(), and particle< Type >::tetNeighbour().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hitWallFaces()

void hitWallFaces	(	const CloudType &	td,
		const vector &	from,
		const vector &	to,
		scalar &	lambdaMin,
		tetIndices &	closestTetIs
	)

inlineprotected

Hit wall faces in the current cell if the wallImpactDistance is non-zero. They may not be in Different tets to the current.

Definition at line 717 of file particleTemplates.C.

References triangle::a(), triangle::b(), triangle::c(), tetrahedron::centre(), f(), tetIndices::faceBasePt(), polyMeshTetDecomposition::faceTetIndices(), tetIndices::faceTri(), forAll, intersection::FULL_RAY, PointHit::hit(), triangle::intersection(), lambda(), Foam::mag(), Foam::max(), Foam::min(), n, triangle::normal(), tetIndices::oldFaceTri(), p, patches, pFaces, tetIndices::tet(), tetIndices::tetPt(), and Vector< scalar >::zero.

Here is the call graph for this function:

◆ hitFace()

void hitFace ( TrackData & td )

protected

Overridable function to handle the particle hitting a face.

Definition at line 926 of file particleTemplates.C.

◆ hitPatch() [1/2]

bool hitPatch	(	const polyPatch &	,
		TrackData &	td,
		const label	patchI,
		const scalar	trackFraction,
		const tetIndices &	tetIs
	)

protected

Overridable function to handle the particle hitting a.

patch. Executed before other patch-hitting functions. trackFraction is passed in to allow mesh motion to interpolate in time to the correct face state.

Definition at line 932 of file particleTemplates.C.

◆ hitWedgePatch()

void hitWedgePatch	(	const wedgePolyPatch &	wpp,
		TrackData &	td
	)

protected

Overridable function to handle the particle hitting a wedgePatch.

Definition at line 946 of file particleTemplates.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Foam::I, and Foam::mag().

Here is the call graph for this function:

◆ hitSymmetryPlanePatch()

void hitSymmetryPlanePatch	(	const symmetryPlanePolyPatch &	spp,
		TrackData &	td
	)

protected

Overridable function to handle the particle hitting a.

symmetryPlanePatch

Definition at line 964 of file particleTemplates.C.

References Foam::I, and Foam::mag().

Here is the call graph for this function:

◆ hitSymmetryPatch()

void hitSymmetryPatch	(	const symmetryPolyPatch &	spp,
		TrackData &	td
	)

protected

Overridable function to handle the particle hitting a.

symmetryPatch

Definition at line 978 of file particleTemplates.C.

References Foam::I, and Foam::mag().

Here is the call graph for this function:

◆ hitCyclicPatch()

void hitCyclicPatch	(	const cyclicPolyPatch &	cpp,
		TrackData &	td
	)

protected

Overridable function to handle the particle hitting a cyclicPatch.

Definition at line 992 of file particleTemplates.C.

References coupledPolyPatch::forwardT(), cyclicPolyPatch::neighbPatch(), coupledPolyPatch::parallel(), s(), coupledPolyPatch::separated(), coupledPolyPatch::separation(), Foam::T(), cyclicPolyPatch::transformGlobalFace(), cyclicPolyPatch::transformPosition(), and polyPatch::whichFace().

Here is the call graph for this function:

◆ hitCyclicAMIPatch()

void hitCyclicAMIPatch	(	const cyclicAMIPolyPatch &	cpp,
		TrackData &	td,
		const vector &	direction
	)

protected

Overridable function to handle the particle hitting a cyclicAMIPatch.

Definition at line 1040 of file particleTemplates.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, coupledPolyPatch::forwardT(), patchIdentifier::name(), cyclicAMIPolyPatch::neighbPatch(), coupledPolyPatch::parallel(), cyclicAMIPolyPatch::pointFace(), s(), coupledPolyPatch::separated(), coupledPolyPatch::separation(), polyPatch::start(), and Foam::T().

Here is the call graph for this function:

◆ hitProcessorPatch()

void hitProcessorPatch	(	const processorPolyPatch &	,
		TrackData &	td
	)

protected

Overridable function to handle the particle hitting a.

processorPatch

Definition at line 1099 of file particleTemplates.C.

◆ hitWallPatch()

void hitWallPatch	(	const wallPolyPatch &	,
		TrackData &	td,
		const tetIndices &	tetIs
	)

protected

Overridable function to handle the particle hitting a wallPatch.

Definition at line 1105 of file particleTemplates.C.

◆ hitPatch() [2/2]

void hitPatch	(	const polyPatch &	,
		TrackData &	td
	)

protected

Overridable function to handle the particle hitting a.

general patch

Definition at line 1114 of file particleTemplates.C.

◆ TypeName()

TypeName ( "particle< Type >" )

Runtime type information.

◆ propertyList()

static string propertyList ( )

inlinestatic

Definition at line 315 of file particle.H.

◆ clone()

virtual autoPtr<particle> clone ( ) const

inlinevirtual

Construct a clone.

Reimplemented in molecule, wallBoundedParticle, streamLineParticle, wallBoundedStreamLineParticle, solidParticle, trackedParticle, findCellParticle, indexedParticle, and passiveParticle.

Definition at line 364 of file particle.H.

References particle< Type >::particle().

Referenced by InteractionLists< typename CloudType::parcelType >::prepareParticlesToRefer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNewParticleID()

Foam::label getNewParticleID ( ) const

inline

Get unique particle creation id.

Definition at line 566 of file particleI.H.

References Foam::endl(), Foam::labelMax, and WarningInFunction.

Here is the call graph for this function:

◆ mesh()

const Foam::polyMesh & mesh ( ) const

inline

Return the mesh database.

Definition at line 580 of file particleI.H.

◆ position() [1/2]

Foam::vector & position ( ) const

inline

Return current particle position.

Definition at line 586 of file particleI.H.

Referenced by polyLineSet::calcSamples(), faceOnlySet::calcSamples(), uniformSet::calcSamples(), moleculeCloud::evaluatePair(), lagrangianFieldDecomposer::lagrangianFieldDecomposer(), InteractionLists< typename CloudType::parcelType >::prepareParticleToBeReferred(), Foam::reconstructLagrangianPositions(), polyLineSet::trackToBoundary(), faceOnlySet::trackToBoundary(), and uniformSet::trackToBoundary().

Here is the caller graph for this function:

◆ position() [2/2]

vector& position ( )

inline

Return current particle position.

◆ cell() [1/2]

Foam::label & cell ( )

inline

Return current cell particle is in.

Definition at line 598 of file particleI.H.

Referenced by Foam::reconstructLagrangianPositions(), parLagrangianRedistributor::redistributeLagrangianPositions(), polyLineSet::trackToBoundary(), faceOnlySet::trackToBoundary(), and uniformSet::trackToBoundary().

Here is the caller graph for this function:

◆ cell() [2/2]

label cell ( ) const

inline

Return current cell particle is in.

◆ tetFace() [1/2]

Foam::label & tetFace ( )

inline

Return current tet face particle is in.

Definition at line 610 of file particleI.H.

Referenced by wallBoundedParticle::currentEdge().

Here is the caller graph for this function:

◆ tetFace() [2/2]

label tetFace ( ) const

inline

Return current tet face particle is in.

◆ tetPt() [1/2]

Foam::label & tetPt ( )

inline

Return current tet face particle is in.

Definition at line 622 of file particleI.H.

◆ tetPt() [2/2]

label tetPt ( ) const

inline

Return current tet face particle is in.

◆ currentTetIndices()

Foam::tetIndices currentTetIndices ( ) const

inline

Return the indices of the current tet that the.

particle occupies.

Definition at line 634 of file particleI.H.

◆ currentTet()

Foam::tetPointRef currentTet ( ) const

inline

Return the geometry of the current tet that the.

particle occupies.

Definition at line 640 of file particleI.H.

◆ normal()

Foam::vector normal ( ) const

inline

Return the normal of the tri on tetFaceI_ for the.

current tet.

Definition at line 646 of file particleI.H.

◆ oldNormal()

Foam::vector oldNormal ( ) const

inline

Return the normal of the tri on tetFaceI_ for the.

current tet at the start of the timestep, i.e. based on oldPoints

Definition at line 652 of file particleI.H.

◆ face() [1/2]

Foam::label & face ( )

inline

Return current face particle is on otherwise -1.

Definition at line 658 of file particleI.H.

Referenced by faceOnlySet::trackToBoundary(), and uniformSet::trackToBoundary().

Here is the caller graph for this function:

◆ face() [2/2]

label face ( ) const

inline

Return current face particle is on otherwise -1.

◆ softImpact()

bool softImpact ( ) const

inline

Return the impact model to be used, soft or hard (default).

Definition at line 852 of file particleI.H.

◆ currentTime()

Foam::scalar currentTime ( ) const

inline

Return the particle current time.

Definition at line 858 of file particleI.H.

◆ initCellFacePt()

void initCellFacePt ( )

inline

Check the stored cell value (setting if necessary) and.

initialise the tetFace and tetPt values

Definition at line 670 of file particleI.H.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, Foam::mag(), Foam::nl, and WarningInFunction.

Here is the call graph for this function:

◆ onBoundary()

bool onBoundary ( ) const

inline

Is the particle on the boundary/(or outside the domain)?

Definition at line 810 of file particleI.H.

Referenced by polyLineSet::trackToBoundary(), faceOnlySet::trackToBoundary(), and uniformSet::trackToBoundary().

Here is the caller graph for this function:

◆ internalFace()

bool internalFace ( const label faceI ) const

inline

Is this global face an internal face?

Definition at line 866 of file particleI.H.

◆ boundaryFace()

bool boundaryFace ( const label faceI ) const

inline

Is this global face a boundary face?

Definition at line 872 of file particleI.H.

◆ patch()

Foam::label patch ( const label faceI ) const

inline

Which patch is particle on.

Definition at line 878 of file particleI.H.

◆ patchFace()

Foam::label patchFace	(	const label	patchI,
		const label	faceI
	)		const

inline

Which face of this patch is this particle on.

Definition at line 885 of file particleI.H.

◆ stepFraction() [1/2]

Foam::scalar stepFraction ( )

inline

Return the fraction of time-step completed.

Definition at line 816 of file particleI.H.

Referenced by polyLineSet::trackToBoundary(), and uniformSet::trackToBoundary().

Here is the caller graph for this function:

◆ stepFraction() [2/2]

scalar stepFraction ( ) const

inline

Return the fraction of time-step completed.

◆ origProc() [1/2]

Foam::label & origProc ( ) const

inline

Return const access to the originating processor id.

Definition at line 828 of file particleI.H.

Referenced by Foam::operator==().

Here is the caller graph for this function:

◆ origProc() [2/2]

label& origProc ( )

inline

Return the originating processor id for manipulation.

◆ origId() [1/2]

Foam::label & origId ( ) const

inline

Return const access to the particle id on originating processor.

Definition at line 840 of file particleI.H.

Referenced by Foam::operator==(), particle< Type >::readFields(), and moleculeCloud::removeHighEnergyOverlaps().

Here is the caller graph for this function:

◆ origId() [2/2]

label& origId ( )

inline

Return the particle id on originating processor for manipulation.

◆ track() [1/2]

label track	(	const vector &	endPosition,
		TrackData &	td
	)

Track particle to end of trajectory.

or until it hits the boundary. On entry 'stepFraction()' should be set to the fraction of the time-step at which the tracking starts and on exit it contains the fraction of the time-step completed. Returns the boundary face index if the track stops at the boundary, -1 otherwise.

Referenced by polyLineSet::trackToBoundary(), and uniformSet::trackToBoundary().

Here is the caller graph for this function:

◆ trackToFace() [1/2]

scalar trackToFace	(	const vector &	endPosition,
		TrackData &	td
	)

Track particle to a given position and returns 1.0 if the.

trajectory is completed without hitting a face otherwise stops at the face and returns the fraction of the trajectory completed. on entry 'stepFraction()' should be set to the fraction of the time-step at which the tracking starts.

Referenced by streamLineParticle::calcSubCycleDeltaT(), and faceOnlySet::trackToBoundary().

Here is the caller graph for this function:

◆ faceInterpolation()

Foam::label faceInterpolation ( ) const

inline

Return the index of the face to be used in the interpolation.

routine

Definition at line 894 of file particleI.H.

◆ transformProperties() [1/2]

void transformProperties ( const tensor & T )

virtual

Transform the physical properties of the particle.

according to the given transformation tensor

Reimplemented in molecule, and solidParticle.

Definition at line 123 of file particle.C.

Referenced by InteractionLists< typename CloudType::parcelType >::prepareParticleToBeReferred(), solidParticle::transformProperties(), and molecule::transformProperties().

Here is the caller graph for this function:

◆ transformProperties() [2/2]

void transformProperties ( const vector & separation )

virtual

Transform the physical properties of the particle.

according to the given separation vector

Reimplemented in molecule, and solidParticle.

Definition at line 127 of file particle.C.

◆ wallImpactDistance()

Foam::scalar wallImpactDistance ( const vector & n ) const

virtual

The nearest distance to a wall that.

the particle can be in the n direction

Reimplemented in solidParticle.

Definition at line 131 of file particle.C.

References Foam::endl(), and Foam::Info.

Here is the call graph for this function:

◆ prepareForParallelTransfer()

void prepareForParallelTransfer	(	const label	patchI,
		TrackData &	td
	)

Convert global addressing to the processor patch.

local equivalents

Definition at line 41 of file particleTemplates.C.

◆ correctAfterParallelTransfer()

void correctAfterParallelTransfer	(	const label	patchI,
		TrackData &	td
	)

Convert processor patch addressing to the global equivalents.

and set the cellI to the face-neighbour

Definition at line 53 of file particleTemplates.C.

References polyPatch::faceCells(), coupledPolyPatch::forwardT(), coupledPolyPatch::parallel(), s(), coupledPolyPatch::separated(), coupledPolyPatch::separation(), polyPatch::start(), T, and coupledPolyPatch::transformPosition().

Here is the call graph for this function:

◆ readFields()

void readFields ( CloudType & c )

static

Read the fields associated with the owner cloud.

Definition at line 129 of file particleTemplates.C.

References Foam::constant::universal::c, forAllIter, IOobject::headerOk(), IOobject::MUST_READ, particle< Type >::origId(), and p.

Referenced by solidParticle::readFields(), streamLineParticle::readFields(), wallBoundedParticle::readFields(), and molecule::readFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeFields()

void writeFields ( const CloudType & c )

static

Write the fields associated with the owner cloud.

Definition at line 159 of file particleTemplates.C.

References Foam::constant::universal::c, forAllConstIter(), IOobject::NO_READ, IOPosition::write(), and regIOobject::write().

Referenced by solidParticle::writeFields(), streamLineParticle::writeFields(), wallBoundedParticle::writeFields(), and molecule::writeFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writePosition()

void writePosition ( Ostream & os ) const

Write the particle position and cell.

Definition at line 89 of file particleIO.C.

References IOstream::ASCII, IOstream::check(), IOstream::format(), token::SPACE, and Ostream::write().

Here is the call graph for this function:

◆ track() [2/2]

Foam::label track	(	const vector &	endPosition,
		TrackData &	td
	)

Definition at line 188 of file particleTemplates.C.

◆ trackToFace() [2/2]

Foam::scalar trackToFace	(	const vector &	endPosition,
		TrackData &	td
	)

Definition at line 204 of file particleTemplates.C.

References Foam::abort(), polyPatch::boundaryMesh(), tetIndices::cell(), tetrahedron::centre(), cloud::cloud(), Foam::endl(), f(), tetIndices::face(), tetIndices::faceTri(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::mag(), triangle::normal(), p, patches, pFaces, Foam::Pout, tetrahedron::Sa(), tetrahedron::Sb(), tetrahedron::Sc(), tetrahedron::Sd(), List::size(), and tetIndices::tet().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<<	(	Ostream &	,
		const particle< Type > &
	)

friend

◆ operator==

bool operator==	(	const particle< Type > &	pA,
		const particle< Type > &	pB
	)

friend

◆ operator!=

bool operator!=	(	const particle< Type > &	pA,
		const particle< Type > &	pB
	)

friend

Field Documentation

◆ sizeofPosition_

const std::size_t sizeofPosition_

staticprivate

Size in bytes of the position data.

Definition at line 85 of file particle.H.

Referenced by particle< Type >::particle().

◆ sizeofFields_

const std::size_t sizeofFields_

staticprivate

Size in bytes of the fields.

Definition at line 88 of file particle.H.

Referenced by Foam::operator<<(), and particle< Type >::particle().

◆ mesh_

const polyMesh& mesh_

protected

Reference to the polyMesh database.

Definition at line 137 of file particle.H.

Referenced by wallBoundedParticle::currentEdge(), and particle< Type >::tetNeighbour().

◆ position_

vector position_

protected

Position of particle.

Definition at line 140 of file particle.H.

Referenced by particle< Type >::particle().

◆ cellI_

label cellI_

protected

Index of the cell it is in.

Definition at line 143 of file particle.H.

Referenced by particle< Type >::particle(), and particle< Type >::tetNeighbour().

◆ faceI_

label faceI_

protected

Face index if the particle is on a face otherwise -1.

Definition at line 146 of file particle.H.

Referenced by particle< Type >::particle().

◆ stepFraction_

scalar stepFraction_

protected

Fraction of time-step completed.

Definition at line 149 of file particle.H.

Referenced by particle< Type >::particle().

◆ tetFaceI_

label tetFaceI_

protected

Index of the face that owns the decomposed tet that the.

particle is in

Definition at line 153 of file particle.H.

Referenced by particle< Type >::particle(), and particle< Type >::tetNeighbour().

◆ tetPtI_

label tetPtI_

protected

Index of the point on the face that defines the decomposed.

tet that the particle is in. Relative to the face base point.

Definition at line 158 of file particle.H.

Referenced by particle< Type >::particle(), and particle< Type >::tetNeighbour().

◆ origProc_

label origProc_

protected

Originating processor id.

Definition at line 161 of file particle.H.

Referenced by particle< Type >::particle().

◆ origId_

label origId_

protected

Local particle id on originating processor.

Definition at line 164 of file particle.H.

Referenced by particle< Type >::particle().

◆ propertyList_

Foam::string propertyList_ = Foam::particle::propertyList()

static

String representation of properties.

Definition at line 315 of file particle.H.

◆ particleCount_

Foam::label particleCount_ = 0

static

Cumulative particle counter - used to provode unique ID.

Definition at line 315 of file particle.H.

◆ trackingCorrectionTol

const Foam::scalar trackingCorrectionTol = 1e-5

static

Fraction of distance to tet centre to move a particle to.

'rescue' it from a tracking problem

Definition at line 322 of file particle.H.

Referenced by sampledSet::pushIn().

◆ lambdaDistanceToleranceCoeff

const Foam::scalar lambdaDistanceToleranceCoeff = 1e3*SMALL

static

Fraction of the cell volume to use in determining tolerance values.

for the denominator and numerator of lambda

Definition at line 326 of file particle.H.

◆ minStepFractionTol

const Foam::scalar minStepFractionTol = 1e5*SMALL

static

Minimum stepFraction tolerance.

Definition at line 329 of file particle.H.

Referenced by KinematicParcel::move().

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

src/lagrangian/basic/particle/particle.H
src/lagrangian/basic/particle/particle.C
src/lagrangian/basic/particle/particleI.H
src/lagrangian/basic/particle/particleIO.C
src/lagrangian/basic/particle/particleTemplates.C

Data Structures

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Private Attributes

Friends

Detailed Description

template<class Type> class Foam::particle< Type >

Constructor & Destructor Documentation

◆ particle() [1/5]

◆ particle() [2/5]

◆ particle() [3/5]

◆ particle() [4/5]

◆ particle() [5/5]

◆ ~particle()

Member Function Documentation

◆ findTris()

◆ tetLambda()

◆ movingTetLambda()

◆ tetNeighbour()

◆ crossEdgeConnectedFace()

◆ hitWallFaces()

◆ hitFace()

◆ hitPatch() [1/2]

◆ hitWedgePatch()

◆ hitSymmetryPlanePatch()

◆ hitSymmetryPatch()

◆ hitCyclicPatch()

◆ hitCyclicAMIPatch()

◆ hitProcessorPatch()

◆ hitWallPatch()

◆ hitPatch() [2/2]

◆ TypeName()

◆ propertyList()

◆ clone()

◆ getNewParticleID()

◆ mesh()

◆ position() [1/2]

◆ position() [2/2]

◆ cell() [1/2]

◆ cell() [2/2]

◆ tetFace() [1/2]

◆ tetFace() [2/2]

◆ tetPt() [1/2]

◆ tetPt() [2/2]

◆ currentTetIndices()

◆ currentTet()

◆ normal()

◆ oldNormal()

◆ face() [1/2]

◆ face() [2/2]

◆ softImpact()

◆ currentTime()

◆ initCellFacePt()

◆ onBoundary()

◆ internalFace()

◆ boundaryFace()

◆ patch()

◆ patchFace()

◆ stepFraction() [1/2]

◆ stepFraction() [2/2]

◆ origProc() [1/2]

◆ origProc() [2/2]

◆ origId() [1/2]

◆ origId() [2/2]

◆ track() [1/2]

◆ trackToFace() [1/2]

◆ faceInterpolation()

◆ transformProperties() [1/2]

◆ transformProperties() [2/2]

◆ wallImpactDistance()

◆ prepareForParallelTransfer()

◆ correctAfterParallelTransfer()

◆ readFields()

◆ writeFields()

◆ writePosition()

◆ track() [2/2]

◆ trackToFace() [2/2]

template<class Type>
class Foam::particle< Type >