List of injection models. More...

Inheritance diagram for InjectionModelList< CloudType >:

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...

void	topoChange ()
	Set injector locations when mesh is updated. 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	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 (PtrList< InjectionModel< CloudType > > &&)
	Move constructor. More...

	PtrList (PtrList< InjectionModel< CloudType > > &, bool reuse)
	Construct as copy or reuse 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	shrink ()
	Shrink the allocated space to the number of elements used. 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 > > &)
	Append an element at the end of the list. More...

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

void	transfer (PtrList< InjectionModel< CloudType > > &)
	Transfer the contents of the argument PtrList into this PtrList. 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 nullptr) 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 &oldToNew)
	Reorders elements. Ordering does not have to be done in. More...

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

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

void	operator= (PtrList< InjectionModel< CloudType > > &&)
	Move assignment operator. More...

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

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

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

	UPtrList (std::initializer_list< T * >)
	Construct from an initialiser list of pointers. 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	append (T *)
	Append an element at the end of the list. More...

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

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

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

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

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

template<class T2 >
UPtrList< T2 >	convert ()
	Convert to list of different pointer type. More...

template<class T2 >
UPtrList< const T2 >	convert () const
	Convert to list of different pointer type. 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...

T *	operator() (const label)
	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...

template<class T2 >
Foam::UPtrList< T2 >	convert ()

template<class T2 >
Foam::UPtrList< const T2 >	convert () const

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 50 of file InjectionModelList.H.

Constructor & Destructor Documentation

◆ InjectionModelList() [1/3]

InjectionModelList ( CloudType & owner )

Construct null from owner.

Definition at line 31 of file InjectionModelList.C.

◆ InjectionModelList() [2/3]

InjectionModelList	(	const dictionary &	dict,
		CloudType &	owner
	)

Construct from dictionary and cloud owner.

Definition at line 38 of file InjectionModelList.C.

References dict, Foam::endl(), forAllConstIter, Foam::Info, PtrList< InjectionModel< CloudType > >::setSize(), and List< T >::size().

Here is the call graph for this function:

◆ InjectionModelList() [3/3]

InjectionModelList ( const InjectionModelList< CloudType > & im )

Construct copy.

Definition at line 94 of file InjectionModelList.C.

◆ ~InjectionModelList()

~InjectionModelList

virtual

Destructor.

Definition at line 106 of file InjectionModelList.C.

Member Function Documentation

◆ clone()

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

inlinevirtual

Construct and return a clone.

Definition at line 68 of file InjectionModelList.H.

◆ timeStart()

Foam::scalar timeStart

Return the minimum start-of-injection time.

Definition at line 113 of file InjectionModelList.C.

References forAll, and Foam::min().

Here is the call graph for this function:

◆ timeEnd()

Foam::scalar timeEnd

Return the maximum end-of-injection time.

Definition at line 126 of file InjectionModelList.C.

References forAll, and Foam::max().

Here is the call graph for this function:

◆ topoChange()

void topoChange

Set injector locations when mesh is updated.

Definition at line 139 of file InjectionModelList.C.

References forAll.

◆ inject()

void inject	(	TrackCloudType &	cloud,
		typename CloudType::parcelType::trackingData &	td
	)

Main injection loop.

Definition at line 150 of file InjectionModelList.C.

References forAll.

◆ injectSteadyState()

void injectSteadyState	(	TrackCloudType &	cloud,
		typename CloudType::parcelType::trackingData &	td
	)

Main injection loop - steady-state.

Definition at line 165 of file InjectionModelList.C.

References forAll.

◆ info()

void info ( Ostream & os )

virtual

Write injection info to stream.

Definition at line 179 of file InjectionModelList.C.

References forAll.

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

src/lagrangian/parcel/clouds/Templates/MomentumCloud/MomentumCloud.H
src/lagrangian/parcel/submodels/Momentum/InjectionModel/InjectionModel/InjectionModelList.H
src/lagrangian/parcel/submodels/Momentum/InjectionModel/InjectionModel/InjectionModelList.C

Public Member Functions

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

◆ InjectionModelList() [1/3]

◆ InjectionModelList() [2/3]

◆ InjectionModelList() [3/3]

◆ ~InjectionModelList()

Member Function Documentation

◆ clone()

◆ timeStart()

◆ timeEnd()

◆ topoChange()

◆ inject()

◆ injectSteadyState()

◆ info()

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