Patch injection, by using patch flow rate to determine concentration and velocity. More...

Inheritance diagram for PatchFlowRateInjection< CloudType >:

Collaboration diagram for PatchFlowRateInjection< CloudType >:

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

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

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

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

virtual	~PatchFlowRateInjection ()
	Destructor. More...

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

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

virtual scalar	flowRate () const
	Return the total volumetric flow rate across the patch [m3/s]. More...

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

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

virtual void	setPositionAndCell (const label parcelI, const label nParcels, const scalar time, vector &position, label &cellOwner, label &tetFacei, label &tetPti)
	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 &parcel)
	Set the parcel properties. More...

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

virtual bool	validInjection (const label parcelI)
	Return flag to identify whether or not injection of parcelI is. More...

virtual void	updateMesh (const polyMesh &mesh)
	Inherit updateMesh from patchInjectionBase. More...

label	setPositionAndCell (const fvMesh &mesh, const scalar fraction01, Random &rnd, vector &position, label &cellOwner, label &tetFacei, label &tetPti)
	Inherit setPositionAndCell from patchInjectionBase. More...

virtual label	setPositionAndCell (const fvMesh &mesh, Random &rnd, vector &position, label &cellOwner, label &tetFacei, label &tetPti)
	Inherit setPositionAndCell from patchInjectionBase. 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 ()=default
	Destructor. More...

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

scalar	volumeTotal () const
	Return the total volume to be injected across the event. More...

scalar	massTotal () const
	Return mass of particles to introduce. More...

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

label	injectorID () const
	Return injectorID. More...

virtual scalar	averageParcelMass ()
	Return the average parcel mass over the injection period. More...

label	nInjections () const
	Return the number of injections. More...

label	parcelsAddedTotal () const
	Return the total number parcels added. 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, const scalar trackTime)
	Main injection loop - steady-state. More...

virtual void	info ()
	Write injection info. 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)
	Construct as copy. More...

virtual	~CloudSubModelBase ()=default
	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...

virtual fileName	localPath () const
	Output directory. More...

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

virtual void	write (Ostream &os) const
	Write to os. 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)
	Construct as copy. More...

virtual	~subModelBase ()=default
	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 bool	active () const
	Return the model 'active' status - default active = true. More...

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

template<class Type >
Type	getBaseProperty (const word &entryName, const Type &defaultValue=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...

bool	getModelDict (const word &entryName, dictionary &dict) const
	Retrieve dictionary, return true if set. More...

template<class Type >
bool	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=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...

Public Member Functions inherited from patchInjectionBase
	patchInjectionBase (const polyMesh &mesh, const word &patchName)
	Construct from mesh and patch name. More...

	patchInjectionBase (const patchInjectionBase &pib)
	Copy constructor. More...

virtual	~patchInjectionBase ()=default
	Destructor. More...

virtual void	updateMesh (const polyMesh &mesh)
	Update patch geometry and derived info for injection locations. More...

label	setPositionAndCell (const fvMesh &mesh, const scalar fraction01, Random &rnd, vector &position, label &cellOwner, label &tetFacei, label &tetPti)
	Set the injection position and owner cell, tetFace and tetPt. More...

virtual label	setPositionAndCell (const fvMesh &mesh, Random &rnd, vector &position, label &cellOwner, label &tetFacei, label &tetPti)
	Set the injection position and owner cell, tetFace and tetPt. More...

label	whichProc (const scalar fraction01) const
	Return the processor that has the location specified by the fraction. More...

Additional Inherited Members
Public Types inherited from InjectionModel< CloudType >
enum	parcelBasis { pbNumber, pbMass, pbFixed }
	Parcel basis representation options i.e constant number of particles OR constant mass per parcel. More...

typedef CloudType::parcelType	parcelType
	Convenience typedef for parcelType. 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...

Public Attributes inherited from subModelBase
bool	log
	Flag to write log into Info. More...

Protected Member Functions inherited from InjectionModel< CloudType >
virtual bool	prepareForNextTimeStep (const scalar time, label &newParcels, scalar &newVolumeFraction)
	Determine properties for next time step/injection interval. More...

virtual bool	findCellAtPosition (label &celli, label &tetFacei, label &tetPti, vector &position, bool errorOnNotFound=true)
	Find the cell that contains the supplied position. More...

virtual scalar	setNumberOfParticles (const label parcels, const scalar volumeFraction, const scalar diameter, const scalar rho)
	Set number of particles to inject given parcel properties. More...

virtual void	postInjectCheck (const label parcelsAdded, const scalar massAdded)
	Post injection checks. 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	volumeTotal_
	Total volume of particles introduced by this injector [m^3] Note: scaled to ensure massTotal is achieved. More...

scalar	massTotal_
	Total mass to inject [kg]. More...

autoPtr< Function1< scalar > >	massFlowRate_
	Mass flow rate profile for steady calculations. More...

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

label	nInjections_
	Number of injections counter. More...

label	parcelsAddedTotal_
	Running counter of total number of parcels added. More...

parcelBasis	parcelBasis_
	Parcel basis enumeration. More...

scalar	nParticleFixed_
	nParticle to assign to parcels when the 'fixed' basis is selected More...

scalar	time0_
	Continuous phase time at start of injection time step [s]. More...

scalar	timeStep0_
	Time at start of injection time step [s]. More...

scalar	minParticlesPerParcel_
	Minimum number of particles used to represent each parcel default = 1. More...

scalar	delayedVolume_
	Volume that should have been injected, but would lead to less than minParticlesPerParcel_ particle per parcel. More...

label	injectorID_
	Optional injector ID. More...

bool	ignoreOutOfBounds_
	Optional flag to indicate that injections attempted outside the mesh should be ignored. 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...

Protected Attributes inherited from patchInjectionBase
const word	patchName_
	Patch name. More...

const label	patchId_
	Patch ID. More...

scalar	patchArea_
	Patch area - total across all processors. More...

vectorList	patchNormal_
	Patch face normal directions. More...

labelList	cellOwners_
	List of cell labels corresponding to injector positions. More...

faceList	triFace_
	Decomposed patch faces as a list of triangles. More...

labelList	triToFace_
	Addressing from per triangle to patch face. More...

scalarList	triCumulativeMagSf_
	Cumulative triangle area per triangle face. More...

scalarList	sumTriMagSf_
	Cumulative area fractions per processor. More...

Detailed Description

template<class CloudType>
class Foam::PatchFlowRateInjection< CloudType >

Patch injection, by using patch flow rate to determine concentration and velocity.

User specifies:

Total mass to inject
Name of patch
Injection duration
Injection target concentration/carrier volume flow rate

Properties:

Initial parcel velocity given by local flow velocity
Parcel diameters obtained by distribution model
Parcels injected randomly across the patch

Source files

Definition at line 65 of file PatchFlowRateInjection.H.

Constructor & Destructor Documentation

◆ PatchFlowRateInjection() [1/2]

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

Construct from dictionary.

Definition at line 31 of file PatchFlowRateInjection.C.

References TimeState::userTimeToTime().

Here is the call graph for this function:

◆ PatchFlowRateInjection() [2/2]

PatchFlowRateInjection ( const PatchFlowRateInjection< CloudType > & im )

Construct copy.

Definition at line 80 of file PatchFlowRateInjection.C.

◆ ~PatchFlowRateInjection()

~PatchFlowRateInjection ( )

virtual

Destructor.

Definition at line 98 of file PatchFlowRateInjection.C.

Member Function Documentation

◆ TypeName()

TypeName ( "patchFlowRateInjection" )

Runtime type information.

◆ clone()

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

inlinevirtual

Construct and return a clone.

Implements InjectionModel< CloudType >.

Definition at line 131 of file PatchFlowRateInjection.H.

◆ updateMesh() [1/2]

void updateMesh ( )

virtual

Set injector locations when mesh is updated.

Reimplemented from InjectionModel< CloudType >.

Definition at line 105 of file PatchFlowRateInjection.C.

References mesh.

◆ timeEnd()

Foam::scalar timeEnd ( ) const

virtual

Return the end-of-injection time.

Implements InjectionModel< CloudType >.

Definition at line 112 of file PatchFlowRateInjection.C.

◆ flowRate()

Foam::scalar flowRate ( ) const

virtual

Return the total volumetric flow rate across the patch [m3/s].

Definition at line 119 of file PatchFlowRateInjection.C.

References Foam::dimArea, Foam::dimVelocity, Foam::max(), mesh, phi, Foam::reduce(), rho, and Foam::sum().

Here is the call graph for this function:

◆ parcelsToInject()

Foam::label parcelsToInject	(	const scalar	time0,
		const scalar	time1
	)

virtual

Number of parcels to introduce relative to SOI.

Implements InjectionModel< CloudType >.

Definition at line 150 of file PatchFlowRateInjection.C.

References Foam::constant::universal::c, Random::globalPosition(), and dimensioned< Type >::value().

Here is the call graph for this function:

◆ volumeToInject()

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

virtual

Volume of parcels to introduce relative to SOI.

Implements InjectionModel< CloudType >.

Definition at line 190 of file PatchFlowRateInjection.C.

References Foam::constant::universal::c, dimensioned< Type >::value(), and Foam::fieldTypes::volume.

Here is the call graph for this function:

◆ setPositionAndCell() [1/3]

void setPositionAndCell	(	const label	parcelI,
		const label	nParcels,
		const scalar	time,
		vector &	position,
		label &	cellOwner,
		label &	tetFacei,
		label &	tetPti
	)

virtual

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

Implements InjectionModel< CloudType >.

Definition at line 213 of file PatchFlowRateInjection.C.

References mesh, and rndGen.

◆ setProperties()

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 237 of file PatchFlowRateInjection.C.

◆ fullyDescribed()

bool fullyDescribed ( ) const

virtual

Flag to identify whether model fully describes the parcel.

Implements InjectionModel< CloudType >.

Definition at line 253 of file PatchFlowRateInjection.C.

◆ validInjection()

bool validInjection ( const label parcelI )

virtual

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

permitted

Implements InjectionModel< CloudType >.

Definition at line 260 of file PatchFlowRateInjection.C.

◆ updateMesh() [2/2]

void updateMesh

Inherit updateMesh from patchInjectionBase.

Definition at line 75 of file patchInjectionBase.C.

◆ setPositionAndCell() [2/3]

Foam::label setPositionAndCell

Inherit setPositionAndCell from patchInjectionBase.

Definition at line 136 of file patchInjectionBase.C.

◆ setPositionAndCell() [3/3]

Foam::label setPositionAndCell

Inherit setPositionAndCell from patchInjectionBase.

Definition at line 260 of file patchInjectionBase.C.

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

src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/PatchFlowRateInjection/PatchFlowRateInjection.H
src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/PatchFlowRateInjection/PatchFlowRateInjection.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class CloudType> class Foam::PatchFlowRateInjection< CloudType >

Constructor & Destructor Documentation

◆ PatchFlowRateInjection() [1/2]

◆ PatchFlowRateInjection() [2/2]

◆ ~PatchFlowRateInjection()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ updateMesh() [1/2]

◆ timeEnd()

◆ flowRate()

◆ parcelsToInject()

◆ volumeToInject()

◆ setPositionAndCell() [1/3]

◆ setProperties()

◆ fullyDescribed()

◆ validInjection()

◆ updateMesh() [2/2]

◆ setPositionAndCell() [2/3]

◆ setPositionAndCell() [3/3]

template<class CloudType>
class Foam::PatchFlowRateInjection< CloudType >