List of injection models. More...

Inheritance diagram for InjectionModelList< CloudType >:

[legend]

Collaboration diagram for InjectionModelList< CloudType >:

Public Member Functions
	InjectionModelList (CloudType &owner)
	Construct null from owner. More...

	InjectionModelList (const dictionary &dict, CloudType &owner)
	Construct from dictionary and cloud owner. More...

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

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

virtual	~InjectionModelList ()
	Destructor. More...

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

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

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

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

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

template<class TrackData >
void	inject (TrackData &td)
	Main injection loop. More...

template<class TrackData >
void	injectSteadyState (TrackData &td, const scalar trackTime)
	Main injection loop - steady-state. More...

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

Public Member Functions inherited from PtrList< InjectionModel< CloudType > >
	PtrList ()
	Null Constructor. More...

	PtrList (const label)
	Construct with size specified. More...

	PtrList (const PtrList< InjectionModel< CloudType > > &)
	Copy constructor. More...

	PtrList (const PtrList< InjectionModel< CloudType > > &, const CloneArg &)
	Copy constructor with additional argument for clone. More...

	PtrList (const Xfer< PtrList< InjectionModel< CloudType > >> &)
	Construct by transferring the parameter contents. More...

	PtrList (PtrList< InjectionModel< CloudType > > &, bool reuse)
	Construct as copy or re-use as specified. More...

	PtrList (const SLPtrList< InjectionModel< CloudType > > &)
	Construct as copy of SLPtrList<T> More...

	PtrList (Istream &, const INew &)
	Construct from Istream using given Istream constructor class. More...

	PtrList (Istream &)
	Construct from Istream using default Istream constructor class. More...

	~PtrList ()
	Destructor. More...

void	setSize (const label)
	Reset size of PtrList. If extending the PtrList, new entries are. More...

void	resize (const label)
	Alias for setSize(const label) More...

void	clear ()
	Clear the PtrList, i.e. set size to zero deleting all the. More...

void	append (InjectionModel< CloudType > *)
	Append an element at the end of the list. More...

void	append (const autoPtr< InjectionModel< CloudType > > &)

void	append (const tmp< InjectionModel< CloudType > > &)

void	transfer (PtrList< InjectionModel< CloudType > > &)
	Transfer the contents of the argument PtrList into this PtrList. More...

Xfer< PtrList< InjectionModel< CloudType > > >	xfer ()
	Transfer contents to the Xfer container. More...

bool	set (const label) const
	Is element set. More...

autoPtr< InjectionModel< CloudType > >	set (const label, InjectionModel< CloudType > *)
	Set element to given T* and return old element (can be NULL) More...

autoPtr< InjectionModel< CloudType > >	set (const label, const autoPtr< InjectionModel< CloudType > > &)
	Set element to given autoPtr<T> and return old element. More...

autoPtr< InjectionModel< CloudType > >	set (const label, const tmp< InjectionModel< CloudType > > &)
	Set element to given tmp<T> and return old element. More...

void	reorder (const labelUList &)
	Reorders elements. Ordering does not have to be done in. More...

void	operator= (const PtrList< InjectionModel< CloudType > > &)
	Assignment. More...

Public Member Functions inherited from UPtrList< T >
	UPtrList ()
	Null Constructor. More...

	UPtrList (const label)
	Construct with size specified. More...

	UPtrList (const Xfer< UPtrList< T >> &)
	Construct by transferring the parameter contents. More...

	UPtrList (UPtrList< T > &, bool reuse)
	Construct as copy or re-use as specified. More...

label	size () const
	Return the number of elements in the UPtrList. More...

bool	empty () const
	Return true if the UPtrList is empty (ie, size() is zero) More...

T &	first ()
	Return reference to the first element of the list. More...

const T &	first () const
	Return reference to first element of the list. More...

T &	last ()
	Return reference to the last element of the list. More...

const T &	last () const
	Return reference to the last element of the list. More...

void	setSize (const label)
	Reset size of UPtrList. This can only be used to set the size. More...

void	resize (const label)
	Reset size of UPtrList. This can only be used to set the size. More...

void	clear ()
	Clear the UPtrList, i.e. set size to zero. More...

void	transfer (UPtrList< T > &)
	Transfer the contents of the argument UPtrList into this. More...

Xfer< UPtrList< T > >	xfer ()
	Transfer contents to the Xfer container. More...

bool	set (const label) const
	Is element set. More...

T *	set (const label, T *)
	Set element. Return old element (can be NULL). More...

void	reorder (const labelUList &)
	Reorders elements. Ordering does not have to be done in. More...

const T &	operator[] (const label) const
	Return element const reference. More...

T &	operator[] (const label)
	Return element reference. More...

const T *	operator() (const label) const
	Return element const pointer. More...

iterator	begin ()
	Return an iterator to begin traversing the UPtrList. More...

iterator	end ()
	Return an iterator to end traversing the UPtrList. More...

const_iterator	cbegin () const
	Return an const_iterator to begin traversing the UPtrList. More...

const_iterator	cend () const
	Return an const_iterator to end traversing the UPtrList. More...

const_iterator	begin () const
	Return an const_iterator to begin traversing the UPtrList. More...

const_iterator	end () const
	Return an const_iterator to end traversing the UPtrList. More...

Additional Inherited Members
Public Types inherited from UPtrList< T >
typedef T	value_type
	Type of values the UPtrList contains. More...

typedef T &	reference
	Type that can be used for storing into UPtrList::value_type objects. More...

typedef const T &	const_reference
	Type that can be used for storing into constant UPtrList::value_type. More...

Protected Member Functions inherited from PtrList< InjectionModel< CloudType > >
void	read (Istream &, const INew &inewt)
	Read from Istream using given Istream constructor class. More...

Detailed Description

template<class CloudType>
class Foam::InjectionModelList< CloudType >

List of injection models.

Source files

Definition at line 76 of file KinematicCloud.H.

Constructor & Destructor Documentation

InjectionModelList ( CloudType & owner )

Construct null from owner.

Definition at line 31 of file InjectionModelList.C.

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

Here is the caller graph for this function:

InjectionModelList	(	const dictionary &	dict,
		CloudType &	owner
	)

Construct from dictionary and cloud owner.

Definition at line 39 of file InjectionModelList.C.

References Foam::endl(), forAllConstIter(), Foam::Info, InjectionModelList< CloudType >::InjectionModelList(), dictionary::lookup(), InjectionModel< CloudType >::New(), PtrList< InjectionModel< CloudType > >::setSize(), and dictionary::toc().

Here is the call graph for this function:

InjectionModelList ( const InjectionModelList< CloudType > & im )

Construct copy.

Definition at line 95 of file InjectionModelList.C.

~InjectionModelList ( )

virtual

Destructor.

Definition at line 106 of file InjectionModelList.C.

Referenced by InjectionModelList< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::clone().

Here is the caller graph for this function:

Member Function Documentation

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

inlinevirtual

Construct and return a clone.

Definition at line 68 of file InjectionModelList.H.

Foam::scalar timeStart ( ) const

Return the minimum start-of-injection time.

Definition at line 113 of file InjectionModelList.C.

References forAll, and Foam::min().

Referenced by InjectionModelList< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::scalar timeEnd ( ) const

Return the maximum end-of-injection time.

Definition at line 126 of file InjectionModelList.C.

References forAll, Foam::max(), and InjectionModelList< CloudType >::volumeToInject().

Referenced by InjectionModelList< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Volume of parcels to introduce relative to SOI.

Definition at line 140 of file InjectionModelList.C.

References forAll, and UPtrList< T >::operator[]().

Referenced by InjectionModelList< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::clone(), and InjectionModelList< CloudType >::timeEnd().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::scalar averageParcelMass ( )

Return the average parcel mass.

Definition at line 156 of file InjectionModelList.C.

References forAll, and UPtrList< T >::operator[]().

Referenced by InjectionModelList< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

void updateMesh ( )

Set injector locations when mesh is updated.

Definition at line 172 of file InjectionModelList.C.

References forAll, and UPtrList< T >::operator[]().

Referenced by InjectionModelList< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

void inject ( TrackData & td )

Main injection loop.

Definition at line 183 of file InjectionModelList.C.

References forAll, InjectionModelList< CloudType >::injectSteadyState(), and UPtrList< T >::operator[]().

Referenced by InjectionModelList< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

void injectSteadyState	(	TrackData &	td,
		const scalar	trackTime
	)

Main injection loop - steady-state.

Definition at line 195 of file InjectionModelList.C.

References forAll, and UPtrList< T >::operator[]().

Referenced by InjectionModelList< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::clone(), and InjectionModelList< CloudType >::inject().

Here is the call graph for this function:

Here is the caller graph for this function:

void info ( Ostream & os )

virtual

Write injection info to stream.

Definition at line 208 of file InjectionModelList.C.

References forAll, and UPtrList< T >::operator[]().

Referenced by InjectionModelList< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

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

src/lagrangian/intermediate/clouds/Templates/KinematicCloud/KinematicCloud.H
src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/InjectionModel/InjectionModelList.H
src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/InjectionModel/InjectionModelList.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class CloudType> class Foam::InjectionModelList< CloudType >

Constructor & Destructor Documentation

Member Function Documentation

template<class CloudType>
class Foam::InjectionModelList< CloudType >