#include <transferModelList.H>
Public Member Functions | |
| transferModelList (surfaceFilmRegionModel &film) | |
| Construct null. | |
| transferModelList (surfaceFilmRegionModel &film, const dictionary &dict) | |
| Construct from type name, dictionary and surface film model. | |
| virtual | ~transferModelList () |
| Destructor. | |
| virtual void | correct (scalarField &availableMass, volScalarField &massToTransfer) |
| Correct kinematic transfers. | |
| virtual void | correct (scalarField &availableMass, volScalarField &massToTransfer, volScalarField &energyToTransfer) |
| Correct kinematic and thermodynamic transfers. | |
| virtual void | info (Ostream &os) |
| Provide some info. | |
| Public Member Functions inherited from PtrList< transferModel > | |
| Foam::PtrList< transferModel > | clone (Args &&... args) const |
| constexpr | PtrList () noexcept |
| Default construct. | |
| ~PtrList () | |
| Destructor. Frees all pointers. | |
| const transferModel * | set (const label i) const |
| Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). | |
| void | clear () |
| Clear the PtrList. Delete allocated entries and set size to zero. | |
| void | free () |
| Free memory and nullify all entries. Does not change the list size. | |
| void | resize (const label newLen) |
| Adjust size of PtrList. | |
| void | resize_null (const label newLen) |
Set the addressed list to the given size, deleting all existing entries. Afterwards the list contains all nullptr entries. | |
| transferModel & | emplace_back (Args &&... args) |
| Construct and append an element to the end of the list, return reference to the new list element. | |
| void | push_back (transferModel *ptr) |
| Append an element to the end of the list. | |
| transferModel & | emplace_set (const label i, Args &&... args) |
| Construct and set a new element at given position, (discard old element at that location). | |
| transferModel & | emplace (const label i, Args &&... args) |
| Same as emplace_set(). | |
| transferModel & | try_emplace (const label i, Args &&... args) |
| Like emplace_set() but will not overwrite an occupied (non-null) location. | |
| autoPtr< transferModel > | release (const label i) |
| Release ownership of the pointer at the given position. | |
| void | transfer (PtrList< transferModel > &list) |
| Transfer into this list and annul the argument list. | |
| void | operator= (const UPtrList< transferModel > &list) |
| Copy assignment. | |
| void | setSize (const label n) |
| Same as resize(). | |
| void | append (autoPtr< transferModel > &ptr) |
| Move append an element to the end of the list. | |
| Public Member Functions inherited from UPtrList< transferModel > | |
| bool | empty () const noexcept |
| True if the list is empty (ie, size() is zero). | |
| label | size () const noexcept |
| The number of entries in the list. | |
| label | capacity () const noexcept |
| Size of the underlying storage. | |
| label | count_nonnull () const noexcept |
| The number of non-nullptr entries in the list. | |
| transferModel & | front () |
| Reference to the first element of the list. | |
| transferModel & | back () |
| Reference to the last element of the list. | |
| const transferModel * | test (const label i) const |
| Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). | |
| const transferModel * | get (const label i) const |
| Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). | |
| const transferModel * | set (const label i) const |
| Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). | |
| void | clear () |
| Set list size to zero. | |
| void | free () |
| Nullify all entries. Does not change the list size. | |
| void | resize (const label newLen) |
Change the size of the list. Any new entries are nullptr. | |
| void | resize_null (const label newLen) |
Set the list to the given size and set all entries to nullptr. | |
| label | squeezeNull () |
| Squeeze out nullptr entries in the list of pointers after which any null pointers will be at the end of the list. | |
| void | push_back (transferModel *ptr) |
| Append an element to the end of the list. | |
| void | swap (UPtrList< transferModel > &list) noexcept |
| Swap content. | |
| void | transfer (UPtrList< transferModel > &list) |
| Transfer contents into this list and annul the argument. | |
| void | reorder (const labelUList &oldToNew, const bool check=false) |
| Reorder elements. Reordering must be unique (ie, shuffle). | |
| void | sortOrder (const labelUList &order, const bool check=false) |
| Reorder elements according to new order mapping (newToOld). Reordering must be unique (ie, shuffle). | |
| void | checkNonNull () const |
| Check and raise FatalError if any nullptr exists in the list. | |
| const transferModel & | at (const label i) const |
| Return const reference to the element at given position. FatalError for bounds problem or nullptr. | |
| const transferModel & | operator[] (const label i) const |
| Return const reference to the element at given position. FatalError for bounds problem or nullptr. Same as at(). | |
| FOAM_DEPRECATED_FOR (2022-09, "get(), set() or test() methods") const transferModel *operator()(const label i) const | |
| Deprecated(2022-09) - same as get(). | |
| void | operator= (const UPtrList< transferModel > &list) |
| Copy assignment (shallow copies addresses). | |
| Ostream & | printAddresses (Ostream &os) const |
| Print pointer addresses to Ostream (debugging only). | |
| Ostream & | writeList (Ostream &os, const bool trimNull=false) const |
| Write UPtrList to Ostream, optionally ignoring null entries. | |
| transferModel ** | begin_ptr () noexcept |
| Iterator to begin of raw pointers traversal (use with caution). | |
| transferModel ** | end_ptr () noexcept |
| Iterator beyond end of raw pointers traversal (use with caution). | |
| iterator | begin () |
| Return iterator to begin traversal of non-nullptr entries. | |
| iterator | end () noexcept |
| Return iterator beyond end of UPtrList traversal. | |
| const_iterator | cbegin () const |
| Return const_iterator to begin traversal of non-nullptr entries. | |
| const_iterator | cend () const noexcept |
| Return const_iterator beyond end of UPtrList traversal. | |
| void | setSize (const label n) |
| Alias for resize(). | |
| transferModel & | first () |
| Reference to the first element of the list. | |
| transferModel & | last () |
| Return reference to the last element of the list. | |
| void | append (transferModel *ptr) |
| Append an element to the end of the list. | |
| label | count () const noexcept |
| The number of non-nullptr entries in the list. | |
| Public Member Functions inherited from filmSubModelBase | |
| filmSubModelBase (surfaceFilmRegionModel &film) | |
| Construct null. | |
| filmSubModelBase (surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs") | |
| Construct from film film without name. | |
| filmSubModelBase (const word &modelName, surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType) | |
| Construct from film film with name. | |
| virtual | ~filmSubModelBase () |
| Destructor. | |
| virtual bool | writeTime () const |
| Flag to indicate when to write a property. | |
| const surfaceFilmRegionModel & | film () const |
| Return const access to the film surface film model. | |
| surfaceFilmRegionModel & | film () |
| Return the reference to the film surface film model. | |
| template<class FilmType> | |
| const FilmType & | filmType () const |
| Public Member Functions inherited from subModelBase | |
| subModelBase (dictionary &properties) | |
| Construct null. | |
| subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs") | |
| Construct from components without name. | |
| subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType) | |
| Construct from components with name. | |
| subModelBase (const subModelBase &smb) | |
| Construct as copy. | |
| virtual | ~subModelBase ()=default |
| Destructor. | |
| const word & | modelName () const |
| Return const access to the name of the sub-model. | |
| const dictionary & | dict () const |
| Return const access to the cloud dictionary. | |
| const word & | baseName () const |
| Return const access to the base name of the sub-model. | |
| const word & | modelType () const |
| Return const access to the sub-model type. | |
| const dictionary & | coeffDict () const |
| Return const access to the coefficients dictionary. | |
| const dictionary & | properties () const |
| Return const access to the properties dictionary. | |
| virtual bool | defaultCoeffs (const bool printMsg) const |
| Returns true if defaultCoeffs is true and outputs on printMsg. | |
| virtual bool | active () const |
| Return the model 'active' status - default active = true. | |
| virtual void | cacheFields (const bool store) |
| Cache dependent sub-model fields. | |
| virtual fileName | localPath () const |
| Output directory. | |
| template<class Type> | |
| Type | getBaseProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const |
| Retrieve generic property from the base model. | |
| template<class Type> | |
| void | getBaseProperty (const word &entryName, Type &value) const |
| Retrieve generic property from the base model. | |
| template<class Type> | |
| void | setBaseProperty (const word &entryName, const Type &value) |
| Add generic property to the base model. | |
| bool | getModelDict (const word &entryName, dictionary &dict) const |
| Retrieve dictionary, return true if set. | |
| template<class Type> | |
| bool | getModelProperty (const word &entryName, Type &value) const |
| Retrieve generic property from the sub-model. | |
| template<class Type> | |
| Type | getModelProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const |
| Retrieve generic property from the sub-model. | |
| template<class Type> | |
| void | setModelProperty (const word &entryName, const Type &value) |
| Add generic property to the sub-model. | |
| virtual void | write (Ostream &os) const |
| Write. | |
Additional Inherited Members | |
| Public Types inherited from UPtrList< transferModel > | |
| typedef transferModel | value_type |
| Type of values the list contains. | |
| typedef transferModel & | reference |
| A non-const reference to the value_type. | |
| typedef const transferModel & | const_reference |
| A const reference to the value_type. | |
| Public Attributes inherited from subModelBase | |
| bool | log |
| Flag to write log into Info. | |
| Protected Member Functions inherited from PtrList< transferModel > | |
| void | readIstream (Istream &is, const INew &inew) |
| Read from Istream using Istream constructor class. | |
| Protected Member Functions inherited from UPtrList< transferModel > | |
| void | setAddressableSize (const label n) noexcept |
| Adjust addressable size. | |
| label | find_next (label pos) const |
| The next non-null entry after the specified position. | |
| UPtrList (Detail::PtrListDetail< transferModel > &&ptrs) noexcept | |
| Low-level move construct. | |
| Protected Member Functions inherited from subModelBase | |
| bool | inLine () const |
| Flag to indicate whether data is/was read in-line. | |
| Protected Attributes inherited from UPtrList< transferModel > | |
| Detail::PtrListDetail< transferModel > | ptrs_ |
| The list of pointers. | |
| Protected Attributes inherited from filmSubModelBase | |
| surfaceFilmRegionModel & | filmModel_ |
| Reference to the film surface film model. | |
| Protected Attributes inherited from subModelBase | |
| const word | modelName_ |
| Name of the sub-model. | |
| dictionary & | properties_ |
| Reference to properties dictionary e.g. for restart. | |
| const dictionary | dict_ |
| Copy of dictionary used during construction. | |
| const word | baseName_ |
| Name of the sub-model base class. | |
| const word | modelType_ |
| Type of the sub-model. | |
| const dictionary | coeffDict_ |
| Coefficients dictionary. | |
Definition at line 52 of file transferModelList.H.
| transferModelList | ( | surfaceFilmRegionModel & | film | ) |
Construct null.
Definition at line 35 of file transferModelList.C.
References filmSubModelBase::film(), filmSubModelBase::filmSubModelBase(), and PtrList< transferModel >::PtrList().
| transferModelList | ( | surfaceFilmRegionModel & | film, |
| const dictionary & | dict ) |
Construct from type name, dictionary and surface film model.
Definition at line 42 of file transferModelList.C.
References subModelBase::dict(), Foam::endl(), filmSubModelBase::film(), filmSubModelBase::filmSubModelBase(), Foam::Info, transferModel::New(), PtrList< transferModel >::PtrList(), PtrList< transferModel >::set(), PtrList< transferModel >::setSize(), HashTable< T, Key, Hash >::size(), UPtrList< transferModel >::size(), and Foam::Zero.
|
virtual |
Destructor.
Definition at line 87 of file transferModelList.C.
|
virtual |
Correct kinematic transfers.
Definition at line 93 of file transferModelList.C.
References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), filmSubModelBase::film(), forAll, regionModel::intCoupledPatchIDs(), UPtrList< transferModel >::operator[](), patchIDs, and Foam::sum().
|
virtual |
Correct kinematic and thermodynamic transfers.
Definition at line 119 of file transferModelList.C.
References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), filmSubModelBase::film(), forAll, regionModel::intCoupledPatchIDs(), UPtrList< transferModel >::operator[](), patchIDs, and Foam::sum().
|
virtual |
Provide some info.
Definition at line 147 of file transferModelList.C.
References polyMesh::boundaryMesh(), Foam::endl(), filmSubModelBase::film(), forAll, subModelBase::getBaseProperty(), Foam::indent(), Foam::Info, regionModel::intCoupledPatchIDs(), Pstream::listCombineGather(), Foam::mag(), Foam::nl, UPtrList< transferModel >::operator[](), os(), patchIDs, transferModel::patchTransferredMassTotals(), pbm, regionModel::regionMesh(), subModelBase::setBaseProperty(), UPtrList< transferModel >::size(), transferModel::transferredMassTotal(), filmSubModelBase::writeTime(), and Foam::Zero.
1.16.1 