List container for film injection models. More...
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 |
| 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... | |
| void | append (PtrList< injectionModel > &&other) |
| Move append another list to the end of this 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 UPtrList< T > | |
| constexpr | UPtrList () noexcept |
| Default construct. More... | |
| UPtrList (const label len) | |
| Construct with specified size, each element initialized to nullptr. More... | |
| UPtrList (const UPtrList< T > &list) | |
| Copy construct (shallow copies addresses) More... | |
| UPtrList (UPtrList< T > &&list) | |
| Move construct. More... | |
| UPtrList (UPtrList< T > &list, bool reuse) | |
| Construct as shallow copy or re-use as specified. More... | |
| UPtrList (PtrList< T > &list) | |
| Shallow copy from PtrList. More... | |
| UPtrList (const UList< T * > &list) | |
| Construct from UList of pointers (shallow copy) More... | |
| UPtrList (UList< T > &list) | |
| Construct from UList, taking the address of each list element. More... | |
| label | size () const noexcept |
| The number of elements in the list. More... | |
| bool | empty () const noexcept |
| True if the list 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... | |
| const T * | test (const label i) const |
| T * | get (const label i) |
| const T * | get (const label i) const |
| const T * | set (const label i) const |
| void | clear () |
| Set list size to zero. More... | |
| void | resize (const label newLen) |
| Change the size of the list. More... | |
| void | setSize (const label n) |
| Alias for resize() More... | |
| label | squeezeNull () |
| Squeeze out intermediate nullptr entries in the list of pointers. More... | |
| void | append (T *ptr) |
| Append an element to the end of the list. More... | |
| void | append (UPtrList< T > &&other) |
| Move append another list to the end of this list. More... | |
| void | swap (UPtrList< T > &list) |
| Swap content. More... | |
| void | transfer (UPtrList< T > &list) |
| Transfer contents into this list and annul the argument. More... | |
| T * | set (const label i, T *ptr) |
| void | reorder (const labelUList &oldToNew, const bool check=false) |
| void | sortOrder (const labelUList &order, const bool check=false) |
| void | checkNonNull () const |
| Check and raise FatalError if any nullptr exists in the list. More... | |
| const T & | operator[] (const label i) const |
| Return const reference to the element. More... | |
| T & | operator[] (const label i) |
| Return reference to the element. More... | |
| const T * | operator() (const label i) const |
| Return const pointer to the element - same as get(). More... | |
| void | operator= (const UPtrList< T > &list) |
| Copy assignment (shallow copies addresses) More... | |
| void | operator= (UPtrList< T > &&list) |
| Move assignment. More... | |
| T ** | begin_ptr () noexcept |
| Iterator to begin of raw pointers traversal (use with caution) More... | |
| T ** | end_ptr () noexcept |
| Iterator beyond end of raw pointers traversal (use with caution) More... | |
| iterator | begin () noexcept |
| Return an iterator to begin of UPtrList traversal. More... | |
| iterator | end () noexcept |
| Return iterator beyond end of UPtrList traversal. More... | |
| const_iterator | cbegin () const noexcept |
| Return const_iterator to begin of UPtrList traversal. More... | |
| const_iterator | cend () const noexcept |
| Return const_iterator beyond end of UPtrList traversal. More... | |
| const_iterator | begin () const noexcept |
| Return const_iterator to begin of UPtrList traversal. More... | |
| const_iterator | end () const noexcept |
| Return const_iterator beyond end of UPtrList traversal. 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 surfaceFilmRegionModel & | film () const |
| Return const access to the film surface film model. More... | |
| surfaceFilmRegionModel & | film () |
| 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 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... | |
| virtual bool | writeTime () const |
| Flag to indicate when to write a property. 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 > | |
| 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... | |
| virtual void | write (Ostream &os) const |
| Write. More... | |
Additional Inherited Members | |
| Public Types inherited from UPtrList< T > | |
| typedef T | value_type |
| Type of values the list contains. More... | |
| typedef T & | reference |
| A non-const reference to the value_type. More... | |
| typedef const T & | const_reference |
| A const reference to the value_type. More... | |
| 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 UPtrList< T > | |
| void | setAddressableSize (const label n) noexcept |
| Adjust addressable size. More... | |
| UPtrList (Detail::PtrListDetail< T > &&ptrs) | |
| Low-level move construct. 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 UPtrList< T > | |
| Detail::PtrListDetail< T > | ptrs_ |
| The list of pointers. More... | |
| Protected Attributes inherited from filmSubModelBase | |
| surfaceFilmRegionModel & | filmModel_ |
| Reference to the film 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... | |
List container for film injection models.
Definition at line 56 of file injectionModelList.H.
| injectionModelList | ( | surfaceFilmRegionModel & | film | ) |
Construct null.
Definition at line 42 of file injectionModelList.C.
| injectionModelList | ( | surfaceFilmRegionModel & | film, |
| const dictionary & | dict | ||
| ) |
Construct from type name, dictionary and surface film model.
Definition at line 49 of file injectionModelList.C.
References subModelBase::dict(), Foam::endl(), filmSubModelBase::film(), Foam::Info, dictionary::lookup(), Time::New(), PtrList< injectionModel >::set(), PtrList< injectionModel >::setSize(), and HashTable< T, Key, Hash >::size().
|
virtual |
Destructor.
Definition at line 91 of file injectionModelList.C.
|
virtual |
Correct.
Definition at line 97 of file injectionModelList.C.
References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), injectionModel::correct(), GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), filmSubModelBase::film(), forAll, regionModel::intCoupledPatchIDs(), UPtrList< T >::operator[](), and Foam::sum().
|
virtual |
Provide some info.
Definition at line 126 of file injectionModelList.C.
References polyMesh::boundaryMesh(), Foam::endl(), filmSubModelBase::film(), forAll, subModelBase::getBaseProperty(), Foam::indent(), Foam::Info, injectionModel::injectedMassTotal(), regionModel::intCoupledPatchIDs(), Pstream::listCombineGather(), Foam::mag(), IOobject::name(), Foam::nl, UPtrList< T >::operator[](), os(), injectionModel::patchInjectedMassTotals(), regionModel::regionMesh(), subModelBase::setBaseProperty(), UPtrList< T >::size(), UList< T >::size(), filmSubModelBase::writeTime(), and Foam::Zero.
1.9.5 