Inheritance diagram for injectionModelList:

Collaboration diagram for injectionModelList:

[legend]

Public Member Functions
	injectionModelList (surfaceFilmModel &owner)
	Construct null. More...

	injectionModelList (surfaceFilmModel &owner, const dictionary &dict)
	Construct from type name, dictionary and surface film model. More...

virtual	~injectionModelList ()
	Destructor. More...

virtual void	correct (scalarField &availableMass, volScalarField &massToInject, volScalarField &diameterToInject)
	Correct. More...

virtual void	info (Ostream &os)
	Provide some info. More...

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

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

	PtrList (const PtrList< T > &)
	Copy constructor. More...

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

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

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

	PtrList (const SLPtrList< T > &)
	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 ()

	PtrList (const label s)

	PtrList (const PtrList< T > &a)

	PtrList (const Xfer< PtrList< T > > &lst)

	PtrList (PtrList< T > &a, bool reUse)

	PtrList (const SLPtrList< T > &sll)

	PtrList (Istream &is)

	~PtrList ()
	Destructor. More...

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

bool	empty () const
	Return true if the PtrList 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 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 (T *)
	Append an element at the end of the list. More...

void	append (const autoPtr< T > &)

void	append (const tmp< T > &)

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

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

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

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

autoPtr< T >	set (const label, const autoPtr< T > &)

autoPtr< T >	set (const label, const tmp< T > &)

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

PtrList< T > &	operator= (const PtrList< T > &)
	Assignment. More...

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

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

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

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

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

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

Public Member Functions inherited from filmSubModelBase
	filmSubModelBase (surfaceFilmModel &owner)
	Construct null. More...

	filmSubModelBase (surfaceFilmModel &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from owner film wihout name. More...

	filmSubModelBase (const word &modelName, surfaceFilmModel &owner, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from owner film with name. More...

virtual	~filmSubModelBase ()
	Destructor. More...

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

const surfaceFilmModel &	owner () const
	Return const access to the owner surface film model. More...

surfaceFilmModel &	owner ()
	Return the reference to the owner surface film model. More...

template<class FilmType >
const FilmType &	filmType () const

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 ()
	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 dependant 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...

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

Private Member Functions
	injectionModelList (const injectionModelList &)
	Disallow default bitwise copy construct. More...

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

Private Attributes
scalarField	massInjected_
	List of mass injected per patch. More...

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

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

Data Fields inherited from PtrList< injectionModel >
const typedef T &	const_reference
	Type that can be used for storing into constant PtrList::value_type. More...

Protected Member Functions inherited from PtrList< injectionModel >
void	read (Istream &, const INew &inewt)
	Read from Istream using given Istream constructor class. 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 filmSubModelBase
surfaceFilmModel &	owner_
	Reference to the owner surface film model. 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

Definition at line 54 of file injectionModelList.H.

Constructor & Destructor Documentation

◆ injectionModelList() [1/3]

injectionModelList ( const injectionModelList & )

private

Disallow default bitwise copy construct.

◆ injectionModelList() [2/3]

injectionModelList ( surfaceFilmModel & owner )

Construct null.

Definition at line 39 of file injectionModelList.C.

◆ injectionModelList() [3/3]

injectionModelList	(	surfaceFilmModel &	owner,
		const dictionary &	dict
	)

Construct from type name, dictionary and surface film model.

Definition at line 47 of file injectionModelList.C.

References dict, Foam::endl(), forAll, forAllConstIter(), Foam::Info, HashSet< Key, Hash >::insert(), injectionModel::New(), setSize(), and HashTable::size().

Here is the call graph for this function:

◆ ~injectionModelList()

~injectionModelList ( )

virtual

Destructor.

Definition at line 93 of file injectionModelList.C.

Member Function Documentation

◆ operator=()

void operator= ( const injectionModelList & )

private

Disallow default bitwise assignment.

◆ correct()

void correct	(	scalarField &	availableMass,
		volScalarField &	massToInject,
		volScalarField &	diameterToInject
	)

virtual

Correct.

Definition at line 100 of file injectionModelList.C.

References GeometricField::boundaryField(), injectionModel::correct(), GeometricField::correctBoundaryConditions(), forAll, regionModel::intCoupledPatchIDs(), patchi, and Foam::sum().

Referenced by kinematicSingleLayer::updateSubmodels().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ info()

void info ( Ostream & os )

virtual

Provide some info.

Definition at line 128 of file injectionModelList.C.

References polyMesh::boundaryMesh(), Foam::endl(), forAll, subModelBase::getBaseProperty(), Foam::indent(), Foam::Info, injectionModel::injectedMassTotal(), regionModel::intCoupledPatchIDs(), Pstream::listCombineGather(), Foam::mag(), injectionModelList::massInjected_, IOobject::name(), Foam::nl, PtrList< injectionModel >::operator[](), filmSubModelBase::outputTime(), filmSubModelBase::owner(), patchi, injectionModel::patchInjectedMassTotals(), regionModel::regionMesh(), subModelBase::setBaseProperty(), and PtrList::size().

Referenced by kinematicSingleLayer::info().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ massInjected_

scalarField massInjected_

private

List of mass injected per patch.

Definition at line 64 of file injectionModelList.H.

Referenced by injectionModelList::info().

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

src/regionModels/surfaceFilmModels/submodels/kinematic/injectionModel/injectionModelList/injectionModelList.H
src/regionModels/surfaceFilmModels/submodels/kinematic/injectionModel/injectionModelList/injectionModelList.C

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ injectionModelList() [1/3]

◆ injectionModelList() [2/3]

◆ injectionModelList() [3/3]

◆ ~injectionModelList()

Member Function Documentation

◆ operator=()

◆ correct()

◆ info()

Field Documentation

◆ massInjected_