DSMC parcel class. More...

Inheritance diagram for DSMCParcel< ParcelType >:

Collaboration diagram for DSMCParcel< ParcelType >:

Classes
class	constantProperties
	Class to hold DSMC particle constant properties. More...

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

Public Types
typedef ParcelType::trackingData	trackingData
	Use base tracking data. More...

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

	DSMCParcel (const polyMesh &mesh, const barycentric &coordinates, const label celli, const label tetFacei, const label tetPti, const vector &U, const scalar Ei, const label typeId)
	Construct from components. More...

	DSMCParcel (const polyMesh &mesh, const vector &position, const label celli, const vector &U, const scalar Ei, const label typeId)
	Construct from a position and a cell, searching for the rest of the. More...

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

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

label	typeId () const
	Return type id. More...

const vector &	U () const
	Return const access to velocity. More...

scalar	Ei () const
	Return const access to internal energy. More...

vector &	U ()
	Return access to velocity. More...

scalar &	Ei ()
	Return access to internal energy. More...

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

template<class TrackCloudType >
bool	hitPatch (TrackCloudType &, trackingData &)
	Overridable function to handle the particle hitting a patch. More...

template<class TrackCloudType >
void	hitProcessorPatch (TrackCloudType &, trackingData &)
	Overridable function to handle the particle hitting a. More...

template<class TrackCloudType >
void	hitWallPatch (TrackCloudType &, trackingData &)
	Overridable function to handle the particle hitting a wallPatch. More...

virtual void	transformProperties (const tensor &T)
	Transform the physical properties of the particle. More...

virtual void	transformProperties (const vector &separation)
	Transform the physical properties of the particle. More...

Static Public Member Functions
static void	readFields (Cloud< DSMCParcel< ParcelType >> &c)

static void	writeFields (const Cloud< DSMCParcel< ParcelType >> &c)

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

Protected Attributes
vector	U_
	Velocity of Parcel [m/s]. More...

scalar	Ei_
	Internal energy of the Parcel, covering all non-translational. More...

label	typeId_
	Parcel type id. More...

Friends
class	Cloud< ParcelType >

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

Detailed Description

template<class ParcelType>
class Foam::DSMCParcel< ParcelType >

DSMC parcel class.

Source files

Definition at line 50 of file DSMCParcel.H.

Member Typedef Documentation

◆ trackingData

typedef ParcelType::trackingData trackingData

Use base tracking data.

Definition at line 156 of file DSMCParcel.H.

Constructor & Destructor Documentation

◆ DSMCParcel() [1/3]

DSMCParcel	(	const polyMesh &	mesh,
		const barycentric &	coordinates,
		const label	celli,
		const label	tetFacei,
		const label	tetPti,
		const vector &	U,
		const scalar	Ei,
		const label	typeId
	)

inline

Construct from components.

Definition at line 48 of file DSMCParcelI.H.

◆ DSMCParcel() [2/3]

DSMCParcel	(	const polyMesh &	mesh,
		const vector &	position,
		const label	celli,
		const vector &	U,
		const scalar	Ei,
		const label	typeId
	)

inline

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

required topology

Definition at line 68 of file DSMCParcelI.H.

◆ DSMCParcel() [3/3]

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

Construct from Istream.

Definition at line 40 of file DSMCParcelIO.C.

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

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "DSMCParcel< ParcelType >" )

Runtime type information.

◆ clone()

virtual autoPtr<particle> clone ( ) const

inlinevirtual

Construct and return a clone.

Definition at line 239 of file DSMCParcel.H.

◆ typeId()

Foam::label typeId ( ) const

inline

Return type id.

Definition at line 129 of file DSMCParcelI.H.

References DSMCParcel< ParcelType >::typeId_.

◆ U() [1/2]

const Foam::vector & U ( ) const

inline

Return const access to velocity.

Definition at line 136 of file DSMCParcelI.H.

References DSMCParcel< ParcelType >::U_.

◆ Ei() [1/2]

Foam::scalar Ei ( ) const

inline

Return const access to internal energy.

Definition at line 143 of file DSMCParcelI.H.

References DSMCParcel< ParcelType >::Ei_.

◆ U() [2/2]

Foam::vector & U ( )

inline

Return access to velocity.

Definition at line 150 of file DSMCParcelI.H.

References DSMCParcel< ParcelType >::U_.

◆ Ei() [2/2]

Foam::scalar & Ei ( )

inline

Return access to internal energy.

Definition at line 157 of file DSMCParcelI.H.

References DSMCParcel< ParcelType >::Ei_.

◆ move()

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

Move the parcel.

Definition at line 29 of file DSMCParcel.C.

References Foam::meshTools::constrainDirection(), f(), mesh, and p.

Here is the call graph for this function:

◆ hitPatch()

bool hitPatch	(	TrackCloudType &	,
		trackingData &
	)

Overridable function to handle the particle hitting a patch.

Executed before other patch-hitting functions

Definition at line 70 of file DSMCParcel.C.

◆ hitProcessorPatch()

void hitProcessorPatch	(	TrackCloudType &	,
		trackingData &	td
	)

Overridable function to handle the particle hitting a.

processorPatch

Definition at line 79 of file DSMCParcel.C.

◆ hitWallPatch()

void hitWallPatch	(	TrackCloudType &	cloud,
		trackingData &
	)

Overridable function to handle the particle hitting a wallPatch.

Definition at line 91 of file DSMCParcel.C.

References TimeState::deltaTValue(), polyPatch::faceAreas(), Foam::mag(), DSMCParcel< ParcelType >::constantProperties::mass(), Foam::max(), mesh, Foam::normalised(), Foam::foamVersion::patch, objectRegistry::time(), and polyPatch::whichFace().

Here is the call graph for this function:

◆ transformProperties() [1/2]

void transformProperties ( const tensor & T )

virtual

Transform the physical properties of the particle.

according to the given transformation tensor

Definition at line 181 of file DSMCParcel.C.

References T, and Foam::transform().

Here is the call graph for this function:

◆ transformProperties() [2/2]

void transformProperties ( const vector & separation )

virtual

Transform the physical properties of the particle.

according to the given separation vector

Definition at line 190 of file DSMCParcel.C.

◆ readFields()

void readFields ( Cloud< DSMCParcel< ParcelType >> & c )

static

Definition at line 81 of file DSMCParcelIO.C.

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

Here is the call graph for this function:

◆ writeFields()

void writeFields ( const Cloud< DSMCParcel< ParcelType >> & c )

static

Definition at line 113 of file DSMCParcelIO.C.

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

Here is the call graph for this function:

Friends And Related Function Documentation

◆ Cloud< ParcelType >

friend class Cloud< ParcelType >

friend

Definition at line 190 of file DSMCParcel.H.

◆ operator

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

friend

Member Data Documentation

◆ sizeofFields

const std::size_t sizeofFields

static

Size in bytes of the fields.

Definition at line 75 of file DSMCParcel.H.

◆ U_

vector U_

protected

Velocity of Parcel [m/s].

Definition at line 168 of file DSMCParcel.H.

Referenced by DSMCParcel< ParcelType >::U().

◆ Ei_

scalar Ei_

protected

Internal energy of the Parcel, covering all non-translational.

degrees of freedom [J]

Definition at line 175 of file DSMCParcel.H.

Referenced by DSMCParcel< ParcelType >::Ei().

◆ typeId_

label typeId_

protected

Parcel type id.

Definition at line 180 of file DSMCParcel.H.

Referenced by DSMCParcel< ParcelType >::typeId().

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

src/lagrangian/DSMC/parcels/Templates/DSMCParcel/DSMCParcel.H
src/lagrangian/DSMC/parcels/Templates/DSMCParcel/DSMCParcel.C
src/lagrangian/DSMC/parcels/Templates/DSMCParcel/DSMCParcelI.H
src/lagrangian/DSMC/parcels/Templates/DSMCParcel/DSMCParcelIO.C

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Friends

Detailed Description

template<class ParcelType> class Foam::DSMCParcel< ParcelType >

Member Typedef Documentation

◆ trackingData

Constructor & Destructor Documentation

◆ DSMCParcel() [1/3]

◆ DSMCParcel() [2/3]

◆ DSMCParcel() [3/3]

Member Function Documentation

◆ TypeName()

◆ clone()

◆ typeId()

◆ U() [1/2]

◆ Ei() [1/2]

◆ U() [2/2]

◆ Ei() [2/2]

◆ move()

◆ hitPatch()

◆ hitProcessorPatch()

◆ hitWallPatch()

◆ transformProperties() [1/2]

◆ transformProperties() [2/2]

◆ readFields()

◆ writeFields()

Friends And Related Function Documentation

◆ Cloud< ParcelType >

◆ operator

Member Data Documentation

◆ sizeofFields

◆ U_

◆ Ei_

◆ typeId_

template<class ParcelType>
class Foam::DSMCParcel< ParcelType >