MPPICParcel Class Reference

Wrapper around kinematic parcel types to add MPPIC modelling. More...

Collaboration diagram for MPPICParcel:

Classes
class	iNew
class	trackingData

Public Member Functions
	TypeName ("MPPICParcel")
	AddToPropertyList (ParcelType, " (UCorrectx UCorrecty UCorrectz)")
	MPPICParcel (const polyMesh &mesh, const barycentric &coordinates, const label celli, const label tetFacei, const label tetPti)
	MPPICParcel (const polyMesh &mesh, const vector &position, const label celli)
	MPPICParcel (const polyMesh &mesh, const barycentric &coordinates, const label celli, const label tetFacei, const label tetPti, const label typeId, const scalar nParticle0, const scalar d0, const scalar dTarget0, const vector &U0, const vector &UCorrect0, const typename ParcelType::constantProperties &constProps)
	MPPICParcel (const polyMesh &mesh, Istream &is, bool readFields=true, bool newFormat=true)
	MPPICParcel (const MPPICParcel &p)
	MPPICParcel (const MPPICParcel &p, const polyMesh &mesh)
virtual autoPtr< particle >	clone () const
virtual autoPtr< particle >	clone (const polyMesh &mesh) const
const vector &	UCorrect () const
vector &	UCorrect ()
template<class TrackCloudType >
bool	move (TrackCloudType &cloud, trackingData &td, const scalar trackTime)
void	writeProperties (Ostream &os, const wordRes &filters, const word &delim, const bool namesOnly=false) const

Static Public Member Functions
template<class CloudType >
static void	readFields (CloudType &c)
template<class CloudType >
static void	writeFields (const CloudType &c)
template<class CloudType >
static void	readObjects (CloudType &c, const objectRegistry &obr)
template<class CloudType >
static void	writeObjects (const CloudType &c, objectRegistry &obr)

Static Public Attributes
static const std::size_t	sizeofFields

Protected Attributes
vector	UCorrect_

Friends
Ostream &	operator (Ostream &, const MPPICParcel< ParcelType > &)

Detailed Description

Wrapper around kinematic parcel types to add MPPIC modelling.

Source files

• MPPICParcel.H
• MPPICParcelI.H
• MPPICParcelTrackingDataI.H
• MPPICParcel.C
• MPPICParcelIO.C

Definition at line 54 of file MPPICParcel.H.

Constructor & Destructor Documentation

MPPICParcel() [1/6]

MPPICParcel ( const polyMesh &  mesh, const barycentric &  coordinates, const label  celli, const label  tetFacei, const label  tetPti  )

inline

Referenced by MPPICParcel::clone().

Here is the caller graph for this function:

MPPICParcel() [2/6]

MPPICParcel ( const polyMesh &  mesh, const vector &  position, const label  celli  )

inline

MPPICParcel() [3/6]

MPPICParcel ( const polyMesh &  mesh, const barycentric &  coordinates, const label  celli, const label  tetFacei, const label  tetPti, const label  typeId, const scalar  nParticle0, const scalar  d0, const scalar  dTarget0, const vector &  U0, const vector &  UCorrect0, const typename ParcelType::constantProperties &  constProps  )

inline

MPPICParcel() [4/6]

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

MPPICParcel() [5/6]

MPPICParcel

(

const MPPICParcel &

p

)

MPPICParcel() [6/6]

MPPICParcel	(	const MPPICParcel &	p,
		const polyMesh &	mesh
	)

Member Function Documentation

TypeName()

TypeName

(

"MPPICParcel"

)

AddToPropertyList()

AddToPropertyList	(	ParcelType	,
		" (UCorrectx UCorrecty UCorrectz)"
	)

clone() [1/2]

virtual autoPtr<particle> clone ( ) const

inlinevirtual

Definition at line 237 of file MPPICParcel.H.

References MPPICParcel::MPPICParcel().

Here is the call graph for this function:

clone() [2/2]

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

inlinevirtual

Definition at line 243 of file MPPICParcel.H.

References mesh, and MPPICParcel::MPPICParcel().

Here is the call graph for this function:

UCorrect() [1/2]

const Foam::vector & UCorrect ( ) const

inline

Definition at line 89 of file MPPICParcelI.H.

References MPPICParcel::UCorrect_.

UCorrect() [2/2]

Foam::vector & UCorrect ( )

inline

Definition at line 96 of file MPPICParcelI.H.

References MPPICParcel::UCorrect_.

move()

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

Definition at line 53 of file MPPICParcel.C.

References f(), p, MPPICParcel::trackingData::part(), KinematicParcel::trackingData::tpLinearTrack, and KinematicParcel::U().

Here is the call graph for this function:

readFields()

void readFields ( CloudType &  c )

static

Definition at line 82 of file MPPICParcelIO.C.

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

Here is the call graph for this function:

writeFields()

void writeFields ( const CloudType &  c )

static

Definition at line 107 of file MPPICParcelIO.C.

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

Here is the call graph for this function:

writeProperties()

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

Definition at line 131 of file MPPICParcelIO.C.

References os(), and writeProp.

Here is the call graph for this function:

readObjects()

void readObjects ( CloudType &  c, const objectRegistry &  obr  )

static

Definition at line 153 of file MPPICParcelIO.C.

References Foam::constant::universal::c, and p.

writeObjects()

void writeObjects ( const CloudType &  c, objectRegistry &  obr  )

static

Definition at line 177 of file MPPICParcelIO.C.

References Foam::constant::universal::c, and p.

Friends And Related Function Documentation

operator

Ostream& operator ( Ostream &  , const MPPICParcel< ParcelType > &    )

friend

Member Data Documentation

sizeofFields

const std::size_t sizeofFields

static

Definition at line 80 of file MPPICParcel.H.

UCorrect_

vector UCorrect_

protected

Definition at line 164 of file MPPICParcel.H.

Referenced by MPPICParcel::UCorrect().

---

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

• src/lagrangian/intermediate/parcels/Templates/MPPICParcel/MPPICParcel.H
• src/lagrangian/intermediate/parcels/Templates/MPPICParcel/MPPICParcel.C
• src/lagrangian/intermediate/parcels/Templates/MPPICParcel/MPPICParcelI.H
• src/lagrangian/intermediate/parcels/Templates/MPPICParcel/MPPICParcelIO.C