Base class for surface film models. More...

Inheritance diagram for surfaceFilmRegionModel:

Collaboration diagram for surfaceFilmRegionModel:

Public Member Functions
	TypeName ("surfaceFilmRegionModel")
	Runtime type information. More...

	surfaceFilmRegionModel (const word &modelType, const fvMesh &mesh, const dimensionedVector &g, const word &regionType)
	Construct from type name, mesh and gravity vector. More...

	surfaceFilmRegionModel (const surfaceFilmRegionModel &)=delete
	Disallow default bitwise copy construction. More...

virtual	~surfaceFilmRegionModel ()
	Destructor. More...

const dimensionedVector &	g () const
	Return the acceleration due to gravity. More...

virtual void	addSources (const label patchi, const label facei, const scalar massSource, const vector &momentumSource, const scalar pressureSource, const scalar energySource)=0
	External hook to add sources to the film. More...

virtual const volScalarField &	delta () const =0
	Return the film thickness [m]. More...

virtual const volScalarField &	alpha () const =0
	Return the film coverage, 1 = covered, 0 = uncovered / []. More...

virtual const volVectorField &	U () const =0
	Return the film velocity [m/s]. More...

virtual const volVectorField &	Us () const =0
	Return the film surface velocity [m/s]. More...

virtual const volVectorField &	Uw () const =0
	Return the film wall velocity [m/s]. More...

virtual const volScalarField &	rho () const =0
	Return the film density [kg/m^3]. More...

virtual const volScalarField &	T () const =0
	Return the film mean temperature [K]. More...

virtual const volScalarField &	Ts () const =0
	Return the film surface temperature [K]. More...

virtual const volScalarField &	Tw () const =0
	Return the film wall temperature [K]. More...

virtual const volScalarField &	hs () const =0
	Return the film surface temperature [J/kg]. More...

virtual const volScalarField &	Cp () const =0
	Return the film specific heat capacity [J/kg/K]. More...

virtual const volScalarField &	kappa () const =0
	Return the film thermal conductivity [W/m/K]. More...

virtual const volScalarField &	sigma () const =0
	Return the film surface tension [N/m]. More...

virtual tmp< volScalarField >	primaryMassTrans () const =0
	Return mass transfer source - Eulerian phase only. More...

virtual const volScalarField &	cloudMassTrans () const =0
	Return the film mass available for transfer. More...

virtual const volScalarField &	cloudDiameterTrans () const =0
	Return the parcel diameters originating from film. More...

virtual void	evolve ()
	Main driver routing to evolve the region - calls other evolves. More...

void	operator= (const surfaceFilmRegionModel &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from surfaceFilmModel
	TypeName ("surfaceFilmModel")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, surfaceFilmModel, mesh,(const word &modelType, const fvMesh &mesh, const dimensionedVector &g, const word &regionType),(modelType, mesh, g, regionType))

	surfaceFilmModel ()

	surfaceFilmModel (const surfaceFilmModel &)=delete
	Disallow default bitwise copy construction. More...

virtual	~surfaceFilmModel ()
	Destructor. More...

virtual scalar	CourantNumber () const =0
	Courant number evaluation. More...

virtual tmp< volScalarField::Internal >	Srho () const =0
	Return total mass source - Eulerian phase only. More...

virtual tmp< volScalarField::Internal >	Srho (const label i) const =0
	Return mass source for specie i - Eulerian phase only. More...

virtual tmp< volScalarField::Internal >	Sh () const =0
	Return enthalpy source - Eulerian phase only. More...

void	operator= (const surfaceFilmModel &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from singleLayerRegion
	TypeName ("regionModel")
	Runtime type information. More...

	singleLayerRegion (const fvMesh &mesh, const word &regionType)
	Construct null. More...

	singleLayerRegion (const fvMesh &mesh, const word &regionType, const word &modelName, bool readFields=true)
	Construct from mesh, region type and name. More...

	singleLayerRegion (const singleLayerRegion &)=delete
	Disallow default bitwise copy construction. More...

virtual	~singleLayerRegion ()
	Destructor. More...

virtual const volVectorField &	nHat () const
	Return the patch normal vectors. More...

virtual const volScalarField &	magSf () const
	Return the face area magnitudes / [m^2]. More...

virtual const labelList &	passivePatchIDs () const
	Return the list of patch IDs opposite to internally. More...

template<class Type >
wordList	mappedFieldAndInternalPatchTypes () const
	Return boundary types for mapped field patches. More...

template<class Type >
wordList	mappedPushedFieldPatchTypes () const
	Return boundary types for pushed mapped field patches. More...

void	operator= (const singleLayerRegion &)=delete
	Disallow default bitwise assignment. More...

template<class Type >
Foam::wordList	mappedFieldAndInternalPatchTypes () const

template<class Type >
Foam::wordList	mappedPushedFieldPatchTypes () const

Public Member Functions inherited from regionModel
	TypeName ("regionModel")
	Runtime type information. More...

	regionModel (const fvMesh &mesh, const word &regionType)
	Construct null. More...

	regionModel (const fvMesh &mesh, const word &regionType, const word &modelName, bool readFields=true)
	Construct from mesh, region type and name. More...

	regionModel (const fvMesh &mesh, const word &regionType, const word &modelName, const dictionary &dict, bool readFields=true)
	Construct from mesh and name and dict. More...

virtual	~regionModel ()
	Destructor. More...

const fvMesh &	primaryMesh () const
	Return the reference to the primary mesh database. More...

const Time &	time () const
	Return the reference to the time database. More...

const Switch &	active () const
	Return the active flag. More...

const Switch &	infoOutput () const
	Return the information flag. More...

const word &	modelName () const
	Return the model name. More...

const fvMesh &	regionMesh () const
	Return the region mesh database. More...

fvMesh &	regionMesh ()
	Return the region mesh database for manipulation. More...

const dictionary &	coeffs () const
	Return the model coefficients dictionary. More...

const dictionary &	solution () const
	Return the solution dictionary. More...

const IOdictionary &	outputProperties () const
	Return const access to the output properties dictionary. More...

IOdictionary &	outputProperties ()
	Return output properties dictionary. More...

bool	isCoupledPatch (const label regionPatchi) const
	Return true if patchi on the local region is a coupled. More...

bool	isRegionPatch (const label primaryPatchi) const
	Return true if patchi on the primary region is a coupled. More...

const labelList &	primaryPatchIDs () const
	Return the list of patch IDs on the primary region coupled. More...

const labelList &	intCoupledPatchIDs () const
	Return the list of patch IDs internally coupled with the. More...

label	regionPatchID (const label primaryPatchID) const
	Return region ID corresponding to primaryPatchID. More...

label	nbrCoupledPatchID (const regionModel &nbrRegion, const label regionPatchi) const
	Return the coupled patch ID paired with coupled patch. More...

template<class Type >
tmp< Foam::Field< Type > >	mapRegionPatchField (const regionModel &nbrRegion, const label regionPatchi, const label nbrPatchi, const Field< Type > &nbrField, const bool flip=false) const
	Map patch field from another region model to local patch. More...

template<class Type >
tmp< Field< Type > >	mapRegionPatchField (const regionModel &nbrRegion, const word &fieldName, const label regionPatchi, const bool flip=false) const
	Map patch field from another region model to local patch. More...

template<class Type >
tmp< Field< Type > >	mapRegionPatchInternalField (const regionModel &nbrRegion, const word &fieldName, const label regionPatchi, const bool flip=false) const
	Map patch internal field from another region model to local. More...

template<class Type >
void	toPrimary (const label regionPatchi, List< Type > &regionField) const
	Convert a local region field to the primary region. More...

template<class Type >
void	toRegion (const label regionPatchi, List< Type > &primaryFieldField) const
	Convert a primary region field to the local region. More...

template<class Type , class CombineOp >
void	toPrimary (const label regionPatchi, List< Type > &regionField, const CombineOp &cop) const
	Convert a local region field to the primary region with op. More...

template<class Type , class CombineOp >
void	toRegion (const label regionPatchi, List< Type > &primaryFieldField, const CombineOp &cop) const
	Convert a primary region field to the local region with op. More...

virtual void	preEvolveRegion ()
	Pre-evolve region. More...

virtual void	evolveRegion ()
	Evolve the region. More...

virtual void	postEvolveRegion ()
	Post-evolve region. More...

virtual void	info ()
	Provide some feedback. More...

template<class Type >
Foam::tmp< Foam::Field< Type > >	mapRegionPatchField (const regionModel &nbrRegion, const label regionPatchi, const label nbrPatchi, const Field< Type > &nbrField, const bool flip) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	mapRegionPatchField (const regionModel &nbrRegion, const word &fieldName, const label regionPatchi, const bool flip) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	mapRegionPatchInternalField (const regionModel &nbrRegion, const word &fieldName, const label regionPatchi, const bool flip) const

Public Member Functions inherited from IOdictionary
	IOdictionary (const IOobject &)
	Construct given an IOobject. More...

	IOdictionary (const IOobject &, const dictionary &)
	Construct given an IOobject and dictionary. More...

	IOdictionary (const IOobject &, Istream &)
	Construct given an IOobject and Istream. More...

	IOdictionary (const IOdictionary &)
	Copy constructor. More...

	IOdictionary (IOdictionary &&)
	Move constructor. More...

virtual	~IOdictionary ()
	Destructor. More...

virtual bool	global () const
	Is object global. More...

virtual fileName	filePath () const
	Return complete path + object name if the file exists. More...

void	operator= (IOdictionary &&)
	Move assignment. More...

Public Member Functions inherited from baseIOdictionary
	TypeName ("dictionary")

	baseIOdictionary (const IOobject &)
	Construct given an IOobject. More...

	baseIOdictionary (const IOobject &, const dictionary &)
	Construct given an IOobject and dictionary. More...

	baseIOdictionary (const IOobject &, Istream &)
	Construct given an IOobject and Istream. More...

	baseIOdictionary (const baseIOdictionary &)
	Copy constructor. More...

	baseIOdictionary (baseIOdictionary &&)
	Move constructor. More...

virtual	~baseIOdictionary ()
	Destructor. More...

const word &	name () const
	Name function is needed to disambiguate those inherited. More...

virtual bool	readData (Istream &)
	ReadData function required for regIOobject read operation. More...

virtual bool	writeData (Ostream &) const
	WriteData function required for regIOobject write operation. More...

void	operator= (const baseIOdictionary &)
	Assignment of other baseIOdictionary's entries to this. More...

void	operator= (baseIOdictionary &&)
	Move assignment. More...

Public Member Functions inherited from regIOobject
	TypeName ("regIOobject")
	Runtime type information. More...

	regIOobject (const IOobject &, const bool isTime=false)
	Construct from IOobject. Optional flag for if IOobject is the. More...

	regIOobject (const regIOobject &)
	Copy constructor. More...

	regIOobject (const regIOobject &, bool registerCopy)
	Copy constructor, transferring registry registration to copy. More...

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy constructor with new name, transferring registry registration. More...

	regIOobject (const IOobject &, const regIOobject &)
	Copy constructor with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

bool	checkIn ()
	Add object to registry. More...

bool	checkOut ()
	Remove object from registry. More...

virtual void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED) More...

bool	ownedByRegistry () const
	Is this object owned by the registry? More...

void	store ()
	Transfer ownership of this object to its registry. More...

void	release ()
	Release ownership of this object from its registry. More...

label	eventNo () const
	Event number at last update. More...

label &	eventNo ()
	Event number at last update. More...

bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object. More...

bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

void	setUpToDate ()
	Set up to date (obviously) More...

virtual void	rename (const word &newName)
	Rename. More...

bool	headerOk ()
	Read and check header info. More...

Istream &	readStream (const word &, const bool read=true)
	Return Istream and check object type against that given. More...

void	close ()
	Close Istream. More...

virtual label	addWatch (const fileName &)
	Add file watch for fileName on object if not yet watched. Return. More...

const labelList &	watchIndices () const
	Return file-monitoring handles. More...

labelList &	watchIndices ()
	Return file-monitoring handles. More...

virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) More...

virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...

virtual bool	writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
	Write using given format, version and compression. More...

virtual bool	write (const bool write=true) const
	Write using setting from DB. More...

void	operator= (const IOobject &)

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Runtime type information. More...

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, registry, io options. More...

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, local, registry, io options. More...

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const objectRegistry &registry)
	Construct from copy resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Construct from copy resetting name. More...

	IOobject (const IOobject &io)=default
	Copy constructor. More...

autoPtr< IOobject >	clone () const
	Clone. More...

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...

virtual	~IOobject ()
	Destructor. More...

const Time &	time () const
	Return time. More...

const objectRegistry &	db () const
	Return the local objectRegistry. More...

const word &	name () const
	Return name. More...

const word &	headerClassName () const
	Return name of the class name read from header. More...

word &	headerClassName ()
	Return name of the class name read from header. More...

string &	note ()
	Return non-constant access to the optional note. More...

const string &	note () const
	Return the optional note. More...

bool &	registerObject ()
	Register object created from this IOobject with registry if true. More...

bool	registerObject () const
	Register object created from this IOobject with registry if true. More...

readOption	readOpt () const

readOption &	readOpt ()

writeOption	writeOpt () const

writeOption &	writeOpt ()

word	group () const
	Return group (extension part of name) More...

word	member () const
	Return member (name without the extension) More...

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const

fileName &	instance ()

const fileName &	local () const

fileName	path () const
	Return complete path. More...

fileName	path (const word &instance, const fileName &local="") const
	Return complete path with alternative instance and local. More...

fileName	objectPath () const
	Return complete path + object name. More...

fileName	localFilePath (const word &typeName) const
	Helper for filePath that searches locally. More...

fileName	globalFilePath (const word &typeName) const
	Helper for filePath that searches up if in parallel. More...

bool	readHeader (Istream &)
	Read header. More...

template<class Type >
bool	typeHeaderOk (const bool checkType=true)
	Read header (uses typeFilePath to find file) and check header. More...

template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. More...

bool	writeHeader (Ostream &) const
	Write header. More...

bool	writeHeader (Ostream &, const word &objectType) const
	Write header. Allow override of type. More...

bool	good () const

bool	bad () const

InfoProxy< IOobject >	info () const
	Return info proxy. More...

void	operator= (const IOobject &)

template<class Name >
Foam::word	groupName (Name name, const word &group)

Public Member Functions inherited from dictionary
	ClassName ("dictionary")

	dictionary ()
	Construct top-level dictionary null. More...

	dictionary (const fileName &name)
	Construct top-level empty dictionary with given name. More...

	dictionary (const fileName &name, const dictionary &parentDict, Istream &)
	Construct given the entry name, parent dictionary and Istream,. More...

	dictionary (Istream &)
	Construct top-level dictionary from Istream,. More...

	dictionary (Istream &, const bool keepHeader)
	Construct top-level dictionary from Istream,. More...

	dictionary (const dictionary &parentDict, const dictionary &)
	Construct as copy given the parent dictionary. More...

	dictionary (const dictionary &)
	Construct top-level dictionary as copy. More...

	dictionary (const dictionary *)
	Construct top-level dictionary as copy from pointer to dictionary. More...

	dictionary (const dictionary &parentDict, dictionary &&)
	Move constructor transferring parameter contents. More...

	dictionary (dictionary &&)
	Move constructor. More...

autoPtr< dictionary >	clone () const
	Construct and return clone. More...

virtual	~dictionary ()
	Destructor. More...

const dictionary &	parent () const
	Return the parent dictionary. More...

bool	isNull () const
	Return whether this dictionary is null. More...

const dictionary &	topDict () const
	Return the top of the tree. More...

label	startLineNumber () const
	Return line number of first token in dictionary. More...

label	endLineNumber () const
	Return line number of last token in dictionary. More...

SHA1Digest	digest () const
	Return the SHA1 digest of the dictionary contents. More...

tokenList	tokens () const
	Return the dictionary as a list of tokens. More...

bool	found (const word &, bool recursive=false, bool patternMatch=true) const
	Search dictionary for given keyword. More...

const entry *	lookupEntryPtr (const word &, bool recursive, bool patternMatch) const
	Find and return an entry data stream pointer if present. More...

entry *	lookupEntryPtr (const word &, bool recursive, bool patternMatch)
	Find and return an entry data stream pointer for manipulation. More...

const entry &	lookupEntry (const word &, bool recursive, bool patternMatch) const
	Find and return an entry data stream if present otherwise error. More...

ITstream &	lookup (const word &, bool recursive=false, bool patternMatch=true) const
	Find and return an entry data stream. More...

template<class T >
T	lookupType (const word &, bool recursive=false, bool patternMatch=true) const
	Find and return a T,. More...

template<class T >
T	lookupOrDefault (const word &, const T &, bool recursive=false, bool patternMatch=true) const
	Find and return a T,. More...

template<class T >
T	lookupOrAddDefault (const word &, const T &, bool recursive=false, bool patternMatch=true)
	Find and return a T, if not found return the given. More...

template<class T >
bool	readIfPresent (const word &, T &, bool recursive=false, bool patternMatch=true) const
	Find an entry if present, and assign to T. More...

const entry *	lookupScopedEntryPtr (const word &, bool recursive, bool patternMatch) const
	Find and return an entry data stream pointer if present. More...

bool	isDict (const word &) const
	Check if entry is a sub-dictionary. More...

const dictionary *	subDictPtr (const word &) const
	Find and return a sub-dictionary pointer if present. More...

dictionary *	subDictPtr (const word &)
	Find and return a sub-dictionary pointer if present. More...

const dictionary &	subDict (const word &) const
	Find and return a sub-dictionary. More...

dictionary &	subDict (const word &)
	Find and return a sub-dictionary for manipulation. More...

dictionary	subOrEmptyDict (const word &, const bool mustRead=false) const
	Find and return a sub-dictionary as a copy, or. More...

const dictionary &	optionalSubDict (const word &) const
	Find and return a sub-dictionary if found. More...

wordList	toc () const
	Return the table of contents. More...

wordList	sortedToc () const
	Return the sorted table of contents. More...

List< keyType >	keys (bool patterns=false) const
	Return the list of available keys or patterns. More...

bool	substituteKeyword (const word &keyword)
	Substitute the given keyword prepended by '$' with the. More...

bool	substituteScopedKeyword (const word &keyword)
	Substitute the given scoped keyword prepended by '$' with the. More...

bool	add (entry *, bool mergeEntry=false)
	Add a new entry. More...

void	add (const entry &, bool mergeEntry=false)
	Add an entry. More...

void	add (const keyType &, const word &, bool overwrite=false)
	Add a word entry. More...

void	add (const keyType &, const string &, bool overwrite=false)
	Add a string entry. More...

void	add (const keyType &, const label, bool overwrite=false)
	Add a label entry. More...

void	add (const keyType &, const scalar, bool overwrite=false)
	Add a scalar entry. More...

void	add (const keyType &, const dictionary &, bool mergeEntry=false)
	Add a dictionary entry. More...

template<class T >
void	add (const keyType &, const T &, bool overwrite=false)
	Add a T entry. More...

void	set (entry *)
	Assign a new entry, overwrite any existing entry. More...

void	set (const entry &)
	Assign a new entry, overwrite any existing entry. More...

void	set (const keyType &, const dictionary &)
	Assign a dictionary entry, overwrite any existing entry. More...

template<class T >
void	set (const keyType &, const T &)
	Assign a T entry, overwrite any existing entry. More...

bool	remove (const word &)
	Remove an entry specified by keyword. More...

bool	changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool forceOverwrite=false)
	Change the keyword for an entry,. More...

bool	merge (const dictionary &)
	Merge entries from the given dictionary. More...

void	clear ()
	Clear the dictionary. More...

void	transfer (dictionary &)
	Transfer the contents of the argument and annul the argument. More...

bool	read (Istream &)
	Read dictionary from Istream. More...

bool	read (Istream &, const bool keepHeader)
	Read dictionary from Istream, optionally keeping the header. More...

void	write (Ostream &, const bool subDict=true) const
	Write dictionary, normally with sub-dictionary formatting. More...

ITstream &	operator[] (const word &) const
	Find and return entry. More...

void	operator= (const dictionary &)

void	operator= (dictionary &&)

void	operator+= (const dictionary &)
	Include entries from the given dictionary. More...

void	operator\|= (const dictionary &)
	Conditionally include entries from the given dictionary. More...

void	operator<<= (const dictionary &)
	Unconditionally include entries from the given dictionary. More...

Public Member Functions inherited from dictionaryName
	dictionaryName ()
	Construct dictionaryName null. More...

	dictionaryName (const fileName &name)
	Construct dictionaryName as copy of the given fileName. More...

	dictionaryName (dictionaryName &&name)
	Move constructor. More...

const fileName &	name () const
	Return the dictionary name. More...

fileName &	name ()
	Return the dictionary name. More...

const word	dictName () const
	Return the local dictionary name (final part of scoped name) More...

void	operator= (const dictionaryName &name)

void	operator= (dictionaryName &&name)

Public Member Functions inherited from ILList< LListBase, T >
	ILList ()
	Null construct. More...

	ILList (T *a)
	Construct given initial T. More...

	ILList (Istream &)
	Construct from Istream. More...

	ILList (const ILList< LListBase, T > &)
	Copy constructor. More...

	ILList (ILList< LListBase, T > &&)
	Move constructor. More...

template<class CloneArg >
	ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
	Copy constructor with additional argument for clone. More...

template<class INew >
	ILList (Istream &, const INew &)
	Construct from Istream using given Istream constructor class. More...

	~ILList ()
	Destructor. More...

bool	eraseHead ()
	Remove the head element specified from the list and delete it. More...

bool	erase (T *p)
	Remove the specified element from the list and delete it. More...

void	clear ()
	Clear the contents of the list. More...

void	transfer (ILList< LListBase, T > &)
	Transfer the contents of the argument into this List. More...

void	operator= (const ILList< LListBase, T > &)
	Assignment operator. More...

void	operator= (ILList< LListBase, T > &&)
	Move assignment operator. More...

Public Member Functions inherited from UILList< LListBase, T >
	UILList ()
	Null construct. More...

	UILList (T *a)
	Construct given initial T. More...

	UILList (const UILList< LListBase, T > &)
	Copy constructor. More...

	UILList (UILList< LListBase, T > &&)
	Move constructor. More...

T *	first ()
	Return the first entry. More...

const T *	first () const
	Return the first entry. More...

T *	last ()
	Return the last entry. More...

const T *	last () const
	Return the last entry. More...

T *	removeHead ()
	Remove and return head. More...

T *	remove (T *p)
	Remove and return element. More...

T *	remove (iterator &it)
	Remove and return specified by iterator. More...

void	operator= (const UILList< LListBase, T > &)
	Assignment operator. More...

void	operator= (UILList< LListBase, T > &&)
	Move assignment operator. More...

iterator	begin ()

const iterator &	end ()

const_iterator	cbegin () const

const const_iterator &	cend () const

const_iterator	begin () const

const const_iterator &	end () const

const_reverse_iterator	crbegin () const

const const_reverse_iterator &	crend () const

const_reverse_iterator	rbegin () const

const const_reverse_iterator &	rend () const

bool	operator== (const UILList< LListBase, T > &) const
	Equality operation on ULists of the same type. More...

bool	operator!= (const UILList< LListBase, T > &) const
	The opposite of the equality operation. Takes linear time. More...

Protected Member Functions
virtual bool	read ()
	Read control parameters from dictionary. More...

Protected Member Functions inherited from regionModel
virtual bool	read (const dictionary &dict)
	Read control parameters from dictionary. More...

virtual const AMIInterpolation &	interRegionAMI (const regionModel &nbrRegion, const label regionPatchi, const label nbrPatchi, const bool flip) const
	Create or return a new inter-region AMI object. More...

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstream::streamFormat PstreamFormat, const word &typeName)
	Helper: check readOpt flags and read if necessary. More...

Protected Member Functions inherited from IOobject
void	setBad (const string &)
	Set the object state to bad. More...

Protected Attributes
const dimensionedVector &	g_
	Acceleration due to gravity [m/s^2]. More...

Protected Attributes inherited from singleLayerRegion
autoPtr< volVectorField >	nHatPtr_
	Patch normal vectors. More...

autoPtr< volScalarField >	magSfPtr_
	Face area magnitudes / [m^2]. More...

labelList	passivePatchIDs_
	List of patch IDs opposite to internally coupled patches. More...

Protected Attributes inherited from regionModel
const fvMesh &	primaryMesh_
	Reference to the primary mesh database. More...

const Time &	time_
	Reference to the time database. More...

Switch	active_
	Active flag. More...

Switch	infoOutput_
	Active information output. More...

const word	modelName_
	Model name. More...

autoPtr< fvMesh >	regionMeshPtr_
	Pointer to the region mesh database. More...

dictionary	coeffs_
	Model coefficients dictionary. More...

autoPtr< IOdictionary >	outputPropertiesPtr_
	Dictionary of output properties. More...

labelList	primaryPatchIDs_
	List of patch IDs on the primary region coupled to this region. More...

labelList	intCoupledPatchIDs_
	List of patch IDs internally coupled with the primary region. More...

word	regionName_
	Region name. More...

regionModelFunctionObjectList	functions_
	Region model function objects. More...

wordList	interRegionAMINames_
	List of region names this region is coupled to. More...

PtrList< PtrList< AMIInterpolation > >	interRegionAMI_
	List of AMI objects per coupled region. More...

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState { GOOD, BAD }
	Enumeration defining the valid states of an IOobject. More...

enum	readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
	Enumeration defining the read options. More...

enum	writeOption { AUTO_WRITE = 0, NO_WRITE = 1 }
	Enumeration defining the write options. More...

enum	fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
	Enumeration defining the file checking options. More...

Public Types inherited from UILList< LListBase, T >
typedef T	value_type
	Type of values the DLList contains. More...

typedef T &	reference
	Type that can be used for storing into DLList::value_type. More...

typedef const T &	const_reference
	Type that can be used for storing into constant. More...

typedef label	size_type
	The type that can represent the size of a DLList. More...

typedef LListBase::iterator	LListBase_iterator

typedef LListBase::const_iterator	LListBase_const_iterator

Static Public Member Functions inherited from surfaceFilmModel
static autoPtr< surfaceFilmModel >	New (const fvMesh &mesh, const dimensionedVector &g, const word &regionType="surfaceFilm")
	Return a reference to the selected surface film model. More...

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *)
	Transfer ownership of the given object pointer to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &)
	Transfer ownership of the given object pointer to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class Name >
static word	groupName (Name name, const word &group)

static word	group (const word &name)
	Return group (extension part of name) More...

static word	member (const word &name)
	Return member (name without the extension) More...

template<class Stream >
static Stream &	writeBanner (Stream &os, bool noHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

template<class Stream >
static Stream &	writeDivider (Stream &os)
	Write the standard file section divider. More...

template<class Stream >
static Stream &	writeEndDivider (Stream &os)
	Write the standard end file divider. More...

Static Public Member Functions inherited from dictionary
static autoPtr< dictionary >	New (Istream &)
	Construct top-level dictionary on freestore from Istream. More...

Static Public Attributes inherited from surfaceFilmModel
static const dimensionedScalar	Tref
	Reference temperature for enthalpy. More...

Static Public Attributes inherited from regIOobject
static float	fileModificationSkew

Static Public Attributes inherited from IOobject
static const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames

static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...

Static Public Attributes inherited from dictionary
static const dictionary	null
	Null dictionary. More...

Detailed Description

Base class for surface film models.

Source files

Definition at line 53 of file surfaceFilmRegionModel.H.

Constructor & Destructor Documentation

◆ surfaceFilmRegionModel() [1/2]

surfaceFilmRegionModel	(	const word &	modelType,
		const fvMesh &	mesh,
		const dimensionedVector &	g,
		const word &	regionType
	)

Construct from type name, mesh and gravity vector.

Definition at line 59 of file surfaceFilmRegionModel.C.

References regionModel::active_, and surfaceFilmRegionModel::read().

Referenced by surfaceFilmRegionModel::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ surfaceFilmRegionModel() [2/2]

surfaceFilmRegionModel ( const surfaceFilmRegionModel & )

delete

Disallow default bitwise copy construction.

◆ ~surfaceFilmRegionModel()

~surfaceFilmRegionModel ( )

virtual

Destructor.

Definition at line 79 of file surfaceFilmRegionModel.C.

Member Function Documentation

◆ read()

bool read ( )

protectedvirtual

Read control parameters from dictionary.

Reimplemented from singleLayerRegion.

Reimplemented in kinematicSingleLayer, and thermoSingleLayer.

Definition at line 43 of file surfaceFilmRegionModel.C.

References singleLayerRegion::read(), and surfaceFilmRegionModel::surfaceFilmRegionModel().

Referenced by kinematicSingleLayer::read(), and surfaceFilmRegionModel::surfaceFilmRegionModel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "surfaceFilmRegionModel" )

Runtime type information.

◆ g()

const Foam::dimensionedVector & g ( ) const

inline

Return the acceleration due to gravity.

Definition at line 39 of file surfaceFilmRegionModelI.H.

References surfaceFilmRegionModel::g_.

Referenced by BrunDrippingInjection::correct(), and curvatureSeparation::curvatureSeparation().

Here is the caller graph for this function:

◆ addSources()

virtual void addSources	(	const label	patchi,
		const label	facei,
		const scalar	massSource,
		const vector &	momentumSource,
		const scalar	pressureSource,
		const scalar	energySource
	)

pure virtual

External hook to add sources to the film.

Implemented in kinematicSingleLayer, and thermoSingleLayer.

Referenced by ThermoSurfaceFilm< CloudType >::absorbInteraction().

Here is the caller graph for this function:

◆ delta()

virtual const volScalarField& delta ( ) const

pure virtual

Return the film thickness [m].

Implemented in kinematicSingleLayer.

Referenced by SurfaceFilmModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::cacheFilmFields(), patchInjection::correct(), and standardRadiation::Shs().

Here is the caller graph for this function:

◆ alpha()

virtual const volScalarField& alpha ( ) const

pure virtual

Return the film coverage, 1 = covered, 0 = uncovered / [].

Implemented in kinematicSingleLayer.

Referenced by contactAngleForce::correct(), primaryRadiation::Shs(), standardRadiation::Shs(), and constantRadiation::Shs().

Here is the caller graph for this function:

◆ U()

virtual const volVectorField& U ( ) const

pure virtual

Return the film velocity [m/s].

Implemented in kinematicSingleLayer.

Referenced by laminar::Us().

Here is the caller graph for this function:

◆ Us()

virtual const volVectorField& Us ( ) const

pure virtual

Return the film surface velocity [m/s].

Implemented in kinematicSingleLayer.

Referenced by SurfaceFilmModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::cacheFilmFields().

Here is the caller graph for this function:

◆ Uw()

virtual const volVectorField& Uw ( ) const

pure virtual

Return the film wall velocity [m/s].

Implemented in kinematicSingleLayer.

◆ rho()

virtual const volScalarField& rho ( ) const

pure virtual

Return the film density [kg/m^3].

Implemented in kinematicSingleLayer.

Referenced by SurfaceFilmModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::cacheFilmFields(), and patchInjection::correct().

Here is the caller graph for this function:

◆ T()

virtual const volScalarField& T ( ) const

pure virtual

Return the film mean temperature [K].

Implemented in kinematicSingleLayer, and thermoSingleLayer.

Referenced by temperatureDependentContactAngleForce::theta(), and perturbedTemperatureDependentContactAngleForce::theta().

Here is the caller graph for this function:

◆ Ts()

virtual const volScalarField& Ts ( ) const

pure virtual

Return the film surface temperature [K].

Implemented in kinematicSingleLayer, and thermoSingleLayer.

Referenced by ThermoSurfaceFilm< CloudType >::cacheFilmFields().

Here is the caller graph for this function:

◆ Tw()

virtual const volScalarField& Tw ( ) const

pure virtual

Return the film wall temperature [K].

Implemented in kinematicSingleLayer, and thermoSingleLayer.

◆ hs()

virtual const volScalarField& hs ( ) const

pure virtual

Return the film surface temperature [J/kg].

Implemented in kinematicSingleLayer, and thermoSingleLayer.

Referenced by transferModel::correct().

Here is the caller graph for this function:

◆ Cp()

virtual const volScalarField& Cp ( ) const

pure virtual

Return the film specific heat capacity [J/kg/K].

Implemented in kinematicSingleLayer, and thermoSingleLayer.

Referenced by ThermoSurfaceFilm< CloudType >::cacheFilmFields().

Here is the caller graph for this function:

◆ kappa()

virtual const volScalarField& kappa ( ) const

pure virtual

Return the film thermal conductivity [W/m/K].

Implemented in kinematicSingleLayer, and thermoSingleLayer.

◆ sigma()

virtual const volScalarField& sigma ( ) const

pure virtual

Return the film surface tension [N/m].

Implemented in kinematicSingleLayer.

Referenced by thermocapillaryForce::correct(), and contactAngleForce::correct().

Here is the caller graph for this function:

◆ primaryMassTrans()

virtual tmp<volScalarField> primaryMassTrans ( ) const

pure virtual

Return mass transfer source - Eulerian phase only.

Implemented in kinematicSingleLayer.

◆ cloudMassTrans()

virtual const volScalarField& cloudMassTrans ( ) const

pure virtual

Return the film mass available for transfer.

Implemented in kinematicSingleLayer.

Referenced by SurfaceFilmModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::cacheFilmFields().

Here is the caller graph for this function:

◆ cloudDiameterTrans()

virtual const volScalarField& cloudDiameterTrans ( ) const

pure virtual

Return the parcel diameters originating from film.

Implemented in kinematicSingleLayer.

Referenced by SurfaceFilmModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::cacheFilmFields().

Here is the caller graph for this function:

◆ evolve()

void evolve ( )

virtual

Main driver routing to evolve the region - calls other evolves.

Implements surfaceFilmModel.

Definition at line 86 of file surfaceFilmRegionModel.C.

References regionModel::evolve().

Here is the call graph for this function:

◆ operator=()

void operator= ( const surfaceFilmRegionModel & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ g_

const dimensionedVector& g_

protected

Acceleration due to gravity [m/s^2].

Definition at line 63 of file surfaceFilmRegionModel.H.

Referenced by surfaceFilmRegionModel::g(), kinematicSingleLayer::gNorm(), kinematicSingleLayer::gNormClipped(), and kinematicSingleLayer::gTan().

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

src/regionModels/surfaceFilmModels/surfaceFilmRegionModel/surfaceFilmRegionModel.H
src/regionModels/surfaceFilmModels/surfaceFilmRegionModel/surfaceFilmRegionModel.C
src/regionModels/surfaceFilmModels/surfaceFilmRegionModel/surfaceFilmRegionModelI.H

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ surfaceFilmRegionModel() [1/2]

◆ surfaceFilmRegionModel() [2/2]

◆ ~surfaceFilmRegionModel()

Member Function Documentation

◆ read()

◆ TypeName()

◆ g()

◆ addSources()

◆ delta()

◆ alpha()

◆ U()

◆ Us()

◆ Uw()

◆ rho()

◆ T()

◆ Ts()

◆ Tw()

◆ hs()

◆ Cp()

◆ kappa()

◆ sigma()

◆ primaryMassTrans()

◆ cloudMassTrans()

◆ cloudDiameterTrans()

◆ evolve()

◆ operator=()

Member Data Documentation

◆ g_