injectionModelList Class Reference

List container for film injection models. More...

Inheritance diagram for injectionModelList:
[legend]
Collaboration diagram for injectionModelList:
[legend]

Public Member Functions

 injectionModelList (surfaceFilmRegionModel &film)
 Construct null. More...
 
 injectionModelList (surfaceFilmRegionModel &film, 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 >
constexpr PtrList () noexcept
 Default construct. More...
 
 PtrList (const label len)
 Construct with specified size, each element initialized to nullptr. More...
 
 PtrList (const PtrList< injectionModel > &list)
 Copy construct using 'clone()' method on each element. More...
 
 PtrList (PtrList< injectionModel > &&list)
 Move construct. More...
 
 PtrList (UList< injectionModel * > &list)
 Take ownership of pointers in the list, set old pointers to null. More...
 
 PtrList (const PtrList< injectionModel > &list, const CloneArg &cloneArgs)
 Copy construct using 'clone()' method on each element. More...
 
 PtrList (PtrList< injectionModel > &list, bool reuse)
 Construct as copy or re-use as specified. More...
 
 PtrList (const SLPtrList< injectionModel > &list)
 Copy construct using 'clone()' on each element of SLPtrList<T> More...
 
 PtrList (Istream &is, const INew &inew)
 Construct from Istream using given Istream constructor class. More...
 
 PtrList (Istream &is)
 Construct from Istream using default Istream constructor class. More...
 
 ~PtrList ()
 Destructor. More...
 
PtrList< injectionModel > clone (Args &&... args) const
 Make a copy by cloning each of the list elements. More...
 
Foam::PtrList< injectionModel > clone (Args &&... args) const
 
const injectionModel * set (const label i) const
 Return const pointer to element (can be nullptr),. More...
 
autoPtr< injectionModel > set (const label i, injectionModel *ptr)
 Set element to given pointer and return old element (can be null) More...
 
autoPtr< injectionModel > set (const label i, autoPtr< injectionModel > &ptr)
 Set element to given autoPtr and return old element. More...
 
autoPtr< injectionModel > set (const label i, autoPtr< injectionModel > &&ptr)
 Set element to given autoPtr and return old element. More...
 
autoPtr< injectionModel > set (const label i, std::unique_ptr< injectionModel > &&ptr)
 Set element to given unique_ptr and return old element. More...
 
autoPtr< injectionModel > set (const label i, const refPtr< injectionModel > &ptr)
 Set element to given refPtr and return old element. More...
 
autoPtr< injectionModel > set (const label i, const tmp< injectionModel > &ptr)
 Set element to given tmp and return old element. More...
 
void clear ()
 Clear the PtrList. Delete allocated entries and set size to zero. More...
 
void resize (const label newLen)
 Adjust size of PtrList. More...
 
void setSize (const label newLen)
 Same as resize() More...
 
void emplace_append (Args &&... args)
 Construct and append an element to the end of the list. More...
 
void append (injectionModel *ptr)
 Append an element to the end of the list. More...
 
void append (autoPtr< injectionModel > &ptr)
 Move append an element to the end of the list. More...
 
void append (autoPtr< injectionModel > &&ptr)
 Move append an element to the end of the list. More...
 
void append (std::unique_ptr< injectionModel > &&ptr)
 Move append an element to the end of the list. More...
 
void append (const refPtr< injectionModel > &ptr)
 Move or clone append a refPtr to the end of the list. More...
 
void append (const tmp< injectionModel > &ptr)
 Move or clone append a tmp to the end of the list. More...
 
autoPtr< injectionModel > emplace (const label i, Args &&... args)
 Construct and set an element. More...
 
Foam::autoPtr< injectionModel > emplace (const label i, Args &&... args)
 
autoPtr< injectionModel > release (const label i)
 Release ownership of the pointer at the given position. More...
 
void transfer (PtrList< injectionModel > &list)
 Transfer into this list and annul the argument list. More...
 
void operator= (const PtrList< injectionModel > &list)
 Copy assignment. More...
 
void operator= (PtrList< injectionModel > &&list)
 Move assignment. More...
 
- Public Member Functions inherited from filmSubModelBase
 filmSubModelBase (surfaceFilmRegionModel &film)
 Construct null. More...
 
 filmSubModelBase (surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 Construct from film film without name. More...
 
 filmSubModelBase (const word &modelName, surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType)
 Construct from film film with name. More...
 
virtual ~filmSubModelBase ()
 Destructor. More...
 
virtual bool writeTime () const
 Flag to indicate when to write a property. More...
 
const surfaceFilmRegionModelfilm () const
 Return const access to the film surface film model. More...
 
surfaceFilmRegionModelfilm ()
 Return the reference to the film 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 wordmodelName () const
 Return const access to the name of the sub-model. More...
 
const dictionarydict () const
 Return const access to the cloud dictionary. More...
 
const wordbaseName () const
 Return const access to the base name of the sub-model. More...
 
const wordmodelType () const
 Return const access to the sub-model type. More...
 
const dictionarycoeffDict () const
 Return const access to the coefficients dictionary. More...
 
const dictionaryproperties () 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...
 
virtual fileName localPath () const
 Output directory. 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 >
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=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...
 

Additional Inherited Members

- Protected Member Functions inherited from PtrList< injectionModel >
void readIstream (Istream &is, const INew &inew)
 Read from Istream using Istream constructor class. More...
 
void free ()
 Delete the allocated entries, but retain the list size. 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
surfaceFilmRegionModelfilmModel_
 Reference to the film surface film model. More...
 
- Protected Attributes inherited from subModelBase
const word modelName_
 Name of the sub-model. More...
 
dictionaryproperties_
 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

List container for film injection models.

Source files

Source files

Definition at line 56 of file injectionModelList.H.

Constructor & Destructor Documentation

◆ injectionModelList() [1/2]

Construct null.

Definition at line 42 of file injectionModelList.C.

◆ injectionModelList() [2/2]

injectionModelList ( surfaceFilmRegionModel film,
const dictionary dict 
)

Construct from type name, dictionary and surface film model.

Definition at line 50 of file injectionModelList.C.

References dict, Foam::endl(), Foam::Info, injectionModel::New(), Foam::BitOps::set(), and setSize().

Here is the call graph for this function:

◆ ~injectionModelList()

~injectionModelList ( )
virtual

Destructor.

Definition at line 91 of file injectionModelList.C.

Member Function Documentation

◆ correct()

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

Correct.

Definition at line 98 of file injectionModelList.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), injectionModel::correct(), GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), forAll, regionModel::intCoupledPatchIDs(), and Foam::sum().

Referenced by thermoSingleLayer::updateSubmodels(), and 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 126 of file injectionModelList.C.

References polyMesh::boundaryMesh(), Foam::endl(), filmSubModelBase::film(), forAll, subModelBase::getBaseProperty(), polyMesh::globalData(), Foam::indent(), Foam::Info, injectionModel::injectedMassTotal(), regionModel::intCoupledPatchIDs(), Pstream::listCombineGather(), Foam::mag(), IOobject::name(), Foam::nl, os(), injectionModel::patchInjectedMassTotals(), globalMeshData::processorPatches(), regionModel::regionMesh(), subModelBase::setBaseProperty(), filmSubModelBase::writeTime(), and Foam::Zero.

Referenced by kinematicSingleLayer::info().

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: