Particle class that samples fields as it passes through. Used in streamline calculation. More...

Inheritance diagram for streamLineParticle:

Collaboration diagram for streamLineParticle:

[legend]

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

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

Public Member Functions
	streamLineParticle (const polyMesh &c, const vector &position, const label cellI, const label lifeTime)
	Construct from components. More...

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

	streamLineParticle (const streamLineParticle &p)
	Construct copy. More...

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

bool	move (trackingData &, const scalar trackTime)
	Track all particles to their end point. More...

bool	hitPatch (const polyPatch &, trackingData &td, const label patchI, const scalar trackFraction, const tetIndices &tetIs)
	Overridable function to handle the particle hitting a patch. More...

void	hitWedgePatch (const wedgePolyPatch &, trackingData &td)
	Overridable function to handle the particle hitting a wedge. More...

void	hitSymmetryPlanePatch (const symmetryPlanePolyPatch &, trackingData &td)
	Overridable function to handle the particle hitting a. More...

void	hitSymmetryPatch (const symmetryPolyPatch &, trackingData &td)
	Overridable function to handle the particle hitting a. More...

void	hitCyclicPatch (const cyclicPolyPatch &, trackingData &td)
	Overridable function to handle the particle hitting a cyclic. More...

void	hitProcessorPatch (const processorPolyPatch &, trackingData &td)

void	hitWallPatch (const wallPolyPatch &, trackingData &td, const tetIndices &)
	Overridable function to handle the particle hitting a wallPatch. More...

void	hitPatch (const polyPatch &, trackingData &td)
	Overridable function to handle the particle hitting a polyPatch. More...

Public Member Functions inherited from particle< Type >
	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	~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 void	readFields (Cloud< streamLineParticle > &)
	Read. More...

static void	writeFields (const Cloud< streamLineParticle > &)
	Write. More...

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

Private Member Functions
scalar	calcSubCycleDeltaT (trackingData &td, const scalar dt, const vector &U) const
	Estimate dt to cross from current face to next one in nSubCycle. More...

void	constrainVelocity (trackingData &td, const scalar dt, vector &U)

vector	interpolateFields (const trackingData &, const point &, const label cellI, const label faceI)
	Interpolate all quantities; return interpolated velocity. More...

Private Attributes
label	lifeTime_
	Lifetime of particle. Particle dies when reaches 0. More...

DynamicList< point >	sampledPositions_
	Sampled positions. More...

List< DynamicList< scalar > >	sampledScalars_
	Sampled scalars. More...

List< DynamicList< vector > >	sampledVectors_
	Sampled vectors. More...

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

Additional Inherited Members
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...

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 inherited from particle< Type >
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 inherited from particle< Type >
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...

Detailed Description

Particle class that samples fields as it passes through. Used in streamline calculation.

Source files

Definition at line 54 of file streamLineParticle.H.

Constructor & Destructor Documentation

◆ streamLineParticle() [1/3]

streamLineParticle	(	const polyMesh &	c,
		const vector &	position,
		const label	cellI,
		const label	lifeTime
	)

Construct from components.

Definition at line 109 of file streamLineParticle.C.

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

Here is the caller graph for this function:

◆ streamLineParticle() [2/3]

streamLineParticle	(	const polyMesh &	c,
		Istream &	is,
		bool	readFields = `true`
	)

Construct from Istream.

Definition at line 122 of file streamLineParticle.C.

References IOstream::check(), forAll, List::setSize(), and List::size().

Here is the call graph for this function:

◆ streamLineParticle() [3/3]

streamLineParticle ( const streamLineParticle & p )

Construct copy.

Definition at line 161 of file streamLineParticle.C.

Member Function Documentation

◆ calcSubCycleDeltaT()

Foam::scalar calcSubCycleDeltaT	(	trackingData &	td,
		const scalar	dt,
		const vector &	U
	)		const

private

Estimate dt to cross from current face to next one in nSubCycle.

steps.

Definition at line 40 of file streamLineParticle.C.

References particle< Type >::TrackingData< CloudType >::keepParticle, streamLineParticle::trackingData::nSubCycle_, particle< Type >::TrackingData< CloudType >::switchProcessor, particle< Type >::trackToFace(), and U.

Here is the call graph for this function:

◆ constrainVelocity()

void constrainVelocity	(	trackingData &	td,
		const scalar	dt,
		vector &	U
	)

private

◆ interpolateFields()

Foam::vector interpolateFields	(	const trackingData &	td,
		const point &	position,
		const label	cellI,
		const label	faceI
	)

private

Interpolate all quantities; return interpolated velocity.

Definition at line 59 of file streamLineParticle.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, forAll, U, streamLineParticle::trackingData::UIndex_, streamLineParticle::trackingData::vsInterp_, and streamLineParticle::trackingData::vvInterp_.

Here is the call graph for this function:

◆ clone()

autoPtr<particle> clone ( ) const

inlinevirtual

Construct and return a clone.

Reimplemented from particle< Type >.

Definition at line 184 of file streamLineParticle.H.

References streamLineParticle::streamLineParticle().

Here is the call graph for this function:

◆ move()

bool move	(	trackingData &	td,
		const scalar	trackTime
	)

Track all particles to their end point.

Definition at line 175 of file streamLineParticle.C.

References streamLineParticle::trackingData::allPositions_, streamLineParticle::trackingData::allScalars_, streamLineParticle::trackingData::allVectors_, Foam::endl(), forAll, particle< Type >::TrackingData< CloudType >::keepParticle, Foam::mag(), streamLineParticle::trackingData::nSubCycle_, p, Foam::Pout, particle< Type >::TrackingData< CloudType >::switchProcessor, streamLineParticle::trackingData::trackForward_, streamLineParticle::trackingData::trackLength_, List::transfer(), and U.

Here is the call graph for this function:

◆ hitPatch() [1/2]

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

Overridable function to handle the particle hitting a patch.

Executed before other patch-hitting functions

Definition at line 324 of file streamLineParticle.C.

◆ hitWedgePatch()

void hitWedgePatch	(	const wedgePolyPatch &	pp,
		trackingData &	td
	)

Overridable function to handle the particle hitting a wedge.

Definition at line 338 of file streamLineParticle.C.

References particle< Type >::TrackingData< CloudType >::keepParticle.

◆ hitSymmetryPlanePatch()

void hitSymmetryPlanePatch	(	const symmetryPlanePolyPatch &	pp,
		trackingData &	td
	)

Overridable function to handle the particle hitting a.

symmetry plane

Definition at line 349 of file streamLineParticle.C.

References particle< Type >::TrackingData< CloudType >::keepParticle.

◆ hitSymmetryPatch()

void hitSymmetryPatch	(	const symmetryPolyPatch &	pp,
		trackingData &	td
	)

Overridable function to handle the particle hitting a.

symmetry patch

Definition at line 360 of file streamLineParticle.C.

References particle< Type >::TrackingData< CloudType >::keepParticle.

◆ hitCyclicPatch()

void hitCyclicPatch	(	const cyclicPolyPatch &	pp,
		trackingData &	td
	)

Overridable function to handle the particle hitting a cyclic.

Definition at line 371 of file streamLineParticle.C.

References particle< Type >::TrackingData< CloudType >::keepParticle.

◆ hitProcessorPatch()

void hitProcessorPatch	(	const processorPolyPatch &	,
		trackingData &	td
	)

Overridable function to handle the particle hitting a processorPatch

Definition at line 382 of file streamLineParticle.C.

References particle< Type >::TrackingData< CloudType >::switchProcessor.

◆ hitWallPatch()

void hitWallPatch	(	const wallPolyPatch &	wpp,
		trackingData &	td,
		const tetIndices &
	)

Overridable function to handle the particle hitting a wallPatch.

Definition at line 393 of file streamLineParticle.C.

References particle< Type >::TrackingData< CloudType >::keepParticle.

◆ hitPatch() [2/2]

void hitPatch	(	const polyPatch &	wpp,
		trackingData &	td
	)

Overridable function to handle the particle hitting a polyPatch.

Definition at line 405 of file streamLineParticle.C.

References particle< Type >::TrackingData< CloudType >::keepParticle.

◆ readFields()

void readFields ( Cloud< streamLineParticle > & c )

static

Read.

Definition at line 415 of file streamLineParticle.C.

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

Here is the call graph for this function:

◆ writeFields()

void writeFields ( const Cloud< streamLineParticle > & c )

static

Write.

Definition at line 453 of file streamLineParticle.C.

References Foam::constant::universal::c, forAllConstIter(), IOobject::NO_READ, regIOobject::write(), and particle< Type >::writeFields().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<<

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

friend

Field Documentation

◆ lifeTime_

label lifeTime_

private

Lifetime of particle. Particle dies when reaches 0.

Definition at line 119 of file streamLineParticle.H.

◆ sampledPositions_

DynamicList<point> sampledPositions_

private

Sampled positions.

Definition at line 122 of file streamLineParticle.H.

◆ sampledScalars_

List<DynamicList<scalar> > sampledScalars_

private

Sampled scalars.

Definition at line 125 of file streamLineParticle.H.

◆ sampledVectors_

List<DynamicList<vector> > sampledVectors_

private

Sampled vectors.

Definition at line 128 of file streamLineParticle.H.

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

src/postProcessing/functionObjects/field/streamLine/streamLineParticle.H
src/postProcessing/functionObjects/field/streamLine/streamLineParticle.C

Data Structures

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ streamLineParticle() [1/3]

◆ streamLineParticle() [2/3]

◆ streamLineParticle() [3/3]

Member Function Documentation

◆ calcSubCycleDeltaT()

◆ constrainVelocity()

◆ interpolateFields()

◆ clone()

◆ move()

◆ hitPatch() [1/2]

◆ hitWedgePatch()

◆ hitSymmetryPlanePatch()

◆ hitSymmetryPatch()

◆ hitCyclicPatch()

◆ hitProcessorPatch()

◆ hitWallPatch()

◆ hitPatch() [2/2]

◆ readFields()

◆ writeFields()

Friends And Related Function Documentation

◆ operator<<

Field Documentation

◆ lifeTime_

◆ sampledPositions_

◆ sampledScalars_

◆ sampledVectors_