Injection positions specified by a particle number density within a cell set. More...

Inheritance diagram for CellZoneInjection< CloudType >:

Collaboration diagram for CellZoneInjection< CloudType >:

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

	CellZoneInjection (const dictionary &dict, CloudType &owner, const word &modelName)
	Construct from dictionary. More...

	CellZoneInjection (const CellZoneInjection< CloudType > &im)
	Construct copy. More...

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

virtual	~CellZoneInjection ()
	Destructor. More...

virtual void	topoChange ()
	Set injector locations when mesh is updated. More...

virtual scalar	timeEnd () const
	Return the end-of-injection time. More...

virtual scalar	nParcelsToInject (const scalar time0, const scalar time1)
	Number of parcels to introduce relative to SOI. More...

virtual scalar	massToInject (const scalar time0, const scalar time1)
	Parcel mass to introduce relative to SOI. More...

virtual void	setPositionAndCell (const label parcelI, const label nParcels, const scalar time, barycentric &coordinates, label &celli, label &tetFacei, label &tetPti, label &facei)
	Set the injection position and owner cell, tetFace and tetPt. More...

virtual void	setProperties (const label parcelI, const label nParcels, const scalar time, typename CloudType::parcelType::trackingData &td, typename CloudType::parcelType &parcel)
	Set the parcel properties. More...

virtual bool	fullyDescribed () const
	Flag to identify whether model fully describes the parcel. More...

Public Member Functions inherited from InjectionModel< CloudType >
	TypeName ("injectionModel")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, InjectionModel, dictionary,(const dictionary &dict, CloudType &owner, const word &modelType),(dict, owner, modelType))
	Declare runtime constructor selection table. More...

	InjectionModel (CloudType &owner)
	Construct null from owner. More...

	InjectionModel (const dictionary &dict, CloudType &owner, const word &modelName, const word &modelType)
	Construct from dictionary. More...

	InjectionModel (const InjectionModel< CloudType > &im)
	Construct copy. More...

virtual	~InjectionModel ()
	Destructor. More...

scalar	timeStart () const
	Return the start-of-injection time. More...

scalar	massInjected () const
	Return mass of parcels injected (cumulative) More...

label	nParcelsInjected () const
	Return number of parcels injected (cumulative) More...

scalar	averageParcelMass ()
	Return the average injected parcel mass. More...

template<class TrackCloudType >
void	inject (TrackCloudType &cloud, typename CloudType::parcelType::trackingData &td)
	Main injection loop. More...

template<class TrackCloudType >
void	injectSteadyState (TrackCloudType &cloud, typename CloudType::parcelType::trackingData &td)
	Main injection loop - steady-state. More...

virtual void	setProperties (const label parcelI, const label nParcels, const scalar time, typename parcelType::trackingData &td, parcelType &parcel)=0
	Set the parcel properties. More...

virtual void	info (Ostream &os)
	Write injection info to stream. More...

Public Member Functions inherited from CloudSubModelBase< CloudType >
	CloudSubModelBase (CloudType &owner)
	Construct null from owner cloud. More...

	CloudSubModelBase (CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from owner cloud without name. More...

	CloudSubModelBase (const word &modelName, CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from owner cloud with name. More...

	CloudSubModelBase (const CloudSubModelBase< CloudType > &smb)
	Copy constructor. More...

virtual	~CloudSubModelBase ()
	Destructor. More...

const CloudType &	owner () const
	Return const access to the owner cloud. More...

virtual bool	writeTime () const
	Flag to indicate when to write a property. More...

CloudType &	owner ()
	Return non-const access to the owner cloud for manipulation. More...

virtual void	write (Ostream &os) const
	Write. More...

Public Member Functions inherited from subModelBase
	subModelBase (dictionary &properties)
	Construct null. More...

	subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from components without name. More...

	subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from components with name. More...

	subModelBase (const subModelBase &smb)
	Copy constructor. More...

virtual	~subModelBase ()
	Destructor. More...

const word &	modelName () const
	Return const access to the name of the sub-model. More...

const dictionary &	dict () const
	Return const access to the cloud dictionary. More...

const word &	baseName () const
	Return const access to the base name of the sub-model. More...

const word &	modelType () const
	Return const access to the sub-model type. More...

const dictionary &	coeffDict () const
	Return const access to the coefficients dictionary. More...

const dictionary &	properties () const
	Return const access to the properties dictionary. More...

virtual bool	defaultCoeffs (const bool printMsg) const
	Returns true if defaultCoeffs is true and outputs on printMsg. More...

virtual void	cacheFields (const bool store)
	Cache dependent sub-model fields. More...

template<class Type >
Type	getBaseProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
	Retrieve generic property from the base model. More...

template<class Type >
void	getBaseProperty (const word &entryName, Type &value) const
	Retrieve generic property from the base model. More...

template<class Type >
void	setBaseProperty (const word &entryName, const Type &value)
	Add generic property to the base model. More...

template<class Type >
void	getModelProperty (const word &entryName, Type &value) const
	Retrieve generic property from the sub-model. More...

template<class Type >
Type	getModelProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
	Retrieve generic property from the sub-model. More...

template<class Type >
void	setModelProperty (const word &entryName, const Type &value)
	Add generic property to the sub-model. More...

void	operator= (const subModelBase &)=delete
	Disallow default bitwise assignment. More...

Additional Inherited Members
Public Types inherited from InjectionModel< CloudType >
typedef CloudType::parcelType	parcelType
	Convenience typedef for parcelType. More...

Public Types inherited from injectionModel
enum class	uniformParcelSize { nParticle , surfaceArea , volume }
	Enumeration for the parcels' uniform size. More...

Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType	cloudType
	Type of cloud this model was instantiated for. More...

Static Public Member Functions inherited from InjectionModel< CloudType >
static autoPtr< InjectionModel< CloudType > >	New (const dictionary &dict, CloudType &owner)
	Selector with lookup from dictionary. More...

static autoPtr< InjectionModel< CloudType > >	New (const dictionary &dict, const word &modelName, const word &modelType, CloudType &owner)
	Selector with name and type. More...

Static Public Member Functions inherited from injectionModel
static scalar	globalScalar01 (randomGenerator &rndGen)
	Return a scalar uniformly distributed between zero and one. Samples. More...

Static Public Attributes inherited from injectionModel
static const NamedEnum< uniformParcelSize, 3 >	uniformParcelSizeNames_ {"nParticle", "surfaceArea", "volume"}
	Names of the parcels' uniform size. More...

Protected Member Functions inherited from InjectionModel< CloudType >
scalar	readMassTotal (const dictionary &dict, CloudType &owner)
	Read the total mass value for instantaneous injections. More...

scalar	readDuration (const dictionary &dict, CloudType &owner)
	Read the duration for continuous injections. More...

autoPtr< Function1< scalar > >	readMassFlowRate (const dictionary &dict, CloudType &owner, const scalar duration)
	Read the mass flow rate function for continuous injections. More...

autoPtr< Function1< scalar > >	readParcelsPerSecond (const dictionary &dict, CloudType &owner)
	Read the number of parcels injected per second for continuous. More...

label	index () const
	Get the index of this injector. More...

bool	findCellAtPosition (const point &position, barycentric &coordinates, label &celli, label &tetFacei, label &tetPti, bool errorOnNotFound=true)
	Find the cell that contains the supplied position. More...

void	constrainPosition (typename CloudType::parcelType::trackingData &td, typename CloudType::parcelType &parcel)
	Constrain a parcel's position appropriately to the geometric. More...

label	sizeSampleQ () const
	Return the sampling moment to be used by the size distribution. More...

void	setNumberOfParticles (PtrList< parcelType > &parcelPtrs, const scalar mass) const
	Set number of particles to inject given parcel properties. More...

virtual void	preInject (typename parcelType::trackingData &td)
	Pre injection hook. More...

virtual void	postInject (const label parcelsAdded, const scalar massAdded, typename parcelType::trackingData &td)
	Post injection hook. More...

Protected Member Functions inherited from subModelBase
bool	inLine () const
	Flag to indicate whether data is/was read in-line. More...

Protected Attributes inherited from InjectionModel< CloudType >
scalar	SOI_
	Start of injection [s]. More...

scalar	massInjected_
	Total mass injected to date [kg]. More...

label	nParcelsInjected_
	Total number of parcels injected to date. More...

scalar	massDeferred_
	Mass deferred to be injected at a later time step. More...

scalar	nParcelsDeferred_
	Number of parcels deferred to be injected at a later time step. More...

scalar	nParticleFixed_
	Fixed nParticle to assign to parcels. Only valid if. More...

uniformParcelSize	uniformParcelSize_
	Size uniform to all parcels. More...

Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudType &	owner_
	Reference to the cloud. More...

Protected Attributes inherited from subModelBase
const word	modelName_
	Name of the sub-model. More...

dictionary &	properties_
	Reference to properties dictionary e.g. for restart. More...

const dictionary	dict_
	Copy of dictionary used during construction. More...

const word	baseName_
	Name of the sub-model base class. More...

const word	modelType_
	Type of the sub-model. More...

const dictionary	coeffDict_
	Coefficients dictionary. More...

Detailed Description

template<class CloudType>
class Foam::CellZoneInjection< CloudType >

Injection positions specified by a particle number density within a cell set.

User specifies:

Number density of particles in cell set (effective)
Initial parcel velocity

Properties:

Parcel diameters obtained by PDF model
All parcels introduced at SOI

Source files

Definition at line 59 of file CellZoneInjection.H.

Constructor & Destructor Documentation

◆ CellZoneInjection() [1/2]

CellZoneInjection	(	const dictionary &	dict,
		CloudType &	owner,
		const word &	modelName
	)

Construct from dictionary.

Definition at line 155 of file CellZoneInjection.C.

References CellZoneInjection< CloudType >::topoChange().

Here is the call graph for this function:

◆ CellZoneInjection() [2/2]

CellZoneInjection ( const CellZoneInjection< CloudType > & im )

Construct copy.

Definition at line 188 of file CellZoneInjection.C.

◆ ~CellZoneInjection()

~CellZoneInjection

virtual

Destructor.

Definition at line 210 of file CellZoneInjection.C.

Member Function Documentation

◆ TypeName()

TypeName ( "cellZoneInjection" )

Runtime type information.

◆ clone()

virtual autoPtr<InjectionModel<CloudType> > clone ( ) const

inlinevirtual

Construct and return a clone.

Implements InjectionModel< CloudType >.

Definition at line 122 of file CellZoneInjection.H.

◆ topoChange()

void topoChange

virtual

Set injector locations when mesh is updated.

Reimplemented from InjectionModel< CloudType >.

Definition at line 217 of file CellZoneInjection.C.

References polyMesh::cellZones(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, PtrListDictionary< T >::findIndex(), forAll, Foam::Info, fvMesh::mesh(), mesh, Foam::nl, Foam::returnReduce(), List< T >::size(), Foam::sum(), DictionaryBase< IDLListType, T >::toc(), fvMesh::V(), and WarningInFunction.

Referenced by CellZoneInjection< CloudType >::CellZoneInjection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ timeEnd()

Foam::scalar timeEnd

virtual

Return the end-of-injection time.

Implements InjectionModel< CloudType >.

Definition at line 264 of file CellZoneInjection.C.

◆ nParcelsToInject()

Foam::scalar nParcelsToInject	(	const scalar	time0,
		const scalar	time1
	)

virtual

Number of parcels to introduce relative to SOI.

Implements InjectionModel< CloudType >.

Definition at line 272 of file CellZoneInjection.C.

◆ massToInject()

Foam::scalar massToInject	(	const scalar	time0,
		const scalar	time1
	)

virtual

Parcel mass to introduce relative to SOI.

Implements InjectionModel< CloudType >.

Definition at line 291 of file CellZoneInjection.C.

◆ setPositionAndCell()

void setPositionAndCell	(	const label	parcelI,
		const label	nParcels,
		const scalar	time,
		barycentric &	coordinates,
		label &	celli,
		label &	tetFacei,
		label &	tetPti,
		label &	facei
	)

virtual

Set the injection position and owner cell, tetFace and tetPt.

Implements InjectionModel< CloudType >.

Definition at line 310 of file CellZoneInjection.C.

References Foam::tracking::coordinates().

Here is the call graph for this function:

◆ setProperties()

void setProperties	(	const label	parcelI,
		const label	nParcels,
		const scalar	time,
		typename CloudType::parcelType::trackingData &	td,
		typename CloudType::parcelType &	parcel
	)

virtual

Set the parcel properties.

Definition at line 330 of file CellZoneInjection.C.

◆ fullyDescribed()

bool fullyDescribed

virtual

Flag to identify whether model fully describes the parcel.

Implements InjectionModel< CloudType >.

Definition at line 348 of file CellZoneInjection.C.

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

src/lagrangian/parcel/submodels/Momentum/InjectionModel/CellZoneInjection/CellZoneInjection.H
src/lagrangian/parcel/submodels/Momentum/InjectionModel/CellZoneInjection/CellZoneInjection.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class CloudType> class Foam::CellZoneInjection< CloudType >

Constructor & Destructor Documentation

◆ CellZoneInjection() [1/2]

◆ CellZoneInjection() [2/2]

◆ ~CellZoneInjection()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ topoChange()

◆ timeEnd()

◆ nParcelsToInject()

◆ massToInject()

◆ setPositionAndCell()

◆ setProperties()

◆ fullyDescribed()

template<class CloudType>
class Foam::CellZoneInjection< CloudType >