FieldActivatedInjection< CloudType > Class Template Reference

Injection at specified positions, with the conditions: More...

#include <lagrangianIntermediate/FieldActivatedInjection.H>

---

Detailed Description

template<class CloudType>
class Foam::FieldActivatedInjection< CloudType >

Injection at specified positions, with the conditions:

- for injection to be allowed

factor*referenceField[cellI] >= thresholdField[cellI]

where:

• referenceField is the field used to supply the look-up values
• thresholdField supplies the values beyond which the injection is permitted

• limited to a user-supllied number of injections per injector location

Source files

• src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/FieldActivatedInjection/FieldActivatedInjection.H
• src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/FieldActivatedInjection/FieldActivatedInjection.C

Definition at line 63 of file FieldActivatedInjection.H.

Inheritance diagram for FieldActivatedInjection< CloudType >:

Collaboration diagram for FieldActivatedInjection< CloudType >:

List of all members.

Public Member Functions
	TypeName ("FieldActivatedInjection")
	Runtime type information.
	FieldActivatedInjection (const dictionary &dict, CloudType &owner)
	Construct from dictionary.
virtual	~FieldActivatedInjection ()
bool	active () const
	Flag to indicate whether model activates injection model.
scalar	timeEnd () const
	Return the end-of-injection time.
virtual void	setPositionAndCell (const label parcelI, const label nParcels, const scalar time, vector &position, label &cellOwner)
	Set the injection position and owner cell.
virtual void	setProperties (const label parcelI, const label nParcels, const scalar time, typename CloudType::parcelType &parcel)
	Set the parcel properties.
virtual bool	fullyDescribed () const
	Flag to identify whether model fully describes the parcel.
virtual bool	validInjection (const label parcelI)
	Return flag to identify whether or not injection of parcelI is.
Protected Member Functions
label	parcelsToInject (const scalar time0, const scalar time1) const
	Number of parcels to introduce over the time step relative to SOI.
scalar	volumeToInject (const scalar time0, const scalar time1) const
	Volume of parcels to introduce over the time step relative to SOI.

---

Constructor & Destructor Documentation

FieldActivatedInjection	(	const dictionary &	dict,
		CloudType &	owner
	)

Construct from dictionary.

Definition at line 72 of file FieldActivatedInjection.C.

References forAll, Foam::mathematicalConstant::pi(), pow3(), and Foam::sum().

~FieldActivatedInjection

(

)

[virtual]

Definition at line 147 of file FieldActivatedInjection.C.

---

Member Function Documentation

Foam::label parcelsToInject	(	const scalar	time0,
		const scalar	time1
	)		const [protected, virtual]

Number of parcels to introduce over the time step relative to SOI.

Implements InjectionModel< CloudType >.

Definition at line 34 of file FieldActivatedInjection.C.

References Foam::sum().

Foam::scalar volumeToInject	(	const scalar	time0,
		const scalar	time1
	)		const [protected, virtual]

Volume of parcels to introduce over the time step relative to SOI.

Implements InjectionModel< CloudType >.

Definition at line 52 of file FieldActivatedInjection.C.

References Foam::sum().

TypeName

(

"FieldActivatedInjection< CloudType >"

)

Runtime type information.

bool active

(

)

const [virtual]

Flag to indicate whether model activates injection model.

Implements InjectionModel< CloudType >.

Definition at line 154 of file FieldActivatedInjection.C.

Foam::scalar timeEnd

(

)

const [virtual]

Return the end-of-injection time.

Implements InjectionModel< CloudType >.

Definition at line 161 of file FieldActivatedInjection.C.

void setPositionAndCell	(	const label	parcelI,
		const label	nParcels,
		const scalar	time,
		vector &	position,
		label &	cellOwner
	)		[virtual]

Set the injection position and owner cell.

Implements InjectionModel< CloudType >.

Definition at line 169 of file FieldActivatedInjection.C.

void setProperties	(	const label	parcelI,
		const label	nParcels,
		const scalar	time,
		typename CloudType::parcelType &	parcel
	)		[virtual]

Set the parcel properties.

Implements InjectionModel< CloudType >.

Definition at line 184 of file FieldActivatedInjection.C.

bool fullyDescribed

(

)

const [virtual]

Flag to identify whether model fully describes the parcel.

Implements InjectionModel< CloudType >.

Definition at line 200 of file FieldActivatedInjection.C.

bool validInjection

(

const label

parcelI  )

[virtual]

Return flag to identify whether or not injection of parcelI is.

permitted

Implements InjectionModel< CloudType >.

Definition at line 208 of file FieldActivatedInjection.C.

---

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

• src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/FieldActivatedInjection/FieldActivatedInjection.H
• src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/FieldActivatedInjection/FieldActivatedInjection.C