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

Inheritance diagram for streamLineParticle:

Collaboration diagram for streamLineParticle:

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

class	trackingData

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

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

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

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

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

bool	hitPatch (streamLineParticleCloud &, trackingData &)
	Overridable function to handle the particle hitting a patch. More...

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

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

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

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

void	hitCyclicAMIPatch (streamLineParticleCloud &, trackingData &, const vector &direction)
	Overridable function to handle the particle hitting a. More...

void	hitCyclicACMIPatch (streamLineParticleCloud &, trackingData &, const vector &direction)
	Overridable function to handle the particle hitting a. More...

void	hitProcessorPatch (streamLineParticleCloud &, trackingData &)

void	hitWallPatch (streamLineParticleCloud &, trackingData &)
	Overridable function to handle the particle hitting a wallPatch. 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)
	Construct as a copy. More...

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

virtual autoPtr< particle >	clone () const
	Construct a clone. 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...

Public Member Functions inherited from LList< LListBase, T >::link
	link (const T &elem)
	Copy construct from given object. More...

	link (T &&elem)
	Move construct from given object. More...

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 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())

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

Static Public Member Functions inherited from LList< LListBase, T >::link
static T	remove (typename LListBase::link *node)
	Delete linked item and return the element value. More...

static constexpr T *	ptr (typename LListBase::link *node)
	Dereference LListBase::link to obtain address of stored object. More...

static constexpr const T *	ptr (const typename LListBase::link *node)
	Dereference LListBase::link to obtain address of stored object. More...

static constexpr T &	ref (typename LListBase::link *node)
	Dereference LListBase::link to obtain the stored object. More...

static constexpr const T &	ref (const typename LListBase::link *node)
	Dereference LListBase::link to obtain the stored object. More...

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

Additional Inherited Members
Public Attributes inherited from LList< LListBase, T >::link
T	val_
	Stored object. 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

static bool	writeLagrangianPositions

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 samples fields as it passes through. Used in streamline calculation.

Source files

Definition at line 61 of file streamLineParticle.H.

Constructor & Destructor Documentation

◆ streamLineParticle() [1/3]

streamLineParticle	(	const polyMesh &	c,
		const vector &	position,
		const label	celli,
		const bool	trackForward,
		const label	lifeTime
	)

Construct from components.

Definition at line 85 of file streamLineParticle.C.

◆ streamLineParticle() [2/3]

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

Construct from Istream.

Definition at line 100 of file streamLineParticle.C.

References IOstream::check(), forAll, FUNCTION_NAME, streamLineParticle::readFields(), and UList< T >::size().

Here is the call graph for this function:

◆ streamLineParticle() [3/3]

streamLineParticle ( const streamLineParticle & p )

Construct copy.

Definition at line 135 of file streamLineParticle.C.

Member Function Documentation

◆ clone()

autoPtr< particle > clone ( ) const

inlinevirtual

Construct and return a clone.

Reimplemented from particle< Type >.

Definition at line 180 of file streamLineParticle.H.

◆ move()

bool move	(	streamLineParticleCloud &	cloud,
		trackingData &	td,
		const	scalar
	)

Track all particles to their end point.

Definition at line 151 of file streamLineParticle.C.

References streamLineParticle::trackingData::allPositions_, streamLineParticle::trackingData::allScalars_, streamLineParticle::trackingData::allVectors_, polyMesh::bounds(), Foam::endl(), forAll, particle< Type >::trackingData::keepParticle, boundBox::mag(), Foam::mag(), Foam::max(), mesh, streamLineParticle::trackingData::nSubCycle_, Foam::Pout, particle< Type >::stepFraction(), particle< Type >::trackingData::switchProcessor, streamLineParticle::trackingData::trackLength_, particle< Type >::trackToFace(), List< T >::transfer(), and U.

Here is the call graph for this function:

◆ hitPatch()

bool hitPatch	(	streamLineParticleCloud &	,
		trackingData &
	)

Overridable function to handle the particle hitting a patch.

Executed before other patch-hitting functions

Definition at line 277 of file streamLineParticle.C.

◆ hitWedgePatch()

void hitWedgePatch	(	streamLineParticleCloud &	,
		trackingData &	td
	)

Overridable function to handle the particle hitting a wedge.

Definition at line 284 of file streamLineParticle.C.

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

◆ hitSymmetryPlanePatch()

void hitSymmetryPlanePatch	(	streamLineParticleCloud &	,
		trackingData &	td
	)

Overridable function to handle the particle hitting a.

symmetry plane

Definition at line 295 of file streamLineParticle.C.

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

◆ hitSymmetryPatch()

void hitSymmetryPatch	(	streamLineParticleCloud &	,
		trackingData &	td
	)

Overridable function to handle the particle hitting a.

symmetry patch

Definition at line 306 of file streamLineParticle.C.

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

◆ hitCyclicPatch()

void hitCyclicPatch	(	streamLineParticleCloud &	,
		trackingData &	td
	)

Overridable function to handle the particle hitting a cyclic.

Definition at line 317 of file streamLineParticle.C.

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

◆ hitCyclicAMIPatch()

void hitCyclicAMIPatch	(	streamLineParticleCloud &	,
		trackingData &	td,
		const vector &	direction
	)

Overridable function to handle the particle hitting a.

cyclicAMIPatch

Definition at line 328 of file streamLineParticle.C.

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

◆ hitCyclicACMIPatch()

void hitCyclicACMIPatch	(	streamLineParticleCloud &	,
		trackingData &	td,
		const vector &	direction
	)

Overridable function to handle the particle hitting a.

cyclicACMIPatch

Definition at line 340 of file streamLineParticle.C.

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

◆ hitProcessorPatch()

void hitProcessorPatch	(	streamLineParticleCloud &	,
		trackingData &	td
	)

Overridable function to handle the particle hitting a processorPatch

Definition at line 352 of file streamLineParticle.C.

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

◆ hitWallPatch()

void hitWallPatch	(	streamLineParticleCloud &	,
		trackingData &	td
	)

Overridable function to handle the particle hitting a wallPatch.

Definition at line 363 of file streamLineParticle.C.

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

◆ readFields()

void readFields ( Cloud< streamLineParticle > & c )

static

Read.

Definition at line 374 of file streamLineParticle.C.

References IOobject::MUST_READ, p, and List< T >::transfer().

Referenced by streamLineParticle::streamLineParticle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeFields()

void writeFields ( const Cloud< streamLineParticle > & c )

static

Write.

Definition at line 404 of file streamLineParticle.C.

References IOobject::NO_READ, p, regIOobject::write(), and fieldAverage::writeFields().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<<

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

friend

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

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

Classes

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ streamLineParticle() [1/3]

◆ streamLineParticle() [2/3]

◆ streamLineParticle() [3/3]

Member Function Documentation

◆ clone()

◆ move()

◆ hitPatch()

◆ hitWedgePatch()

◆ hitSymmetryPlanePatch()

◆ hitSymmetryPatch()

◆ hitCyclicPatch()

◆ hitCyclicAMIPatch()

◆ hitCyclicACMIPatch()

◆ hitProcessorPatch()

◆ hitWallPatch()

◆ readFields()

◆ writeFields()

Friends And Related Function Documentation

◆ operator<<