injectedParticle Class Reference

Primarily stores particle properties so that it can be injected at a later time. Note that this stores its own local position as opposed to the base particle class barycentric coordinates since the particle is not (usually) attached to a mesh, and instead used for post-processing. More...

Inheritance diagram for injectedParticle:
[legend]
Collaboration diagram for injectedParticle:
[legend]

Classes

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

Public Member Functions

 TypeName ("injectedParticle")
 Runtime type information. More...
 
 AddToPropertyList (particle, " tag"+" soi"+" d"+" (Ux Uy Uz)";)
 String representation of properties. More...
 
 injectedParticle (const polyMesh &mesh, const vector &position, const label celli=-1)
 Construct from a position and a cell. More...
 
 injectedParticle (const polyMesh &mesh, const vector &position, const label tag, const scalar soi, const scalar d, const vector &U, const bool doLocate=true)
 Construct from components. More...
 
 injectedParticle (const polyMesh &mesh, Istream &is, bool readFields=true, bool newFormat=true)
 Construct from Istream. More...
 
 injectedParticle (const injectedParticle &p)
 Construct as a copy. More...
 
 injectedParticle (const injectedParticle &p, const polyMesh &mesh)
 Construct as a copy. More...
 
virtual autoPtr< particleclone () const
 Construct and return a (basic particle) clone. More...
 
virtual autoPtr< particleclone (const polyMesh &mesh) const
 Construct and return a (basic particle) clone. More...
 
label tag () const
 Return const access to the tag. More...
 
scalar soi () const
 Return const access to the start of injection. More...
 
scalar d () const
 Return const access to diameter. More...
 
const vectorU () const
 Return const access to velocity. More...
 
label & tag ()
 Return the tag. More...
 
scalar & soi ()
 Return the start of injection. More...
 
scalar & d ()
 Return access to diameter. More...
 
vectorU ()
 Return access to velocity. More...
 
void writeProperties (Ostream &os, const wordRes &filters, const word &delim, const bool namesOnly) const
 Write individual parcel properties to stream. More...
 
virtual void writePosition (Ostream &) const
 Write the particle position and cell. 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 &, bool readFields=true, bool newFormat=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 ~particle ()=default
 Destructor. More...
 
label getNewParticleID () const
 Get unique particle creation id. More...
 
const polyMeshmesh () const
 Return the mesh database. More...
 
const barycentriccoordinates () const
 Return current particle coordinates. More...
 
label cell () const
 Return current cell particle is in. More...
 
label & cell ()
 Return current cell particle is in for manipulation. More...
 
label tetFace () const
 Return current tet face particle is in. More...
 
label & tetFace ()
 Return current tet face particle is in for manipulation. More...
 
label tetPt () const
 Return current tet face particle is in. More...
 
label & tetPt ()
 Return current tet face particle is in for manipulation. More...
 
label face () const
 Return current face particle is on otherwise -1. More...
 
label & face ()
 Return current face particle is on for manipulation. 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
 The (unit) normal of the tri on tetFacei_ for the current tet. 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...
 
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...
 

Static Public Member Functions

static void readFields (Cloud< injectedParticle > &c)
 Read fields. More...
 
static void writeFields (const Cloud< injectedParticle > &c)
 Write fields. More...
 
static void readObjects (Cloud< injectedParticle > &c, const objectRegistry &obr)
 Read particle fields as objects from the obr registry. More...
 
static void writeObjects (const Cloud< injectedParticle > &c, objectRegistry &obr)
 Write particle fields as objects into the obr registry. 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 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
 
static bool writeLagrangianPositions
 

Protected Attributes

point position_
 Position. More...
 
label tag_
 Tag. More...
 
scalar soi_
 Start of injection [s]. More...
 
scalar d_
 Diameter [m]. More...
 
vector U_
 Velocity [m/s]. More...
 

Friends

Ostreamoperator<< (Ostream &, const injectedParticle &)
 

Additional Inherited Members

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

Detailed Description

Primarily stores particle properties so that it can be injected at a later time. Note that this stores its own local position as opposed to the base particle class barycentric coordinates since the particle is not (usually) attached to a mesh, and instead used for post-processing.

Source files
See also
Foam::functionObjects::extractEulerianParticles

Definition at line 63 of file injectedParticle.H.

Constructor & Destructor Documentation

◆ injectedParticle() [1/5]

injectedParticle ( const polyMesh mesh,
const vector position,
const label  celli = -1 
)
inline

Construct from a position and a cell.

Searches for the rest of the required topology. Other properties are zero initialised.

Definition at line 32 of file injectedParticleI.H.

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

Here is the caller graph for this function:

◆ injectedParticle() [2/5]

injectedParticle ( const polyMesh mesh,
const vector position,
const label  tag,
const scalar  soi,
const scalar  d,
const vector U,
const bool  doLocate = true 
)
inline

Construct from components.

Definition at line 48 of file injectedParticleI.H.

◆ injectedParticle() [3/5]

injectedParticle ( const polyMesh mesh,
Istream is,
bool  readFields = true,
bool  newFormat = true 
)

Construct from Istream.

Definition at line 49 of file injectedParticleIO.C.

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

Here is the call graph for this function:

◆ injectedParticle() [4/5]

Construct as a copy.

Definition at line 40 of file injectedParticle.C.

◆ injectedParticle() [5/5]

injectedParticle ( const injectedParticle p,
const polyMesh mesh 
)

Construct as a copy.

Definition at line 52 of file injectedParticle.C.

Member Function Documentation

◆ TypeName()

TypeName ( "injectedParticle"  )

Runtime type information.

◆ AddToPropertyList()

AddToPropertyList ( particle  ,
" tag"+" soi"+" d"+" (Ux Uy Uz)";   
)

String representation of properties.

◆ clone() [1/2]

virtual autoPtr<particle> clone ( ) const
inlinevirtual

Construct and return a (basic particle) clone.

Reimplemented from particle< Type >.

Definition at line 150 of file injectedParticle.H.

References injectedParticle::injectedParticle().

Here is the call graph for this function:

◆ clone() [2/2]

virtual autoPtr<particle> clone ( const polyMesh mesh) const
inlinevirtual

Construct and return a (basic particle) clone.

Definition at line 156 of file injectedParticle.H.

References injectedParticle::injectedParticle(), and particle< Type >::mesh().

Here is the call graph for this function:

◆ tag() [1/2]

Foam::label tag ( ) const
inline

Return const access to the tag.

Definition at line 67 of file injectedParticleI.H.

References injectedParticle::tag_.

Referenced by injectedParticle::readFields().

Here is the caller graph for this function:

◆ soi() [1/2]

Foam::scalar soi ( ) const
inline

Return const access to the start of injection.

Definition at line 73 of file injectedParticleI.H.

Referenced by injectedParticle::readFields().

Here is the caller graph for this function:

◆ d() [1/2]

Foam::scalar d ( ) const
inline

Return const access to diameter.

Definition at line 79 of file injectedParticleI.H.

Referenced by injectedParticle::readFields().

Here is the caller graph for this function:

◆ U() [1/2]

const Foam::vector & U ( ) const
inline

Return const access to velocity.

Definition at line 85 of file injectedParticleI.H.

Referenced by injectedParticle::readFields().

Here is the caller graph for this function:

◆ tag() [2/2]

Foam::label & tag ( )
inline

Return the tag.

Definition at line 91 of file injectedParticleI.H.

◆ soi() [2/2]

Foam::scalar & soi ( )
inline

Return the start of injection.

Definition at line 97 of file injectedParticleI.H.

◆ d() [2/2]

Foam::scalar & d ( )
inline

Return access to diameter.

Definition at line 103 of file injectedParticleI.H.

◆ U() [2/2]

Foam::vector & U ( )
inline

Return access to velocity.

Definition at line 109 of file injectedParticleI.H.

◆ readFields()

void readFields ( Cloud< injectedParticle > &  c)
static

Read fields.

Definition at line 96 of file injectedParticleIO.C.

References Foam::constant::universal::c, injectedParticle::d(), IOobject::MUST_READ, p, particle< Type >::readFields(), injectedParticle::soi(), injectedParticle::tag(), and injectedParticle::U().

Here is the call graph for this function:

◆ writeProperties()

void writeProperties ( Ostream os,
const wordRes filters,
const word delim,
const bool  namesOnly 
) const

Write individual parcel properties to stream.

Definition at line 176 of file injectedParticleIO.C.

References os(), writeProp, and particle< Type >::writeProperties().

Here is the call graph for this function:

◆ writeFields()

void writeFields ( const Cloud< injectedParticle > &  c)
static

Write fields.

Definition at line 132 of file injectedParticleIO.C.

References Foam::constant::universal::c, IOobject::NO_READ, p, U, particle< Type >::writeFields(), particle< Type >::writeLagrangianCoordinates, and particle< Type >::writeLagrangianPositions.

Here is the call graph for this function:

◆ readObjects()

void readObjects ( Cloud< injectedParticle > &  c,
const objectRegistry obr 
)
static

Read particle fields as objects from the obr registry.

Definition at line 199 of file injectedParticleIO.C.

References Foam::constant::universal::c, p, particle< Type >::readObjects(), and U.

Referenced by injectedParticleCloud::readObjects().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ writeObjects()

void writeObjects ( const Cloud< injectedParticle > &  c,
objectRegistry obr 
)
static

Write particle fields as objects into the obr registry.

Definition at line 228 of file injectedParticleIO.C.

References Foam::constant::universal::c, p, U, and particle< Type >::writeObjects().

Referenced by injectedParticleCloud::writeObjects().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ writePosition()

void writePosition ( Ostream os) const
virtual

Write the particle position and cell.

Note: This uses the local particle position, and bypasses the barycentric description

Reimplemented from particle< Type >.

Definition at line 257 of file injectedParticleIO.C.

References IOstreamOption::ASCII, IOstream::check(), IOstreamOption::format(), FUNCTION_NAME, os(), p, s, token::SPACE, and OBJstream::write().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<< ( Ostream ,
const injectedParticle  
)
friend

Member Data Documentation

◆ position_

point position_
protected

Position.

Definition at line 74 of file injectedParticle.H.

◆ tag_

label tag_
protected

Tag.

Definition at line 77 of file injectedParticle.H.

Referenced by injectedParticle::tag().

◆ soi_

scalar soi_
protected

Start of injection [s].

Definition at line 80 of file injectedParticle.H.

◆ d_

scalar d_
protected

Diameter [m].

Definition at line 83 of file injectedParticle.H.

◆ U_

vector U_
protected

Velocity [m/s].

Definition at line 86 of file injectedParticle.H.

◆ sizeofFields

const std::size_t sizeofFields
static

Size in bytes of the fields.

Definition at line 94 of file injectedParticle.H.

Referenced by Foam::operator<<().


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