Thermodynamic form of single-cell layer surface film model. More...

Inheritance diagram for thermoSingleLayer:

Collaboration diagram for thermoSingleLayer:

[legend]

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

	thermoSingleLayer (const word &modelType, const fvMesh &mesh, const dimensionedVector &g, const word &regionType, const bool readFields=true)
	Construct from components. More...

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

virtual	~thermoSingleLayer ()
	Destructor. More...

const fluidThermo &	primaryThermo () const
	Return const reference to the primary region thermo object. More...

virtual tmp< volScalarField::Internal >	Ts () const
	Return the film surface temperature [K]. More...

virtual tmp< volScalarField::Internal >	Tw () const
	Return the film wall temperature [K]. More...

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

const volScalarField::Internal &	hSp () const
	Energy [J/m2/s]. More...

const volScalarField &	hSpPrimary () const
	Energy [J/m2/s]. More...

const volScalarField &	TPrimary () const
	Temperature [K]. More...

const PtrList< volScalarField > &	YPrimary () const
	Specie mass fractions [0-1]. More...

const heatTransferModel &	htcs () const
	Return const access to the (surface) heat transfer model. More...

const heatTransferModel &	htcw () const
	Return const access to the (wall) heat transfer model. More...

const phaseChangeModel &	phaseChange () const
	Return const access to the phase change model. More...

const radiationModel &	radiation () const
	Return const access to the radiation model. More...

virtual void	preEvolveRegion ()
	Pre-evolve film hook. More...

virtual void	evolveRegion ()
	Evolve the film equations. More...

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

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

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

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

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

	kinematicSingleLayer (const word &modelType, const fvMesh &mesh, const dimensionedVector &g, const word &regionType, const bool readFields=true)
	Construct from components. More...

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

virtual	~kinematicSingleLayer ()
	Destructor. More...

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

const dimensionedScalar &	deltaSmall () const
	Return small delta. More...

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

const volScalarField &	mu () const
	Return const access to the dynamic viscosity [Pa.s]. More...

tmp< volScalarField >	sigma () const
	Return the surface tension coefficient [kg/s^2]. More...

const volScalarField &	delta () const
	Return const access to the film thickness [m]. More...

const volScalarField &	alpha () const
	Return const access to the film volume fraction []. More...

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

const surfaceScalarField &	phi () const
	Return the film flux [kg m/s]. More...

const surfaceScalarField &	phiU () const
	Return the film velocity flux [m^3/s]. More...

const volScalarField::Internal &	continuityErr () const
	Return the current continuity error. More...

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

tmp< volVectorField::Internal >	Us () const
	Return the film surface velocity [m/s]. More...

tmp< volVectorField::Internal >	Uw () const
	Return the film wall velocity [m/s]. More...

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

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

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

virtual tmp< volVectorField >	primaryMomentumTrans () const
	Return momentum transfer source - Eulerian phase only. More...

volVectorField &	USpPrimary ()
	Momentum [kg/m/s^2]. More...

volScalarField &	pSpPrimary ()
	Pressure [Pa]. More...

volScalarField &	rhoSpPrimary ()
	Mass [kg/m^2/s]. More...

volVectorField::Internal &	USp ()
	Momentum [kg/m/s^2]. More...

volScalarField::Internal &	pSp ()
	Pressure [Pa]. More...

volScalarField::Internal &	rhoSp ()
	Mass [kg/m^2/s]. More...

const volVectorField::Internal &	USp () const
	Momentum [kg/m/s^2]. More...

const volScalarField::Internal &	pSp () const
	Pressure [Pa]. More...

const volScalarField::Internal &	rhoSp () const
	Mass [kg/m^2/s]. More...

const volVectorField &	UPrimary () const
	Velocity [m/s]. More...

const volScalarField &	pPrimary () const
	Pressure [Pa]. More...

const volScalarField &	rhoPrimary () const
	Density [kg/m^3]. More...

const volScalarField &	muPrimary () const
	Viscosity [Pa.s]. More...

const rhoThermo &	thermo () const
	Film thermo. More...

ejectionModelList &	ejection ()
	Ejection. More...

transferModelList &	transfer ()
	Transfer. More...

const momentumTransportModel &	momentumTransport () const
	Momentum transport. More...

tmp< volScalarField::Internal >	mass () const
	Return the current film mass. More...

tmp< volScalarField::Internal >	deltaMass () const
	Return the change in film mass due to sources/sinks. More...

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

virtual tmp< volVectorField::Internal >	SU () const
	Return momentum source - Eulerian phase only. More...

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

Public Member Functions inherited from surfaceFilmRegionModel
	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	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...

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, 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...

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

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

const volScalarField &	VbyA () const
	Return the cell layer volume/area [m]. More...

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...

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

template<class Type >
Foam::wordList	mappedFieldAndInternalPatchTypes () 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 &	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 , 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 >
void	toRegion (const label regionPatchi, List< Type > &primaryFieldField) const
	Convert a primary region field to the local region. More...

template<class Type >
void	toRegion (Field< Type > &regionField, const label regionPatchi, const fvPatchField< Type > &primaryPatchField) const
	Return a primary patch field mapped the region internal field. More...

template<class Type >
void	toRegion (Field< Type > &rf, const typename GeometricField< Type, fvPatchField, volMesh >::Boundary &pBf) const
	Return a primary patch field mapped the local region. More...

virtual void	postEvolveRegion ()
	Post-evolve region. 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
	TypeName ("dictionary")

	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...

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 IOdictionary &)
	Assignment of dictionary entries only. More...

void	operator= (IOdictionary &&)
	Move assignment of dictionary entries only. 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...

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...

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...

word	modelName (const char *name) const
	Return the name of the object within this model. 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	localPath () const
	Return the path relative to the case. More...

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

fileName	localObjectPath () const
	Return complete localPath + 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)

template<class Name >
Foam::word	modelName (Name name, const word &model)

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 &, const bool keepHeader=false)
	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 *	lookupEntryPtrBackwardsCompatible (const wordList &, bool recursive, bool patternMatch) const
	Find and return an entry data stream if present, trying a list. More...

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

const entry &	lookupEntryBackwardsCompatible (const wordList &, bool recursive, bool patternMatch) const
	Find and return an entry data stream if present, trying a list. More...

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

ITstream &	lookupBackwardsCompatible (const wordList &, bool recursive=false, bool patternMatch=true) const
	Find and return an entry data stream, trying a list of keywords. More...

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

template<class T >
T	lookupBackwardsCompatible (const wordList &, bool recursive=false, bool patternMatch=true) const
	Find and return a T, trying a list of keywords in sequence. 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	lookupOrDefaultBackwardsCompatible (const wordList &, const T &, bool recursive=false, bool patternMatch=true) const
	Find and return a T, trying a list of keywords in sequence. 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...

const dictionary &	scopedDict (const word &) const
	Find and return a sub-dictionary by scoped lookup. More...

dictionary &	scopedDict (const word &)
	Find and return a sub-dictionary by scoped lookup. 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 &, const bool keepHeader=false)
	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...

virtual void	correctHforMappedT ()
	Correct sensible enthalpy for mapped temperature fields. More...

virtual void	resetPrimaryRegionSourceTerms ()
	Reset source term fields. More...

virtual void	transferPrimaryRegionThermoFields ()
	Transfer thermo fields from the primary region to the film region. More...

virtual void	transferPrimaryRegionSourceFields ()
	Transfer source fields from the primary region to the film region. More...

virtual void	correctCoverage ()
	Correct film coverage field. More...

virtual void	updateSubmodels ()
	Update the film sub-models. More...

virtual tmp< fvScalarMatrix >	q (volScalarField &h) const
	Return the wall/surface heat transfer term for the enthalpy equation. More...

virtual void	solveEnergy ()
	Solve energy equation. More...

Protected Member Functions inherited from kinematicSingleLayer
tmp< surfaceScalarField >	rhog () const
	Hydrostatic pressure coefficient. More...

tmp< surfaceScalarField >	gGradRho () const
	Hydrostatic pressure coefficient gradient. More...

tmp< volScalarField >	pc ()
	Capillary pressure. More...

tmp< volScalarField >	pe ()
	Explicit pressure. More...

virtual void	updateContinuityErr ()

virtual void	continuityCheck ()
	Continuity check. More...

template<class Type >
tmp< Type >	constrainFilmField (const tmp< Type > &field, const typename Type::cmptType &value)
	Constrain a film region master/slave boundaries of a field to a. More...

virtual void	predictDelta ()
	Predict delta_ from the continuity equation. More...

virtual tmp< fvVectorMatrix >	solveMomentum (const volScalarField &pc, const volScalarField &pe)
	Solve for film velocity. More...

virtual void	solveAlpha (const fvVectorMatrix &UEqn, const volScalarField &pc, const volScalarField &pe)
	Solve for film volume fraction and thickness. 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 IOdictionary
	IOdictionary (const IOobject &io, const word &wantedType)
	Construct given an IOobject, supply wanted typeName. More...

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

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

Protected Attributes
const word	phaseName_

const fluidThermo &	primaryThermo_
	Reference to the primary region thermo. More...

volScalarField	primaryEnergyTrans_
	Film energy transfer. More...

scalar	deltaWet_
	Threshold film thickness beyond which the film is considered 'wet'. More...

bool	hydrophilic_
	Activation flag. More...

scalar	hydrophilicDryScale_
	Length scale applied to deltaWet_ to determine when a wet. More...

scalar	hydrophilicWetScale_
	Length scale applied to deltaWet_ to determine when a dry. More...

volScalarField::Internal	hSp_
	Energy [J/m2/s]. More...

volScalarField	hSpPrimary_
	Energy [J/m2/s]. More...

volScalarField	TPrimary_
	Temperature [K]. More...

PtrList< volScalarField >	YPrimary_
	List of specie mass fractions [0-1]. More...

autoPtr< heatTransferModel >	htcs_
	Heat transfer coefficient between film surface and primary. More...

autoPtr< heatTransferModel >	htcw_
	Heat transfer coefficient between wall and film [W/m^2/K]. More...

autoPtr< phaseChangeModel >	phaseChange_
	Phase change. More...

autoPtr< radiationModel >	radiation_
	Radiation. More...

scalar	Tmin_
	Minimum temperature limit (optional) More...

scalar	Tmax_
	Maximum temperature limit (optional) More...

Protected Attributes inherited from kinematicSingleLayer
pimpleControl	pimple_

scalar	cumulativeContErr_
	Cumulative continuity error. More...

const dimensionedScalar	deltaSmall_
	Small delta. More...

scalar	deltaCoLimit_
	Film thickness above which Courant number calculation in valid. More...

volScalarField	p_
	Pressure [Pa]. More...

autoPtr< rhoThermo >	thermo_

volScalarField	mu_
	Dynamic viscosity [Pa.s]. More...

volScalarField	delta_
	Film thickness [m]. More...

volScalarField	alpha_
	Film volume fraction in the cell layer []. More...

volVectorField	U_
	Velocity - mean [m/s]. More...

volVectorField::Internal	Uw_
	Velocity - wall [m/s]. More...

surfaceScalarField	phi_
	Mass flux [kg m/s]. More...

surfaceScalarField	phiU_
	Film velocity flux [m^3/s]. More...

volScalarField::Internal	continuityErr_
	Current continuity error caused by delta_ bounding. More...

volScalarField	coverage_
	Film coverage indicator, 1 = covered, 0 = uncovered []. More...

volScalarField	primaryMassTrans_
	Film mass available for transfer to the primary region. More...

volScalarField	cloudMassTrans_
	Film mass available for transfer to cloud. More...

volScalarField	cloudDiameterTrans_
	Parcel diameters originating from film to cloud. More...

volVectorField	primaryMomentumTrans_
	Film momentum transfer. More...

volScalarField::Internal	rhoSp_
	Mass [kg/m^2/s]. More...

volVectorField::Internal	USp_
	Momentum [kg/m/s^2]. More...

volScalarField::Internal	pSp_
	Pressure [Pa]. More...

volScalarField	rhoSpPrimary_
	Primary region mass source [kg]. More...

volVectorField	USpPrimary_
	Primary region tangential momentum source [kg m/s]. More...

volScalarField	pSpPrimary_
	Primary region normal momentum source (pressure) [kg m/s]. More...

volVectorField	UPrimary_
	Velocity [m/s]. More...

volScalarField	rhoPrimary_
	Density [kg/m^3]. More...

volScalarField	muPrimary_
	Viscosity [Pa.s]. More...

autoPtr< viscosityModel >	viscosity_
	Viscosity model. More...

autoPtr< Function1< scalar > >	sigma_
	Surface tension function. More...

scalarField	availableMass_
	Available mass for transfer via sub-models. More...

ejectionModelList	ejection_
	Cloud ejection. More...

transferModelList	transfer_
	Transfer with the continuous phase. More...

autoPtr< momentumTransportModel >	momentumTransport_
	Momentum transport model. More...

forceList	forces_
	List of film forces. More...

scalar	addedMassTotal_
	Cumulative mass added via sources [kg]. 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	infoOutput_
	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 Name >
static word	modelName (Name name, const word &model)
	Return the name of the object within the given model. 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 IOdictionary
static bool	writeDictionaries

Static Public Attributes inherited from regIOobject
static float	fileModificationSkew

Static Public Attributes inherited from IOobject
static constexpr const char *	foamFile = "FoamFile"
	Keyword for the FoamFile header sub-dictionary. More...

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...

static bool	writeOptionalEntries
	If true write optional keywords and values. More...

Detailed Description

Thermodynamic form of single-cell layer surface film model.

Note: defining enthalpy as Cp(T - Tstd) - when using liquids from the thermophysical library, their enthalpies are calculated similarly, where Tstd = 298.15K. This is clearly non-conservative unless the heat-capacity is constant and should be rewritten to use the standard thermodynamics packages.

Source files

Definition at line 68 of file thermoSingleLayer.H.

Constructor & Destructor Documentation

◆ thermoSingleLayer() [1/2]

thermoSingleLayer	(	const word &	modelType,
		const fvMesh &	mesh,
		const dimensionedVector &	g,
		const word &	regionType,
		const bool	readFields = `true`
	)

Construct from components.

Definition at line 277 of file thermoSingleLayer.C.

References kinematicSingleLayer::alpha_, IOobject::AUTO_WRITE, regionModel::coeffs(), regionModel::coeffs_, thermoSingleLayer::correctCoverage(), Foam::dimless, Foam::endl(), Foam::fvc::flux(), forAll, thermoSingleLayer::hydrophilic_, thermoSingleLayer::hydrophilicDryScale_, thermoSingleLayer::hydrophilicWetScale_, Foam::Info, dictionary::lookup(), IOobject::NO_READ, IOobject::NO_WRITE, kinematicSingleLayer::phi(), kinematicSingleLayer::phi_, thermoSingleLayer::primaryThermo_, IOobject::READ_IF_PRESENT, dictionary::readIfPresent(), regionModel::regionMesh(), kinematicSingleLayer::rho(), List< T >::size(), basicSpecieMixture::species(), regionModel::time(), timeName, Time::timeName(), thermoSingleLayer::Tmax_, thermoSingleLayer::Tmin_, thermoSingleLayer::transferPrimaryRegionThermoFields(), kinematicSingleLayer::U_, and thermoSingleLayer::YPrimary_.

Referenced by thermoSingleLayer::solveEnergy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ thermoSingleLayer() [2/2]

thermoSingleLayer ( const thermoSingleLayer & )

delete

Disallow default bitwise copy construction.

◆ ~thermoSingleLayer()

~thermoSingleLayer ( )

virtual

Destructor.

Definition at line 449 of file thermoSingleLayer.C.

References thermoSingleLayer::addSources().

Here is the call graph for this function:

Member Function Documentation

◆ read()

bool read ( )

protectedvirtual

Read control parameters from dictionary.

Reimplemented from kinematicSingleLayer.

Definition at line 68 of file thermoSingleLayer.C.

References kinematicSingleLayer::read().

Here is the call graph for this function:

◆ correctHforMappedT()

void correctHforMappedT ( )

protectedvirtual

Correct sensible enthalpy for mapped temperature fields.

Definition at line 85 of file thermoSingleLayer.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), forAll, basicThermo::he(), Foam::isA(), patchi, Foam::T(), kinematicSingleLayer::thermo(), and kinematicSingleLayer::thermo_.

Referenced by thermoSingleLayer::evolveRegion(), and thermoSingleLayer::solveEnergy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetPrimaryRegionSourceTerms()

void resetPrimaryRegionSourceTerms ( )

protectedvirtual

Reset source term fields.

Reimplemented from kinematicSingleLayer.

Definition at line 75 of file thermoSingleLayer.C.

References DebugInFunction, DimensionedField< Type, GeoMesh >::dimensions(), Foam::endl(), thermoSingleLayer::hSp_, thermoSingleLayer::hSpPrimary_, and kinematicSingleLayer::resetPrimaryRegionSourceTerms().

Referenced by thermoSingleLayer::evolveRegion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ transferPrimaryRegionThermoFields()

void transferPrimaryRegionThermoFields ( )

protectedvirtual

Transfer thermo fields from the primary region to the film region.

Reimplemented from kinematicSingleLayer.

Definition at line 104 of file thermoSingleLayer.C.

References GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), DebugInFunction, Foam::endl(), forAll, thermoSingleLayer::TPrimary_, kinematicSingleLayer::transferPrimaryRegionThermoFields(), and thermoSingleLayer::YPrimary_.

Referenced by thermoSingleLayer::thermoSingleLayer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ transferPrimaryRegionSourceFields()

void transferPrimaryRegionSourceFields ( )

protectedvirtual

Transfer source fields from the primary region to the film region.

Reimplemented from kinematicSingleLayer.

Definition at line 120 of file thermoSingleLayer.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), DebugInFunction, TimeState::deltaTValue(), Foam::endl(), DimensionedField< Type, GeoMesh >::field(), forAll, thermoSingleLayer::hSp_, thermoSingleLayer::hSpPrimary_, singleLayerRegion::magSf(), patchi, regionModel::primaryMesh(), regionModel::time_, regionModel::toRegion(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), and singleLayerRegion::VbyA().

Here is the call graph for this function:

◆ correctCoverage()

void correctCoverage ( )

protectedvirtual

Correct film coverage field.

Reimplemented from kinematicSingleLayer.

Definition at line 146 of file thermoSingleLayer.C.

References GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), kinematicSingleLayer::coverage_, kinematicSingleLayer::delta_, thermoSingleLayer::deltaWet_, Foam::dimLength, forAll, thermoSingleLayer::hydrophilic_, thermoSingleLayer::hydrophilicDryScale_, thermoSingleLayer::hydrophilicWetScale_, and Foam::pos().

Referenced by thermoSingleLayer::evolveRegion(), and thermoSingleLayer::thermoSingleLayer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateSubmodels()

void updateSubmodels ( )

protectedvirtual

Update the film sub-models.

Reimplemented from kinematicSingleLayer.

Definition at line 174 of file thermoSingleLayer.C.

Referenced by thermoSingleLayer::evolveRegion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ q()

tmp< fvScalarMatrix > q ( volScalarField & h ) const

protectedvirtual

Return the wall/surface heat transfer term for the enthalpy equation.

Definition at line 226 of file thermoSingleLayer.C.

References kinematicSingleLayer::coverage(), basicThermo::Cpv(), kinematicSingleLayer::delta_, kinematicSingleLayer::deltaSmall_, Foam::constant::universal::h, thermoSingleLayer::htcs_, thermoSingleLayer::htcw_, Foam::pos(), Foam::fvm::Sp(), Foam::T(), basicThermo::T(), kinematicSingleLayer::thermo(), thermoSingleLayer::TPrimary_, thermoSingleLayer::Tw(), and singleLayerRegion::VbyA().

Referenced by thermoSingleLayer::solveEnergy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ solveEnergy()

void solveEnergy ( )

protectedvirtual

Solve energy equation.

Definition at line 248 of file thermoSingleLayer.C.

References kinematicSingleLayer::alpha_, kinematicSingleLayer::continuityErr_, thermoSingleLayer::correctHforMappedT(), Foam::fvm::ddt(), DebugInFunction, Foam::fvm::div(), Foam::endl(), he(), thermoSingleLayer::hSp_, kinematicSingleLayer::phi_, thermoSingleLayer::q(), thermoSingleLayer::radiation_, fvMatrix< Type >::relax(), kinematicSingleLayer::rho(), Foam::fvm::Sp(), kinematicSingleLayer::thermo_, thermoSingleLayer::thermoSingleLayer(), and singleLayerRegion::VbyA().

Referenced by thermoSingleLayer::evolveRegion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "thermoSingleLayer" )

Runtime type information.

◆ primaryThermo()

const fluidThermo & primaryThermo ( ) const

inline

Return const reference to the primary region thermo object.

Definition at line 42 of file thermoSingleLayerI.H.

References thermoSingleLayer::primaryThermo_.

Referenced by standardPhaseChange::correctModel(), waxSolventEvaporation::correctModel(), speciePhaseChange::vapId(), and speciePhaseChange::Wvap().

Here is the caller graph for this function:

◆ Ts()

tmp< volScalarField::Internal > Ts ( ) const

virtual

Return the film surface temperature [K].

Currently this is assumed to be equal to the film mean temperature

Definition at line 534 of file thermoSingleLayer.C.

References basicThermo::T(), and kinematicSingleLayer::thermo().

Here is the call graph for this function:

◆ Tw()

tmp< volScalarField::Internal > Tw ( ) const

virtual

Return the film wall temperature [K].

Definition at line 540 of file thermoSingleLayer.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), polyMesh::boundaryMesh(), Foam::dimTemperature, polyPatch::faceCells(), regionModel::intCoupledPatchIDs_, DimensionedField< Type, GeoMesh >::New(), patchi, tmp< T >::ref(), regionModel::regionMesh(), List< T >::size(), Foam::T(), basicThermo::T(), and kinematicSingleLayer::thermo().

Referenced by thermoSingleLayer::q().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addSources()

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

virtual

External hook to add sources to the film.

Reimplemented from kinematicSingleLayer.

Definition at line 456 of file thermoSingleLayer.C.

References kinematicSingleLayer::addSources(), GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), DebugInFunction, Foam::endl(), thermoSingleLayer::hSpPrimary_, and patchi.

Referenced by thermoSingleLayer::~thermoSingleLayer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hSp()

const volScalarField::Internal & hSp ( ) const

inline

Energy [J/m2/s].

Definition at line 48 of file thermoSingleLayerI.H.

References thermoSingleLayer::hSp_.

◆ hSpPrimary()

const volScalarField & hSpPrimary ( ) const

inline

Energy [J/m2/s].

Definition at line 54 of file thermoSingleLayerI.H.

References thermoSingleLayer::hSpPrimary_.

◆ TPrimary()

const volScalarField & TPrimary ( ) const

inline

Temperature [K].

Definition at line 60 of file thermoSingleLayerI.H.

References thermoSingleLayer::TPrimary_.

◆ YPrimary()

const PtrList< volScalarField > & YPrimary ( ) const

inline

Specie mass fractions [0-1].

Definition at line 66 of file thermoSingleLayerI.H.

References thermoSingleLayer::YPrimary_.

Referenced by standardPhaseChange::correctModel(), and waxSolventEvaporation::correctModel().

Here is the caller graph for this function:

◆ htcs()

const heatTransferModel & htcs ( ) const

inline

Return const access to the (surface) heat transfer model.

Definition at line 72 of file thermoSingleLayerI.H.

References thermoSingleLayer::htcs_.

◆ htcw()

const heatTransferModel & htcw ( ) const

inline

Return const access to the (wall) heat transfer model.

Definition at line 78 of file thermoSingleLayerI.H.

References thermoSingleLayer::htcw_.

◆ phaseChange()

const phaseChangeModel & phaseChange ( ) const

inline

Return const access to the phase change model.

Definition at line 84 of file thermoSingleLayerI.H.

References thermoSingleLayer::phaseChange_.

◆ radiation()

const radiationModel & radiation ( ) const

inline

Return const access to the radiation model.

Definition at line 90 of file thermoSingleLayerI.H.

References thermoSingleLayer::radiation_.

◆ preEvolveRegion()

void preEvolveRegion ( )

virtual

Pre-evolve film hook.

Reimplemented from kinematicSingleLayer.

Definition at line 481 of file thermoSingleLayer.C.

References DebugInFunction, Foam::dimEnergy, Foam::endl(), kinematicSingleLayer::preEvolveRegion(), and thermoSingleLayer::primaryEnergyTrans_.

Here is the call graph for this function:

◆ evolveRegion()

void evolveRegion ( )

virtual

Evolve the film equations.

Reimplemented from kinematicSingleLayer.

Definition at line 490 of file thermoSingleLayer.C.

References pisoControl::correct(), thermoSingleLayer::correctCoverage(), thermoSingleLayer::correctHforMappedT(), DebugInFunction, Foam::endl(), pimpleControl::loop(), kinematicSingleLayer::pc(), kinematicSingleLayer::pe(), kinematicSingleLayer::pimple_, kinematicSingleLayer::predictDelta(), thermoSingleLayer::resetPrimaryRegionSourceTerms(), kinematicSingleLayer::solveAlpha(), thermoSingleLayer::solveEnergy(), kinematicSingleLayer::solveMomentum(), UEqn, and thermoSingleLayer::updateSubmodels().

Here is the call graph for this function:

◆ SYi()

tmp< volScalarField::Internal > SYi ( const label i ) const

virtual

Return mass source for specie i - Eulerian phase only.

Reimplemented from kinematicSingleLayer.

Definition at line 585 of file thermoSingleLayer.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), polyMesh::boundaryMesh(), cells, TimeState::deltaTValue(), Foam::dimMass, Foam::dimTime, Foam::dimVolume, forAll, regionModel::intCoupledPatchIDs_, IOobject::modelName(), Foam::name(), DimensionedField< Type, GeoMesh >::New(), kinematicSingleLayer::primaryMassTrans_, regionModel::primaryMesh(), regionModel::primaryPatchIDs(), thermoSingleLayer::primaryThermo_, tmp< T >::ref(), basicSpecieMixture::species(), kinematicSingleLayer::thermo(), regionModel::time(), regionModel::toPrimary(), and fvMesh::V().

Referenced by thermoSingleLayer::info().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Sh()

tmp< volScalarField::Internal > Sh ( ) const

virtual

Return enthalpy source - Eulerian phase only.

Reimplemented from kinematicSingleLayer.

Definition at line 639 of file thermoSingleLayer.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), polyMesh::boundaryMesh(), cells, TimeState::deltaTValue(), Foam::dimEnergy, Foam::dimTime, Foam::dimVolume, forAll, regionModel::intCoupledPatchIDs_, IOobject::modelName(), DimensionedField< Type, GeoMesh >::New(), thermoSingleLayer::primaryEnergyTrans_, regionModel::primaryMesh(), regionModel::primaryPatchIDs(), tmp< T >::ref(), regionModel::time_, regionModel::toPrimary(), and fvMesh::V().

Here is the call graph for this function:

◆ info()

void info ( )

virtual

Provide some feedback.

Reimplemented from kinematicSingleLayer.

Definition at line 569 of file thermoSingleLayer.C.

References Foam::gAverage(), Foam::gMax(), Foam::gMin(), Foam::indent(), Foam::Info, kinematicSingleLayer::info(), Foam::nl, thermoSingleLayer::phaseChange_, thermoSingleLayer::SYi(), basicThermo::T(), and kinematicSingleLayer::thermo().

Here is the call graph for this function:

◆ operator=()

void operator= ( const thermoSingleLayer & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ phaseName_

const word phaseName_

protected

Definition at line 77 of file thermoSingleLayer.H.

◆ primaryThermo_

const fluidThermo& primaryThermo_

protected

Reference to the primary region thermo.

Definition at line 82 of file thermoSingleLayer.H.

Referenced by thermoSingleLayer::primaryThermo(), thermoSingleLayer::SYi(), and thermoSingleLayer::thermoSingleLayer().

◆ primaryEnergyTrans_

volScalarField primaryEnergyTrans_

protected

Film energy transfer.

Definition at line 87 of file thermoSingleLayer.H.

Referenced by thermoSingleLayer::preEvolveRegion(), thermoSingleLayer::Sh(), and thermoSingleLayer::updateSubmodels().

◆ deltaWet_

scalar deltaWet_

protected

Threshold film thickness beyond which the film is considered 'wet'.

Definition at line 91 of file thermoSingleLayer.H.

Referenced by thermoSingleLayer::correctCoverage().

◆ hydrophilic_

bool hydrophilic_

protected

Activation flag.

Definition at line 97 of file thermoSingleLayer.H.

Referenced by thermoSingleLayer::correctCoverage(), and thermoSingleLayer::thermoSingleLayer().

◆ hydrophilicDryScale_

scalar hydrophilicDryScale_

protected

Length scale applied to deltaWet_ to determine when a wet.

surface becomes dry, typically 0.5

Definition at line 101 of file thermoSingleLayer.H.

Referenced by thermoSingleLayer::correctCoverage(), and thermoSingleLayer::thermoSingleLayer().

◆ hydrophilicWetScale_

scalar hydrophilicWetScale_

protected

Length scale applied to deltaWet_ to determine when a dry.

surface becomes wet, typically 0.001

Definition at line 105 of file thermoSingleLayer.H.

Referenced by thermoSingleLayer::correctCoverage(), and thermoSingleLayer::thermoSingleLayer().

◆ hSp_

volScalarField::Internal hSp_

protected

Energy [J/m2/s].

Definition at line 115 of file thermoSingleLayer.H.

Referenced by thermoSingleLayer::hSp(), thermoSingleLayer::resetPrimaryRegionSourceTerms(), thermoSingleLayer::solveEnergy(), thermoSingleLayer::transferPrimaryRegionSourceFields(), and thermoSingleLayer::updateSubmodels().

◆ hSpPrimary_

volScalarField hSpPrimary_

protected

Energy [J/m2/s].

Definition at line 122 of file thermoSingleLayer.H.

Referenced by thermoSingleLayer::addSources(), thermoSingleLayer::hSpPrimary(), thermoSingleLayer::resetPrimaryRegionSourceTerms(), and thermoSingleLayer::transferPrimaryRegionSourceFields().

◆ TPrimary_

volScalarField TPrimary_

protected

Temperature [K].

Definition at line 129 of file thermoSingleLayer.H.

Referenced by thermoSingleLayer::q(), thermoSingleLayer::TPrimary(), and thermoSingleLayer::transferPrimaryRegionThermoFields().

◆ YPrimary_

PtrList<volScalarField> YPrimary_

protected

List of specie mass fractions [0-1].

Definition at line 132 of file thermoSingleLayer.H.

Referenced by thermoSingleLayer::thermoSingleLayer(), thermoSingleLayer::transferPrimaryRegionThermoFields(), and thermoSingleLayer::YPrimary().

◆ htcs_

autoPtr<heatTransferModel> htcs_

protected

Heat transfer coefficient between film surface and primary.

region [W/m^2/K]

Definition at line 139 of file thermoSingleLayer.H.

Referenced by thermoSingleLayer::htcs(), thermoSingleLayer::q(), and thermoSingleLayer::updateSubmodels().

◆ htcw_

autoPtr<heatTransferModel> htcw_

protected

Heat transfer coefficient between wall and film [W/m^2/K].

Definition at line 142 of file thermoSingleLayer.H.

Referenced by thermoSingleLayer::htcw(), thermoSingleLayer::q(), and thermoSingleLayer::updateSubmodels().

◆ phaseChange_

autoPtr<phaseChangeModel> phaseChange_

protected

Phase change.

Definition at line 145 of file thermoSingleLayer.H.

Referenced by thermoSingleLayer::info(), thermoSingleLayer::phaseChange(), and thermoSingleLayer::updateSubmodels().

◆ radiation_

autoPtr<radiationModel> radiation_

protected

Radiation.

Definition at line 148 of file thermoSingleLayer.H.

Referenced by thermoSingleLayer::radiation(), thermoSingleLayer::solveEnergy(), and thermoSingleLayer::updateSubmodels().

◆ Tmin_

scalar Tmin_

protected

Minimum temperature limit (optional)

Definition at line 154 of file thermoSingleLayer.H.

Referenced by thermoSingleLayer::thermoSingleLayer().

◆ Tmax_

scalar Tmax_

protected

Maximum temperature limit (optional)

Definition at line 157 of file thermoSingleLayer.H.

Referenced by thermoSingleLayer::thermoSingleLayer().

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

src/regionModels/surfaceFilmModels/thermoSingleLayer/thermoSingleLayer.H
src/regionModels/surfaceFilmModels/thermoSingleLayer/thermoSingleLayer.C
src/regionModels/surfaceFilmModels/thermoSingleLayer/thermoSingleLayerI.H

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ thermoSingleLayer() [1/2]

◆ thermoSingleLayer() [2/2]

◆ ~thermoSingleLayer()

Member Function Documentation

◆ read()

◆ correctHforMappedT()

◆ resetPrimaryRegionSourceTerms()

◆ transferPrimaryRegionThermoFields()

◆ transferPrimaryRegionSourceFields()

◆ correctCoverage()

◆ updateSubmodels()

◆ q()

◆ solveEnergy()

◆ TypeName()

◆ primaryThermo()

◆ Ts()

◆ Tw()

◆ addSources()

◆ hSp()

◆ hSpPrimary()

◆ TPrimary()

◆ YPrimary()

◆ htcs()

◆ htcw()

◆ phaseChange()

◆ radiation()

◆ preEvolveRegion()

◆ evolveRegion()

◆ SYi()

◆ Sh()

◆ info()

◆ operator=()

Member Data Documentation

◆ phaseName_

◆ primaryThermo_

◆ primaryEnergyTrans_

◆ deltaWet_

◆ hydrophilic_

◆ hydrophilicDryScale_

◆ hydrophilicWetScale_

◆ hSp_

◆ hSpPrimary_

◆ TPrimary_

◆ YPrimary_

◆ htcs_

◆ htcw_

◆ phaseChange_

◆ radiation_

◆ Tmin_

◆ Tmax_