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

#include <MPPICParcel.H>

Inheritance diagram for MPPICParcel< ParcelType >:

[legend]

Collaboration diagram for MPPICParcel< ParcelType >:

[legend]

Classes
class	trackingData
class	iNew
	Factory class to read-construct particles (for parallel transfer). More...

Public Member Functions
	TypeName ("MPPICParcel")
	Runtime type information.
	AddToPropertyList (ParcelType, " (UCorrectx UCorrecty UCorrectz)")
	String representation of properties.
	MPPICParcel (const polyMesh &mesh, const barycentric &coordinates, const label celli, const label tetFacei, const label tetPti)
	Construct from mesh, coordinates and topology.
	MPPICParcel (const polyMesh &mesh, const vector &position, const label celli)
	Construct from a position and a cell, searching for the rest of the.
	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.
	MPPICParcel (const polyMesh &mesh, Istream &is, bool readFields=true, bool newFormat=true)
	Construct from Istream.
	MPPICParcel (const MPPICParcel &p)
	Construct as a copy.
	MPPICParcel (const MPPICParcel &p, const polyMesh &mesh)
	Construct as a copy.
virtual autoPtr< particle >	clone () const
	Return a (basic particle) clone.
virtual autoPtr< particle >	clone (const polyMesh &mesh) const
	Return a (basic particle) clone.
const vector &	UCorrect () const
	Return const access to correction velocity.
vector &	UCorrect ()
	Return access to correction velocity.
template<class TrackCloudType>
bool	move (TrackCloudType &cloud, trackingData &td, const scalar trackTime)
	Move the parcel.
void	writeProperties (Ostream &os, const wordRes &filters, const word &delim, const bool namesOnly=false) const
	Write individual parcel properties to stream.

Static Public Member Functions
template<class CloudType>
static void	readFields (CloudType &c)
	Read.
template<class CloudType>
static void	writeFields (const CloudType &c)
	Write.
template<class CloudType>
static void	readObjects (CloudType &c, const objectRegistry &obr)
	Read particle fields as objects from the obr registry.
template<class CloudType>
static void	writeObjects (const CloudType &c, objectRegistry &obr)
	Write particle fields as objects into the obr registry.

Static Public Attributes
static const std::size_t	sizeofFields
	Size in bytes of the fields.

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

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

Constructor & Destructor Documentation

◆ MPPICParcel() [1/6]

template<class ParcelType>

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 24 of file MPPICParcelI.H.

References coordinates(), UCorrect_, and Foam::Zero.

Referenced by MPPICParcel< ParcelType >::iNew::operator()(), readFields(), readObjects(), writeFields(), and writeObjects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MPPICParcel() [2/6]

template<class ParcelType>

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 39 of file MPPICParcelI.H.

References UCorrect_, and Foam::Zero.

◆ MPPICParcel() [3/6]

template<class ParcelType>

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 52 of file MPPICParcelI.H.

References coordinates(), and UCorrect_.

Here is the call graph for this function:

◆ MPPICParcel() [4/6]

template<class ParcelType>

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

Construct from Istream.

Definition at line 43 of file MPPICParcelIO.C.

References IOstreamOption::ASCII, IOstream::check(), IOstream::fatalCheckNativeSizes(), IOstreamOption::format(), FUNCTION_NAME, mesh, Istream::read(), readFields(), sizeofFields, UCorrect_, and Foam::Zero.

Here is the call graph for this function:

◆ MPPICParcel() [5/6]

template<class ParcelType>

MPPICParcel ( const MPPICParcel< ParcelType > & p )

Construct as a copy.

◆ MPPICParcel() [6/6]

template<class ParcelType>

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

Construct as a copy.

Member Function Documentation

◆ TypeName()

template<class ParcelType>

TypeName ( "MPPICParcel< ParcelType >" )

Runtime type information.

◆ AddToPropertyList()

template<class ParcelType>

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

String representation of properties.

◆ clone() [1/2]

template<class ParcelType>

virtual autoPtr< particle > clone ( ) const

inlinevirtual

Return a (basic particle) clone.

Definition at line 289 of file MPPICParcel.H.

◆ clone() [2/2]

template<class ParcelType>

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

inlinevirtual

Return a (basic particle) clone.

Definition at line 297 of file MPPICParcel.H.

◆ UCorrect() [1/2]

template<class ParcelType>

const Foam::vector & UCorrect ( ) const

inline

Return const access to correction velocity.

Definition at line 89 of file MPPICParcelI.H.

References UCorrect_.

Referenced by readFields(), readObjects(), writeFields(), and writeObjects().

Here is the caller graph for this function:

◆ UCorrect() [2/2]

template<class ParcelType>

Foam::vector & UCorrect ( )

inline

Return access to correction velocity.

Definition at line 96 of file MPPICParcelI.H.

References UCorrect_.

◆ move()

template<class ParcelType>

template<class TrackCloudType>

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

Move the parcel.

Definition at line 52 of file MPPICParcel.C.

References f(), p, td(), MPPICParcel< ParcelType >::trackingData::tpCorrectTrack, MPPICParcel< ParcelType >::trackingData::tpDampingNoTrack, MPPICParcel< ParcelType >::trackingData::tpLinearTrack, MPPICParcel< ParcelType >::trackingData::tpPackingNoTrack, and U.

Here is the call graph for this function:

◆ readFields()

template<class ParcelType>

template<class CloudType>

void readFields ( CloudType & c )

static

Read.

Definition at line 75 of file MPPICParcelIO.C.

References MPPICParcel(), IOobjectOption::MUST_READ, p, and UCorrect().

Referenced by MPPICParcel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeFields()

template<class ParcelType>

template<class CloudType>

void writeFields ( const CloudType & c )

static

Write.

Definition at line 100 of file MPPICParcelIO.C.

References MPPICParcel(), IOobjectOption::NO_READ, p, and UCorrect().

Here is the call graph for this function:

◆ writeProperties()

template<class ParcelType>

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

Write individual parcel properties to stream.

Definition at line 123 of file MPPICParcelIO.C.

References os(), UCorrect_, and writeProp.

Here is the call graph for this function:

◆ readObjects()

template<class ParcelType>

template<class CloudType>

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

static

Read particle fields as objects from the obr registry.

Definition at line 145 of file MPPICParcelIO.C.

References cloud::lookupIOField(), MPPICParcel(), p, and UCorrect().

Here is the call graph for this function:

◆ writeObjects()

template<class ParcelType>

template<class CloudType>

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

static

Write particle fields as objects into the obr registry.

Definition at line 170 of file MPPICParcelIO.C.

References cloud::createIOField(), MPPICParcel(), p, and UCorrect().

Here is the call graph for this function:

◆ operator<<

template<class ParcelType>

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

friend

Member Data Documentation

◆ sizeofFields

template<class ParcelType>

const std::size_t sizeofFields

static

Size in bytes of the fields.

Definition at line 82 of file MPPICParcel.H.

Referenced by MPPICParcel().

◆ UCorrect_

template<class ParcelType>

vector UCorrect_

protected

Velocity correction due to collisions [m/s].

Definition at line 196 of file MPPICParcel.H.

Referenced by MPPICParcel(), MPPICParcel(), MPPICParcel(), MPPICParcel(), UCorrect(), UCorrect(), and writeProperties().

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

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 Symbol Documentation

◆ operator<<

Member Data Documentation

◆ sizeofFields

◆ UCorrect_