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

Collaboration diagram for MPPICParcel:

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

class	TrackingData

Public Member Functions
	TypeName ("MPPICParcel")
	Runtime type information. More...

	AddToPropertyList (ParcelType, "(UCorrectx UCorrecty UCorrectz)")
	String representation of properties. More...

	MPPICParcel (const polyMesh &mesh, const vector &position, const label cellI, const label tetFaceI, const label tetPtI)
	Construct from owner, position, and cloud owner. More...

	MPPICParcel (const polyMesh &mesh, const vector &position, 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)
	Construct from components. More...

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

	MPPICParcel (const MPPICParcel &p)
	Construct as a copy. More...

	MPPICParcel (const MPPICParcel &p, const polyMesh &mesh)
	Construct as a copy. More...

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

virtual autoPtr< particle >	clone (const polyMesh &mesh) const
	Construct and return a (basic particle) clone. More...

const vector &	UCorrect () const
	Return const access to correction velocity. More...

vector &	UCorrect ()
	Return access to correction velocity. More...

template<class TrackData >
bool	move (TrackData &td, const scalar trackTime)
	Move the parcel. More...

Static Public Member Functions
template<class CloudType >
static void	readFields (CloudType &c)
	Read. More...

template<class CloudType >
static void	writeFields (const CloudType &c)
	Write. More...

Protected Attributes
vector	UCorrect_
	Velocity correction due to collisions [m/s]. More...

Static Private Attributes
static const std::size_t	sizeofFields_
	Size in bytes of the fields. More...

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

Detailed Description

Wrapper around kinematic parcel types to add MPPIC modelling.

Source files

Definition at line 52 of file MPPICParcel.H.

Constructor & Destructor Documentation

◆ MPPICParcel() [1/5]

MPPICParcel	(	const polyMesh &	mesh,
		const vector &	position,
		const label	cellI,
		const label	tetFaceI,
		const label	tetPtI
	)

inline

Construct from owner, position, and cloud owner.

Other properties initialised as null

Referenced by MPPICParcel::clone().

Here is the caller graph for this function:

◆ MPPICParcel() [2/5]

MPPICParcel	(	const polyMesh &	mesh,
		const vector &	position,
		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

Construct from components.

◆ MPPICParcel() [3/5]

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

Construct from Istream.

◆ MPPICParcel() [4/5]

MPPICParcel ( const MPPICParcel & p )

Construct as a copy.

◆ MPPICParcel() [5/5]

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

Construct as a copy.

Member Function Documentation

◆ TypeName()

TypeName ( "MPPICParcel" )

Runtime type information.

◆ AddToPropertyList()

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

String representation of properties.

◆ clone() [1/2]

virtual autoPtr<particle> clone ( ) const

inlinevirtual

Construct and return a (basic particle) clone.

Definition at line 226 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

Construct and return a (basic particle) clone.

Definition at line 232 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

Return const access to correction velocity.

Definition at line 81 of file MPPICParcelI.H.

References MPPICParcel::UCorrect_.

◆ UCorrect() [2/2]

Foam::vector & UCorrect ( )

inline

Return access to correction velocity.

Definition at line 88 of file MPPICParcelI.H.

References MPPICParcel::UCorrect_.

◆ move()

bool move	(	TrackData &	td,
		const scalar	trackTime
	)

Move the parcel.

Definition at line 58 of file MPPICParcel.C.

References f(), p, and KinematicParcel::U().

Here is the call graph for this function:

◆ readFields()

void readFields ( CloudType & c )

static

Read.

Definition at line 78 of file MPPICParcelIO.C.

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

Here is the call graph for this function:

◆ writeFields()

void writeFields ( const CloudType & c )

static

Write.

Definition at line 105 of file MPPICParcelIO.C.

References Foam::constant::universal::c, forAllConstIter(), IOobject::NO_READ, p, and regIOobject::write().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator

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

friend

Field Documentation

◆ sizeofFields_

const std::size_t sizeofFields_

staticprivate

Size in bytes of the fields.

Definition at line 78 of file MPPICParcel.H.

◆ UCorrect_

vector UCorrect_

protected

Velocity correction due to collisions [m/s].

Definition at line 163 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

Data Structures

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ MPPICParcel() [1/5]

◆ MPPICParcel() [2/5]

◆ MPPICParcel() [3/5]

◆ MPPICParcel() [4/5]

◆ MPPICParcel() [5/5]

Member Function Documentation

◆ TypeName()

◆ AddToPropertyList()

◆ clone() [1/2]

◆ clone() [2/2]

◆ UCorrect() [1/2]

◆ UCorrect() [2/2]

◆ move()

◆ readFields()

◆ writeFields()

Friends And Related Function Documentation

◆ operator

Field Documentation

◆ sizeofFields_

◆ UCorrect_