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

Collaboration diagram for MPPICParcel< ParcelType >:

Classes
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 barycentric &coordinates, const label celli, const label tetFacei, const label tetPti)
	Construct from mesh, coordinates and topology. More...

	MPPICParcel (const polyMesh &mesh, const vector &position, const label celli)
	Construct from a position and a cell, searching for the rest of the. More...

	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)
	Construct from components. More...

	MPPICParcel (const polyMesh &mesh, Istream &is, bool readFields=true, bool newFormat=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 TrackCloudType >
bool	move (TrackCloudType &cloud, trackingData &td, const scalar trackTime)
	Move the parcel. More...

void	writeProperties (Ostream &os, const wordRes &filters, const word &delim, const bool namesOnly=false) const
	Write individual parcel properties to stream. 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...

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

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

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

Detailed Description

template<class ParcelType>
class Foam::MPPICParcel< ParcelType >

Wrapper around kinematic parcel types to add MPPIC modelling.

Source files

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

Construct from mesh, coordinates and topology.

Other properties initialised as null

Definition at line 32 of file MPPICParcelI.H.

Referenced by MPPICParcel< ParcelType >::clone().

Here is the caller graph for this function:

◆ MPPICParcel() [2/6]

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

inline

Construct from a position and a cell, searching for the rest of the.

required topology. Other properties are initialised as null.

Definition at line 47 of file MPPICParcelI.H.

◆ 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

Construct from components.

Definition at line 60 of file MPPICParcelI.H.

◆ MPPICParcel() [4/6]

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

Construct from Istream.

Definition at line 51 of file MPPICParcelIO.C.

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

Here is the call graph for this function:

◆ MPPICParcel() [5/6]

MPPICParcel ( const MPPICParcel< ParcelType > & p )

Construct as a copy.

◆ MPPICParcel() [6/6]

MPPICParcel	(	const MPPICParcel< ParcelType > &	p,
		const polyMesh &	mesh
	)

Construct as a copy.

Member Function Documentation

◆ TypeName()

TypeName ( "MPPICParcel< ParcelType >" )

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 241 of file MPPICParcel.H.

References MPPICParcel< ParcelType >::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 247 of file MPPICParcel.H.

References mesh, and MPPICParcel< ParcelType >::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 96 of file MPPICParcelI.H.

◆ UCorrect() [2/2]

Foam::vector & UCorrect ( )

inline

Return access to correction velocity.

Definition at line 103 of file MPPICParcelI.H.

◆ move()

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

Move the parcel.

Definition at line 60 of file MPPICParcel.C.

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

Here is the call graph for this function:

◆ readFields()

void readFields ( CloudType & c )

static

Read.

Definition at line 89 of file MPPICParcelIO.C.

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

Here is the call graph for this function:

◆ writeFields()

void writeFields ( const CloudType & c )

static

Write.

Definition at line 114 of file MPPICParcelIO.C.

References Foam::constant::universal::c, 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

Write individual parcel properties to stream.

Definition at line 138 of file MPPICParcelIO.C.

References writeProp.

◆ readObjects()

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

static

Read particle fields as objects from the obr registry.

Definition at line 160 of file MPPICParcelIO.C.

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

◆ writeObjects()

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

static

Write particle fields as objects into the obr registry.

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

Size in bytes of the fields.

Definition at line 84 of file MPPICParcel.H.

◆ UCorrect_

vector UCorrect_

protected

Velocity correction due to collisions [m/s].

Definition at line 168 of file MPPICParcel.H.

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

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Friends

Detailed Description

template<class ParcelType> class Foam::MPPICParcel< ParcelType >

Constructor & Destructor Documentation

◆ MPPICParcel() [1/6]

◆ MPPICParcel() [2/6]

◆ MPPICParcel() [3/6]

◆ MPPICParcel() [4/6]

◆ MPPICParcel() [5/6]

◆ MPPICParcel() [6/6]

Member Function Documentation

◆ TypeName()

◆ AddToPropertyList()

◆ clone() [1/2]

◆ clone() [2/2]

◆ UCorrect() [1/2]

◆ UCorrect() [2/2]

◆ move()

◆ readFields()

◆ writeFields()

◆ writeProperties()

◆ readObjects()

◆ writeObjects()

Friends And Related Function Documentation

◆ operator

Member Data Documentation

◆ sizeofFields

◆ UCorrect_

template<class ParcelType>
class Foam::MPPICParcel< ParcelType >