transferModelList Class Reference

Inheritance diagram for transferModelList:

Collaboration diagram for transferModelList:

Public Member Functions
	transferModelList (surfaceFilmRegionModel &film)
	transferModelList (surfaceFilmRegionModel &film, const dictionary &dict)
virtual	~transferModelList ()
virtual void	correct (scalarField &availableMass, volScalarField &massToTransfer)
virtual void	correct (scalarField &availableMass, volScalarField &massToTransfer, volScalarField &energyToTransfer)
virtual void	info (Ostream &os)
Public Member Functions inherited from PtrList< transferModel >
constexpr	PtrList () noexcept
	PtrList (const label len)
	PtrList (const PtrList< T > &list)
	PtrList (PtrList< T > &&list)
	PtrList (UList< T * > &list)
	PtrList (const PtrList< T > &list, const CloneArg &cloneArgs)
	PtrList (PtrList< T > &list, bool reuse)
	PtrList (const SLPtrList< T > &list)
	PtrList (Istream &is, const INew &inew)
	PtrList (Istream &is)
	PtrList (PtrList< T > &list, bool reuse)
	PtrList (const SLPtrList< T > &list)
constexpr	PtrList () noexcept
	PtrList (const label len)
	PtrList (const PtrList< T > &list)
	PtrList (PtrList< T > &&list)
	PtrList (UList< T * > &list)
	PtrList (Istream &is)
	~PtrList ()
PtrList< T >	clone (Args &&... args) const
Foam::PtrList< T >	clone (Args &&... args) const
const T *	set (const label i) const
autoPtr< T >	set (const label i, T *ptr)
autoPtr< T >	set (const label i, autoPtr< T > &ptr)
autoPtr< T >	set (const label i, autoPtr< T > &&ptr)
autoPtr< T >	set (const label i, std::unique_ptr< T > &&ptr)
autoPtr< T >	set (const label i, const refPtr< T > &ptr)
autoPtr< T >	set (const label i, const tmp< T > &ptr)
void	clear ()
void	resize (const label newLen)
void	setSize (const label newLen)
void	emplace_append (Args &&... args)
void	append (T *ptr)
void	append (autoPtr< T > &ptr)
void	append (autoPtr< T > &&ptr)
void	append (std::unique_ptr< T > &&ptr)
void	append (const refPtr< T > &ptr)
void	append (const tmp< T > &ptr)
autoPtr< T >	emplace (const label i, Args &&... args)
Foam::autoPtr< T >	emplace (const label i, Args &&... args)
autoPtr< T >	release (const label i)
void	transfer (PtrList< T > &list)
void	operator= (const PtrList< T > &list)
void	operator= (PtrList< T > &&list)
Public Member Functions inherited from filmSubModelBase
	filmSubModelBase (surfaceFilmRegionModel &film)
	filmSubModelBase (surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	filmSubModelBase (const word &modelName, surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType)
virtual	~filmSubModelBase ()
virtual bool	writeTime () const
const surfaceFilmRegionModel &	film () const
surfaceFilmRegionModel &	film ()
template<class FilmType >
const FilmType &	filmType () const
Public Member Functions inherited from subModelBase
	subModelBase (dictionary &properties)
	subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
	subModelBase (const subModelBase &smb)
virtual	~subModelBase ()
const word &	modelName () const
const dictionary &	dict () const
const word &	baseName () const
const word &	modelType () const
const dictionary &	coeffDict () const
const dictionary &	properties () const
virtual bool	defaultCoeffs (const bool printMsg) const
virtual bool	active () const
virtual void	cacheFields (const bool store)
virtual fileName	localPath () const
template<class Type >
Type	getBaseProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
template<class Type >
void	getBaseProperty (const word &entryName, Type &value) const
template<class Type >
void	setBaseProperty (const word &entryName, const Type &value)
bool	getModelDict (const word &entryName, dictionary &dict) const
template<class Type >
void	getModelProperty (const word &entryName, Type &value) const
template<class Type >
Type	getModelProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
template<class Type >
void	setModelProperty (const word &entryName, const Type &value)
virtual void	write (Ostream &os) const

Additional Inherited Members
Protected Member Functions inherited from PtrList< transferModel >
void	readIstream (Istream &is, const INew &inew)
void	free ()
Protected Member Functions inherited from subModelBase
bool	inLine () const
Protected Attributes inherited from filmSubModelBase
surfaceFilmRegionModel &	filmModel_
Protected Attributes inherited from subModelBase
const word	modelName_
dictionary &	properties_
const dictionary	dict_
const word	baseName_
const word	modelType_
const dictionary	coeffDict_

Detailed Description

Definition at line 52 of file transferModelList.H.

Constructor & Destructor Documentation

transferModelList() [1/2]

transferModelList

(

surfaceFilmRegionModel &

film

)

Definition at line 35 of file transferModelList.C.

transferModelList() [2/2]

transferModelList	(	surfaceFilmRegionModel &	film,
		const dictionary &	dict
	)

Definition at line 43 of file transferModelList.C.

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

Here is the call graph for this function:

~transferModelList()

~transferModelList ( )

virtual

Definition at line 87 of file transferModelList.C.

Member Function Documentation

correct() [1/2]

void correct ( scalarField &  availableMass, volScalarField &  massToTransfer  )

virtual

Definition at line 94 of file transferModelList.C.

References GeometricField::boundaryField(), GeometricField::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:

correct() [2/2]

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

virtual

Definition at line 120 of file transferModelList.C.

References GeometricField::boundaryField(), GeometricField::correctBoundaryConditions(), forAll, regionModel::intCoupledPatchIDs(), and Foam::sum().

Here is the call graph for this function:

info()

void info ( Ostream &  os )

virtual

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(), IOobject::name(), Foam::nl, os(), transferModel::patchTransferredMassTotals(), regionModel::regionMesh(), subModelBase::setBaseProperty(), transferModel::transferredMassTotal(), 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:

• src/regionModels/surfaceFilmModels/submodels/kinematic/transferModels/transferModelList/transferModelList.H
• src/regionModels/surfaceFilmModels/submodels/kinematic/transferModels/transferModelList/transferModelList.C