Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
wallBoundedStreamLineParticle Class Reference

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

Inheritance diagram for wallBoundedStreamLineParticle:
Inheritance graph
[legend]
Collaboration diagram for wallBoundedStreamLineParticle:
Collaboration graph
[legend]

Classes

class  iNew
 
class  trackingData
 

Public Member Functions

 wallBoundedStreamLineParticle (const polyMesh &c, const point &position, const label celli, const label tetFacei, const label tetPti, const label meshEdgeStart, const label diagEdge, const bool trackForward, const label lifeTime)
 
 wallBoundedStreamLineParticle (const polyMesh &c, Istream &is, bool readFields=true, bool newFormat=true)
 
 wallBoundedStreamLineParticle (const wallBoundedStreamLineParticle &p)
 
autoPtr< particle > clone () const
 
template<class TrackCloudType >
bool move (TrackCloudType &cloud, trackingData &td, const scalar trackTime)
 
- Public Member Functions inherited from wallBoundedParticle
 wallBoundedParticle (const polyMesh &c, const point &position, const label celli, const label tetFacei, const label tetPti, const label meshEdgeStart, const label diagEdge)
 
 wallBoundedParticle (const polyMesh &c, Istream &is, bool readFields=true, bool newFormat=true)
 
 wallBoundedParticle (const wallBoundedParticle &p)
 
label meshEdgeStart () const
 
label diagEdge () const
 
template<class TrackCloudType >
scalar trackToEdge (TrackCloudType &cloud, trackingData &td, const vector &endPosition)
 
template<class TrackCloudType >
void patchInteraction (TrackCloudType &cloud, trackingData &td, const scalar trackFraction)
 
template<class TrackCloudType >
void hitProcessorPatch (TrackCloudType &cloud, trackingData &td)
 
template<class TrackCloudType >
void hitWallPatch (TrackCloudType &cloud, trackingData &td)
 
InfoProxy< wallBoundedParticle > info () const
 
template<class TrackCloudType >
Foam::scalar trackToEdge (TrackCloudType &cloud, trackingData &td, const vector &endPosition)
 
template<class TrackCloudType >
void readFields (TrackCloudType &c)
 
template<class TrackCloudType >
void writeFields (const TrackCloudType &c)
 
- Public Member Functions inherited from particle< Type >
 TypeName ("particle")
 
 particle (const polyMesh &mesh, const barycentric &coordinates, const label celli, const label tetFacei, const label tetPti)
 
 particle (const polyMesh &mesh, const vector &position, const label celli=-1)
 
 particle (const polyMesh &mesh, const vector &position, const label celli, const label tetFacei, const label tetPti, const bool doLocate=true)
 
 particle (const polyMesh &mesh, Istream &, bool readFields=true, bool newFormat=true)
 
 particle (const particle &p)
 
 particle (const particle &p, const polyMesh &mesh)
 
virtual ~particle ()=default
 
label getNewParticleID () const
 
const polyMesh & mesh () const
 
const barycentric & coordinates () const
 
label cell () const
 
label & cell ()
 
label tetFace () const
 
label & tetFace ()
 
label tetPt () const
 
label & tetPt ()
 
label face () const
 
label & face ()
 
scalar stepFraction () const
 
scalar & stepFraction ()
 
label origProc () const
 
label & origProc ()
 
label origId () const
 
label & origId ()
 
Pair< scalar > stepFractionSpan () const
 
scalar currentTimeFraction () const
 
tetIndices currentTetIndices () const
 
barycentricTensor currentTetTransform () const
 
vector normal () const
 
bool onFace () const
 
bool onInternalFace () const
 
bool onBoundaryFace () const
 
label patch () const
 
vector position () const
 
void reset ()
 
scalar track (const vector &displacement, const scalar fraction)
 
scalar trackToFace (const vector &displacement, const scalar fraction)
 
scalar trackToTri (const vector &displacement, const scalar fraction, label &tetTriI)
 
scalar trackToStationaryTri (const vector &displacement, const scalar fraction, label &tetTriI)
 
scalar trackToMovingTri (const vector &displacement, const scalar fraction, label &tetTriI)
 
template<class TrackCloudType >
void hitFace (const vector &direction, TrackCloudType &cloud, trackingData &td)
 
template<class TrackCloudType >
void trackToAndHitFace (const vector &direction, const scalar fraction, TrackCloudType &cloud, trackingData &td)
 
vector deviationFromMeshCentre () const
 
void patchData (vector &n, vector &U) const
 
virtual void transformProperties (const tensor &T)
 
virtual void transformProperties (const vector &separation)
 
void prepareForParallelTransfer ()
 
void correctAfterParallelTransfer (const label patchi, trackingData &td)
 
void prepareForInteractionListReferral (const vectorTensorTransform &transform)
 
void correctAfterInteractionListReferral (const label celli)
 
label procTetPt (const polyMesh &procMesh, const label procCell, const label procTetFace) const
 
void autoMap (const vector &position, const mapPolyMesh &mapper)
 
void relocate (const point &position, const label celli=-1)
 
void writeProperties (Ostream &os, const wordRes &filters, const word &delim, const bool namesOnly) const
 
void writeCoordinates (Ostream &os) const
 
virtual void writePosition (Ostream &os) const
 

Static Public Member Functions

static void readFields (Cloud< wallBoundedStreamLineParticle > &)
 
static void writeFields (const Cloud< wallBoundedStreamLineParticle > &)
 
- Static Public Member Functions inherited from wallBoundedParticle
template<class CloudType >
static void readFields (CloudType &)
 
template<class CloudType >
static void writeFields (const CloudType &)
 
- 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)
 
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)
 
template<class TrackCloudType >
static void writeFields (const TrackCloudType &c)
 
template<class CloudType >
static void readObjects (CloudType &c, const objectRegistry &obr)
 
template<class CloudType >
static void writeObjects (const CloudType &c, objectRegistry &obr)
 

Protected Member Functions

vector interpolateFields (const trackingData &td, const point &position, const label celli, const label facei)
 
vector sample (trackingData &td)
 
- Protected Member Functions inherited from wallBoundedParticle
edge currentEdge () const
 
void crossEdgeConnectedFace (const label &celli, label &tetFacei, label &tetPti, const edge &e)
 
void crossEdgeConnectedFace (const edge &meshEdge)
 
void crossDiagonalEdge ()
 
scalar trackFaceTri (const vector &n, const vector &endPosition, label &)
 
bool isTriAlongTrack (const vector &n, const point &endPosition) const
 
- Protected Member Functions inherited from particle< Type >
template<class TrackCloudType >
bool hitPatch (TrackCloudType &, trackingData &)
 
template<class TrackCloudType >
void hitWedgePatch (TrackCloudType &, trackingData &)
 
template<class TrackCloudType >
void hitSymmetryPlanePatch (TrackCloudType &, trackingData &)
 
template<class TrackCloudType >
void hitSymmetryPatch (TrackCloudType &, trackingData &)
 
template<class TrackCloudType >
void hitCyclicPatch (TrackCloudType &, trackingData &)
 
template<class TrackCloudType >
void hitCyclicAMIPatch (TrackCloudType &, trackingData &, const vector &)
 
template<class TrackCloudType >
void hitCyclicACMIPatch (TrackCloudType &, trackingData &, const vector &)
 
template<class TrackCloudType >
void hitProcessorPatch (TrackCloudType &, trackingData &)
 
template<class TrackCloudType >
void hitWallPatch (TrackCloudType &, trackingData &)
 

Protected Attributes

bool trackForward_
 
label lifeTime_
 
DynamicList< point > sampledPositions_
 
List< DynamicList< scalar > > sampledScalars_
 
List< DynamicList< vector > > sampledVectors_
 
- Protected Attributes inherited from wallBoundedParticle
point localPosition_
 
label meshEdgeStart_
 
label diagEdge_
 

Friends

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

Additional Inherited Members

- Static Public Attributes inherited from wallBoundedParticle
static const std::size_t sizeofFields_
 
- Static Public Attributes inherited from particle< Type >
static string propertyList_ = Foam::particle::propertyList()
 
static label particleCount_ = 0
 
static bool writeLagrangianCoordinates = true
 
static bool writeLagrangianPositions
 

Detailed Description

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

Source files

Definition at line 62 of file wallBoundedStreamLineParticle.H.

Constructor & Destructor Documentation

◆ wallBoundedStreamLineParticle() [1/3]

wallBoundedStreamLineParticle ( const polyMesh &  c,
const point &  position,
const label  celli,
const label  tetFacei,
const label  tetPti,
const label  meshEdgeStart,
const label  diagEdge,
const bool  trackForward,
const label  lifeTime 
)

Definition at line 116 of file wallBoundedStreamLineParticle.C.

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

Here is the caller graph for this function:

◆ wallBoundedStreamLineParticle() [2/3]

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

Definition at line 144 of file wallBoundedStreamLineParticle.C.

References IOstream::check(), forAll, FUNCTION_NAME, Foam::readFields(), and List::setSize().

Here is the call graph for this function:

◆ wallBoundedStreamLineParticle() [3/3]

wallBoundedStreamLineParticle ( const wallBoundedStreamLineParticle &  p)

Definition at line 178 of file wallBoundedStreamLineParticle.C.

Member Function Documentation

◆ interpolateFields()

Foam::vector interpolateFields ( const trackingData &  td,
const point &  position,
const label  celli,
const label  facei 
)
protected

Definition at line 28 of file wallBoundedStreamLineParticle.C.

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

Here is the call graph for this function:

◆ sample()

Foam::vector sample ( trackingData &  td)
protected

Definition at line 87 of file wallBoundedStreamLineParticle.C.

References Foam::mag(), and U.

Here is the call graph for this function:

◆ clone()

autoPtr<particle> clone ( ) const
inlinevirtual

Reimplemented from wallBoundedParticle.

Definition at line 188 of file wallBoundedStreamLineParticle.H.

References wallBoundedStreamLineParticle::wallBoundedStreamLineParticle().

Here is the call graph for this function:

◆ move()

bool move ( TrackCloudType &  cloud,
trackingData &  td,
const scalar  trackTime 
)

Definition at line 26 of file wallBoundedStreamLineParticleTemplates.C.

References wallBoundedStreamLineParticle::trackingData::allPositions_, wallBoundedStreamLineParticle::trackingData::allScalars_, wallBoundedStreamLineParticle::trackingData::allVectors_, Foam::expressions::patchExpr::debug, Foam::endl(), forAll, particle< Type >::trackingData::keepParticle, mesh, p, Foam::Pout, particle< Type >::trackingData::switchProcessor, wallBoundedStreamLineParticle::trackingData::trackLength_, List::transfer(), and U.

Here is the call graph for this function:

◆ readFields()

void readFields ( Cloud< wallBoundedStreamLineParticle > &  c)
static

Definition at line 194 of file wallBoundedStreamLineParticle.C.

References Foam::constant::universal::c, p, and Foam::readFields().

Here is the call graph for this function:

◆ writeFields()

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

Definition at line 228 of file wallBoundedStreamLineParticle.C.

References Foam::constant::universal::c, p, and Foam::writeFields().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<<

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

Member Data Documentation

◆ trackForward_

bool trackForward_
protected

Definition at line 129 of file wallBoundedStreamLineParticle.H.

◆ lifeTime_

label lifeTime_
protected

Definition at line 132 of file wallBoundedStreamLineParticle.H.

◆ sampledPositions_

DynamicList<point> sampledPositions_
protected

Definition at line 135 of file wallBoundedStreamLineParticle.H.

◆ sampledScalars_

List<DynamicList<scalar> > sampledScalars_
protected

Definition at line 138 of file wallBoundedStreamLineParticle.H.

◆ sampledVectors_

List<DynamicList<vector> > sampledVectors_
protected

Definition at line 141 of file wallBoundedStreamLineParticle.H.

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17