Public Member Functions | List of all members
transferModelList Class Reference
Inheritance diagram for transferModelList:
Inheritance graph
[legend]
Collaboration diagram for transferModelList:
Collaboration graph
[legend]

Public Member Functions

 transferModelList (surfaceFilmModel &film)
 Construct null. More...
 
 transferModelList (surfaceFilmModel &film, const dictionary &dict)
 Construct from type name, dictionary and surface film model. More...
 
virtual ~transferModelList ()
 Destructor. More...
 
virtual void correct (scalarField &availableMass, volScalarField &massToTransfer)
 Correct kinematic transfers. More...
 
virtual void correct (scalarField &availableMass, volScalarField &massToTransfer, volScalarField &energyToTransfer)
 Correct kinematic and thermodynamic transfers. More...
 
virtual void info (Ostream &os)
 Provide some info. More...
 
- Public Member Functions inherited from PtrList< transferModel >
 PtrList ()
 Null Constructor. More...
 
 PtrList (const label)
 Construct with size specified. More...
 
 PtrList (const PtrList< transferModel > &)
 Copy constructor. More...
 
 PtrList (const PtrList< transferModel > &, const CloneArg &)
 Copy constructor with additional argument for clone. More...
 
 PtrList (const Xfer< PtrList< transferModel >> &)
 Construct by transferring the parameter contents. More...
 
 PtrList (PtrList< transferModel > &, bool reuse)
 Construct as copy or re-use as specified. More...
 
 PtrList (const SLPtrList< transferModel > &)
 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 (transferModel *)
 Append an element at the end of the list. More...
 
void append (const autoPtr< transferModel > &)
 
void append (const tmp< transferModel > &)
 
void transfer (PtrList< transferModel > &)
 Transfer the contents of the argument PtrList into this PtrList. More...
 
Xfer< PtrList< transferModel > > xfer ()
 Transfer contents to the Xfer container. More...
 
bool set (const label) const
 Is element set. More...
 
autoPtr< transferModel > set (const label, transferModel *)
 Set element to given T* and return old element (can be nullptr) More...
 
autoPtr< transferModel > set (const label, const autoPtr< transferModel > &)
 Set element to given autoPtr<T> and return old element. More...
 
autoPtr< transferModel > set (const label, const tmp< transferModel > &)
 Set element to given tmp<T> and return old element. More...
 
void reorder (const labelUList &)
 Reorders elements. Ordering does not have to be done in. More...
 
void operator= (const PtrList< transferModel > &)
 Assignment. More...
 
- Public Member Functions inherited from UPtrList< T >
 UPtrList ()
 Null Constructor. More...
 
 UPtrList (const label)
 Construct with size specified. More...
 
 UPtrList (const Xfer< UPtrList< T >> &)
 Construct by transferring the parameter contents. 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...
 
Tfirst ()
 Return reference to the first element of the list. More...
 
const Tfirst () const
 Return reference to first element of the list. More...
 
Tlast ()
 Return reference to the last element of the list. More...
 
const Tlast () 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...
 
Xfer< UPtrList< T > > xfer ()
 Transfer contents to the Xfer container. More...
 
bool set (const label) const
 Is element set. More...
 
Tset (const label, T *)
 Set element. Return old element (can be nullptr). More...
 
void reorder (const labelUList &)
 Reorders elements. Ordering does not have to be done in. More...
 
const Toperator[] (const label) const
 Return element const reference. More...
 
Toperator[] (const label)
 Return element reference. More...
 
const Toperator() (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...
 
- Public Member Functions inherited from filmSubModelBase
 filmSubModelBase (surfaceFilmModel &film)
 Construct null. More...
 
 filmSubModelBase (surfaceFilmModel &film, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 Construct from film film wihout name. More...
 
 filmSubModelBase (const word &modelName, surfaceFilmModel &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 surfaceFilmModelfilm () const
 Return const access to the film surface film model. More...
 
surfaceFilmModelfilm ()
 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 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...
 

Additional Inherited Members

- Public Types inherited from UPtrList< T >
typedef T value_type
 Type of values the UPtrList contains. More...
 
typedef Treference
 Type that can be used for storing into UPtrList::value_type objects. More...
 
typedef const Tconst_reference
 Type that can be used for storing into constant UPtrList::value_type. More...
 
- Protected Member Functions inherited from PtrList< transferModel >
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
surfaceFilmModelfilmModel_
 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

Definition at line 54 of file transferModelList.H.

Constructor & Destructor Documentation

◆ transferModelList() [1/2]

Construct null.

Definition at line 39 of file transferModelList.C.

◆ transferModelList() [2/2]

transferModelList ( surfaceFilmModel film,
const dictionary dict 
)

Construct from type name, dictionary and surface film model.

Definition at line 47 of file transferModelList.C.

References Foam::endl(), forAll, forAllConstIter(), Foam::Info, dictionary::lookupOrDefault(), transferModel::New(), and PtrList< transferModel >::setSize().

Here is the call graph for this function:

◆ ~transferModelList()

~transferModelList ( )
virtual

Destructor.

Definition at line 96 of file transferModelList.C.

References transferModelList::correct().

Here is the call graph for this function:

Member Function Documentation

◆ correct() [1/2]

void correct ( scalarField availableMass,
volScalarField massToTransfer 
)
virtual

◆ correct() [2/2]

void correct ( scalarField availableMass,
volScalarField massToTransfer,
volScalarField energyToTransfer 
)
virtual

◆ info()

void info ( Ostream os)
virtual

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