List container for film ejection models. More...
Public Member Functions | |
ejectionModelList (surfaceFilmRegionModel &film) | |
Construct null. More... | |
ejectionModelList (surfaceFilmRegionModel &film, const dictionary &dict) | |
Construct from type name, dictionary and surface film model. More... | |
ejectionModelList (const ejectionModelList &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~ejectionModelList () |
Destructor. More... | |
virtual void | correct (scalarField &availableMass, volScalarField &massToEject, volScalarField &diameterToEject) |
Correct. More... | |
virtual void | info (Ostream &os) |
Provide some info. More... | |
void | operator= (const ejectionModelList &)=delete |
Disallow default bitwise assignment. More... | |
Public Member Functions inherited from PtrList< ejectionModel > | |
PtrList () | |
Null Constructor. More... | |
PtrList (const label) | |
Construct with size specified. More... | |
PtrList (const PtrList< ejectionModel > &) | |
Copy constructor. More... | |
PtrList (const PtrList< ejectionModel > &, const CloneArg &) | |
Copy constructor with additional argument for clone. More... | |
PtrList (PtrList< ejectionModel > &&) | |
Move constructor. More... | |
PtrList (PtrList< ejectionModel > &, bool reuse) | |
Construct as copy or re-use as specified. More... | |
PtrList (const SLPtrList< ejectionModel > &) | |
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 | clear () |
Clear the PtrList, i.e. set size to zero deleting all the. More... | |
void | append (ejectionModel *) |
Append an element at the end of the list. More... | |
void | append (const autoPtr< ejectionModel > &) |
void | append (const tmp< ejectionModel > &) |
void | transfer (PtrList< ejectionModel > &) |
Transfer the contents of the argument PtrList into this PtrList. More... | |
bool | set (const label) const |
Is element set. More... | |
autoPtr< ejectionModel > | set (const label, ejectionModel *) |
Set element to given T* and return old element (can be nullptr) More... | |
autoPtr< ejectionModel > | set (const label, const autoPtr< ejectionModel > &) |
Set element to given autoPtr<T> and return old element. More... | |
autoPtr< ejectionModel > | set (const label, const tmp< ejectionModel > &) |
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< ejectionModel > &) |
Assignment operator. More... | |
void | operator= (PtrList< ejectionModel > &&) |
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 re-use as specified. 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 | 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... | |
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 |
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) | |
Copy constructor. 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 void | cacheFields (const bool store) |
Cache dependent 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... | |
void | operator= (const subModelBase &)=delete |
Disallow default bitwise assignment. More... | |
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< ejectionModel > | |
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 | |
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 ejection models.
Definition at line 54 of file ejectionModelList.H.
ejectionModelList | ( | surfaceFilmRegionModel & | film | ) |
Construct null.
Definition at line 39 of file ejectionModelList.C.
ejectionModelList | ( | surfaceFilmRegionModel & | film, |
const dictionary & | dict | ||
) |
Construct from type name, dictionary and surface film model.
Definition at line 47 of file ejectionModelList.C.
References Foam::endl(), forAll, forAllConstIter, dictionary::found(), Foam::Info, dictionary::isDict(), dictionary::lookup(), ejectionModel::New(), dictionary::null, PtrList< ejectionModel >::setSize(), UPtrList< T >::size(), and dictionary::subDict().
|
delete |
Disallow default bitwise copy construction.
|
virtual |
Destructor.
Definition at line 107 of file ejectionModelList.C.
References ejectionModelList::correct().
|
virtual |
Correct.
Definition at line 114 of file ejectionModelList.C.
References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), ejectionModel::correct(), GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), filmSubModelBase::film(), forAll, regionModel::intCoupledPatchIDs(), UPtrList< T >::operator[](), patchi, and Foam::sum().
Referenced by thermoSingleLayer::updateSubmodels(), kinematicSingleLayer::updateSubmodels(), and ejectionModelList::~ejectionModelList().
|
virtual |
Provide some info.
Definition at line 142 of file ejectionModelList.C.
References polyMesh::boundaryMesh(), ejectionModel::ejectedMassTotal(), Foam::endl(), filmSubModelBase::film(), forAll, subModelBase::getBaseProperty(), polyMesh::globalData(), Foam::indent(), Foam::Info, regionModel::intCoupledPatchIDs(), Pstream::listCombineGather(), Foam::mag(), IOobject::name(), Foam::nl, UPtrList< T >::operator[](), ejectionModel::patchEjectedMassTotals(), patchi, globalMeshData::processorPatches(), regionModel::regionMesh(), subModelBase::setBaseProperty(), UPtrList< T >::size(), List< T >::size(), and filmSubModelBase::writeTime().
Referenced by kinematicSingleLayer::info().
|
delete |
Disallow default bitwise assignment.