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

Inheritance diagram for kinematicSingleLayer:

Collaboration diagram for kinematicSingleLayer:

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

virtual	~kinematicSingleLayer ()
	Destructor. More...

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

Switch	momentumPredictor () const
	Return the momentum predictor. More...

label	nOuterCorr () const
	Return the number of outer correctors. More...

label	nCorr () const
	Return the number of PISO correctors. More...

label	nNonOrthCorr () const
	Return the number of non-orthogonal correctors. More...

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

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

const volScalarField &	sigma () const
	Return const access to the surface tension [kg/s2]. More...

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

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

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

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

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

virtual const volScalarField &	deltaRho () const
	Return the film thickness*density (helper field) [kg/m3]. More...

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

virtual const volScalarField &	rho () const
	Return the film density [kg/m3]. More...

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

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

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

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

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

virtual const volScalarField &	kappa () const
	Return the film thermal conductivity [W/m/K]. 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 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...

volVectorField &	USpPrimary ()
	Momentum [kg/m/s2]. More...

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

volScalarField &	rhoSpPrimary ()
	Mass [kg/m2/s]. More...

volVectorField &	USp ()
	Momentum [kg/m/s2]. More...

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

volScalarField &	rhoSp ()
	Mass [kg/m2/s]. More...

const volVectorField &	USp () const
	Momentum [kg/m/s2]. More...

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

const volScalarField &	rhoSp () const
	Mass [kg/m2/s]. More...

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

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

const volScalarField &	rhoPrimary () const
	Density [kg/m3]. More...

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

const filmThermoModel &	filmThermo () const
	Film thermo. More...

injectionModelList &	injection ()
	Injection. More...

transferModelList &	transfer ()
	Transfer. More...

const filmTurbulenceModel &	turbulence () const
	Turbulence. More...

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

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

tmp< volScalarField >	gNorm () const
	Return the gravity normal-to-patch component contribution. More...

tmp< volScalarField >	gNormClipped () const
	Return the gravity normal-to-patch component contribution. More...

tmp< volVectorField >	gTan () const
	Return the gravity tangential component contributions. More...

tmp< vectorField >	gTan (const label patchI) const
	Return the gravity tangential component contributions for patchI. More...

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

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

virtual void	postEvolveRegion ()
	Post-evolve film hook. More...

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

virtual tmp< volScalarField::Internal >	Srho (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...

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

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

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 ()
	Constructor. More...

virtual	~surfaceFilmModel ()
	Destructor. 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...

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 / [m2]. 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...

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 ()=default
	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...

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

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

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 &io, const dictionary *fallback=nullptr)

	IOdictionary (const IOobject &io, const dictionary &dict)

	IOdictionary (const IOobject &io, const word &wantedType, const dictionary *fallback=nullptr)

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

virtual	~IOdictionary ()=default
	Destructor. More...

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

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

Public Member Functions inherited from baseIOdictionary
	TypeName ("dictionary")
	Declare type-name, virtual type (with debug switch) More...

	baseIOdictionary (const baseIOdictionary &)=default
	Copy construct. More...

	baseIOdictionary (baseIOdictionary &&)=default
	Move construct. More...

virtual	~baseIOdictionary ()=default
	Destructor. More...

	baseIOdictionary (const IOobject &io, const dictionary *fallback=nullptr)

	baseIOdictionary (const IOobject &io, const dictionary &dict)

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

const word &	name () const

virtual bool	readData (Istream &)
	The readData function required by regIOobject read operation. More...

virtual bool	writeData (Ostream &) const
	The writeData function required by regIOobject write operation. More...

void	operator= (const baseIOdictionary &rhs)
	Copy assignment of dictionary entries (leave regIOobject untouched) More...

void	operator= (const dictionary &rhs)
	Copy assignment of dictionary entries. More...

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

	regIOobject (const IOobject &io, const bool isTimeObject=false)

	regIOobject (const regIOobject &rio)
	Copy construct. More...

	regIOobject (const regIOobject &rio, bool registerCopy)

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)

	regIOobject (const IOobject &io, const regIOobject &rio)
	Copy construct with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

bool	checkIn ()
	Add object to registry, if not already registered. More...

bool	checkOut ()
	Remove all file watches and 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...

bool	store ()

void	release (const bool unregister=false)
	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 as up-to-date. More...

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

const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data or nullptr. More...

dictionary &	getMetaData () noexcept
	Get or create meta-data. More...

void	removeMetaData ()
	Remove meta-data. More...

virtual void	updateMetaData ()
	Update internal meta-data (eg, prior to writing) More...

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

Istream &	readStream (const word &, const bool valid=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. More...

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

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

virtual bool	modified () const

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

virtual bool	writeObject (IOstreamOption streamOpt, const bool valid) const
	Write using stream options. More...

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

void	operator= (const IOobject &io)
	Copy assignment. More...

virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const
	Write using given format, version and compression. More...

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Declare type-name, virtual type (with debug switch) More...

	IOobject (const IOobject &)=default
	Copy construct. More...

virtual	~IOobject ()=default
	Destructor. More...

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
	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, bool globalObject=false)
	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, bool globalObject=false)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const objectRegistry &registry)
	Copy construct, resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Copy construct, resetting name. More...

	IOobject (const IOobject &io, readOption, writeOption)
	Copy construct, resetting io options. More...

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

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

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

const Time &	time () const
	Return Time associated with the objectRegistry. More...

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

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

word &	headerClassName () noexcept
	Return non-constant access to the class name read from header. More...

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

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

bool	registerObject () const noexcept
	Should object created with this IOobject be registered? More...

bool	registerObject (bool on) noexcept
	Change registration preference, return previous value. More...

bool	globalObject () const noexcept
	Is object same for all processors? More...

bool	globalObject (bool on) noexcept
	Change global-object status, return previous value. More...

unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes, possibly read from the header. More...

unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes, possibly read from the header. More...

bool	isHeaderClassName (const word &clsName) const
	Test if headerClassName() equals the given class name. More...

template<class Type >
bool	isHeaderClassName () const
	Test if headerClassName() equals Type::typeName. More...

readOption	readOpt () const noexcept
	The read option. More...

readOption	readOpt (readOption opt) noexcept
	Change the read option, return previous value. More...

writeOption	writeOpt () const noexcept
	The write option. More...

writeOption	writeOpt (writeOption opt) noexcept
	Change the write option, return previous value. More...

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 noexcept

fileName &	instance () noexcept

const fileName &	local () const noexcept

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

fileName	path (const word &instance, const fileName &local=fileName::null) const
	The complete path with alternative instance and local. More...

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

fileName	objectRelPath () const
	The object path relative to the root. More...

fileName	localFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches locally. More...

fileName	globalFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches up if in parallel. More...

IOstreamOption	parseHeader (const dictionary &headerDict)

bool	readHeader (Istream &is)

bool	readHeader (dictionary &headerDict, Istream &is)

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

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

bool	writeHeader (Ostream &os) const
	Write header with current type() More...

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

void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const

void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const

bool	good () const noexcept

bool	bad () const noexcept

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

void	operator= (const IOobject &io)

readOption &	readOpt () noexcept
	Access to the read option. More...

writeOption &	writeOpt () noexcept
	Access to the write option. More...

bool &	registerObject () noexcept
	Access to the register object option. More...

bool &	globalObject () noexcept
	Access to the global object option. More...

template<>
bool	isHeaderClassName () const
	Specialization for `void` always returns true (no headerClassName check). More...

template<class StringType >
Foam::word	groupName (StringType base, const word &group)

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

	dictionary ()
	Default construct, a top-level empty dictionary. More...

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

	dictionary (const fileName &name, const dictionary &parentDict, Istream &is, bool keepHeader=false)

	dictionary (Istream &is)

	dictionary (Istream &is, bool keepHeader)

	dictionary (const dictionary &parentDict, const dictionary &dict)
	Copy construct given the parent dictionary. More...

	dictionary (const dictionary &dict)
	Copy construct top-level dictionary. More...

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

	dictionary (const dictionary &parentDict, dictionary &&dict)
	Move construct for given parent dictionary. More...

	dictionary (dictionary &&dict)
	Move construct top-level dictionary. More...

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

virtual	~dictionary ()
	Destructor. More...

const fileName &	name () const noexcept
	The dictionary name. More...

fileName &	name () noexcept
	The dictionary name for modification (use with caution). More...

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

fileName	relativeName (const bool caseTag=false) const
	The dictionary name relative to the case. More...

bool	isNullDict () const noexcept
	The dictionary is actually dictionary::null (root dictionary) More...

const dictionary &	parent () const noexcept
	Return the parent dictionary. 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 &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Search for an entry (const access) with the given keyword. More...

entry *	findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find for an entry (non-const access) with the given keyword. More...

const entry *	findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find an entry (const access) with the given keyword. More...

const entry *	findScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Search for a scoped entry (const access) with the given keyword. More...

dictionary *	findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find and return a sub-dictionary pointer if present. More...

const dictionary *	findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a sub-dictionary pointer if present. More...

const entry &	lookupEntry (const word &keyword, enum keyType::option matchOpt) const
	Search for an entry (const access) with the given keyword. More...

ITstream &	lookup (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const

template<class T >
T	get (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const

template<class T >
T	getOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const

template<class T >
T	getOrAdd (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)

template<class T >
bool	readEntry (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const

template<class T >
bool	readIfPresent (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX) const

template<class T , class Predicate >
T	getCheck (const word &keyword, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const

template<class T , class Predicate >
T	getCheckOrDefault (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const

template<class T , class Predicate >
T	getCheckOrAdd (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX)

template<class T , class Predicate >
bool	readCheck (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const

template<class T , class Predicate >
bool	readCheckIfPresent (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const

bool	isDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Check if entry is found and is a sub-dictionary. More...

const dictionary &	subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a sub-dictionary. More...

dictionary &	subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find and return a sub-dictionary for manipulation. More...

dictionary &	subDictOrAdd (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find and return a sub-dictionary for manipulation. More...

dictionary	subOrEmptyDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX, const bool mandatory=false) const

const dictionary &	optionalSubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a sub-dictionary, otherwise return this dictionary. More...

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

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

template<class Compare >
wordList	sortedToc (const Compare &comp) const
	Return table of contents sorted using the specified comparator. More...

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

bool	substituteKeyword (const word &keyword, bool mergeEntry=false)
	Substitute the given keyword (which is prefixed by '$') More...

bool	substituteScopedKeyword (const word &keyword, bool mergeEntry=false)
	Substitute the given scoped keyword (which is prefixed by '$') More...

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

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

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

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

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

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

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

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

entry *	set (entry *entryPtr)
	Assign a new entry, overwriting any existing entry. More...

entry *	set (const entry &e)
	Assign a new entry, overwriting any existing entry. More...

entry *	set (const keyType &k, const dictionary &v)
	Assign a dictionary entry, overwriting any existing entry. More...

template<class T >
entry *	set (const keyType &k, const T &v)
	Assign a T entry, overwriting any existing entry. More...

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

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

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

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

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

void	checkITstream (const ITstream &is, const word &keyword) const

bool	read (Istream &is)
	Read dictionary from Istream. Discards the header. More...

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

void	writeEntry (Ostream &os) const
	Write sub-dictionary with its dictName as its header. More...

void	writeEntry (const keyType &keyword, Ostream &os) const
	Write sub-dictionary with the keyword as its header. More...

void	writeEntries (Ostream &os, const bool extraNewLine=false) const
	Write dictionary entries. More...

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

const_searcher	csearch (const word &keyword, enum keyType::option=keyType::REGEX) const
	Search dictionary for given keyword. More...

const_searcher	search (const word &keyword, enum keyType::option=keyType::REGEX) const
	Search dictionary for given keyword. More...

searcher	search (const word &keyword, enum keyType::option=keyType::REGEX)
	Search dictionary for given keyword. More...

const_searcher	csearchScoped (const word &keyword, enum keyType::option) const
	Search using scoping. More...

const_searcher	searchScoped (const word &keyword, enum keyType::option) const
	Search using dot or slash scoping. More...

searcher	searchScoped (const word &keyword, enum keyType::option)
	Search using dot or slash scoping. More...

const dictionary *	cfindScopedDict (const fileName &dictPath) const
	Locate a sub-dictionary using slash-scoping. More...

const dictionary *	findScopedDict (const fileName &dictPath) const
	Locate a sub-dictionary using slash-scoping. More...

dictionary *	findScopedDict (const fileName &dictPath)
	Locate a sub-dictionary using slash-scoping. More...

dictionary *	makeScopedDict (const fileName &dictPath)
	Locate existing or create sub-dictionary using slash-scoping. More...

const_searcher	csearchCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
	Search dictionary for given keyword and any compatibility names. More...

bool	foundCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
	Search dictionary for given keyword and any compatibility names. More...

const entry *	findCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const

const entry &	lookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const

ITstream &	lookupCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const

template<class T >
T	getCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const

template<class T >
T	getOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option=keyType::REGEX) const

template<class T >
bool	readCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX, bool mandatory=true) const

template<class T >
bool	readIfPresentCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX) const

void	operator= (const dictionary &rhs)
	Copy assignment. More...

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

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

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

template<class T >
T	lookupOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const

template<class T >
T	lookupOrAddDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)

template<class T >
T	lookupOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const

ITstream &	operator[] (const word &keyword) const
	Deprecated(2018-07) find and return an entry data stream. More...

bool	found (const word &keyword, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10) More...

entry *	lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch)
	Deprecated(2018-10) More...

const entry *	lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
	Deprecated(2018-10) More...

const entry *	lookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
	Deprecated(2018-10) More...

const dictionary *	subDictPtr (const word &keyword) const
	Deprecated(2018-10) More...

dictionary *	subDictPtr (const word &keyword)

const entry &	lookupEntry (const word &keyword, bool recursive, bool patternMatch) const
	Deprecated(2018-10) More...

ITstream &	lookup (const word &keyword, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10) More...

template<class T >
T	lookupOrDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10) More...

template<class T >
T	lookupOrAddDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true)
	Deprecated(2018-10) More...

template<class T >
bool	readIfPresent (const word &keyword, T &val, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10) More...

template<class T >
T	lookupType (const word &keyword, bool recursive=false, bool patternMatch=true) const
	Deprecated(2018-10) find and return a T. More...

bool	getBool (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< bool >(const word&, keyType::option) More...

label	getLabel (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< label >(const word&, keyType::option) More...

scalar	getScalar (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< scalar >(const word&, keyType::option) More...

string	getString (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< string >(const word&, keyType::option) More...

word	getWord (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< word >(const word&, keyType::option) More...

fileName	getFileName (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< fileName >(const word&, keyType::option) More...

template<class Compare >
Foam::wordList	sortedToc (const Compare &comp) const

template<class T >
Foam::entry *	add (const keyType &k, const T &v, bool overwrite)

template<class T >
Foam::entry *	set (const keyType &k, const T &v)

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

	ILList (T *item)
	Construct and insert the initial T item pointer. More...

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

	ILList (const ILList< LListBase, T > &lst)
	Copy construct using the 'clone()' method for each element. More...

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

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

template<class INew >
	ILList (Istream &is, const INew &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 *item)
	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 > &lst)

void	operator= (const ILList< LListBase, T > &lst)
	Copy assignment using the 'clone()' method for each element. More...

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

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

virtual void	correctThermoFields ()
	Correct the thermo 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 tmp< volScalarField >	pu ()
	Explicit pressure source contribution. More...

virtual tmp< volScalarField >	pp ()
	Implicit pressure source coefficient. More...

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

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

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

virtual void	updateSurfaceVelocities ()
	Update film surface velocities. More...

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

virtual void	solveContinuity ()
	Solve continuity equation. More...

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

virtual void	solveThickness (const volScalarField &pu, const volScalarField &pp, fvVectorMatrix &UEqn)
	Solve coupled velocity-thickness equations. More...

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

virtual const AMIPatchToPatchInterpolation &	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 IOstreamOption::streamFormat fmt, const word &typeName)
	Helper: check readOpt flags and read if necessary. More...

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

Protected Attributes
Switch	momentumPredictor_
	Momentum predictor. More...

label	nOuterCorr_
	Number of outer correctors. More...

label	nCorr_
	Number of PISO-like correctors. More...

label	nNonOrthCorr_
	Number of non-orthogonal correctors. More...

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	rho_
	Density [kg/m3]. More...

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

volScalarField	sigma_
	Surface tension [m/s2]. More...

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

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

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

volVectorField	Us_
	Velocity - surface [m/s]. More...

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

volScalarField	deltaRho_
	Film thickness*density (helper field) [kg/m2]. More...

surfaceScalarField	phi_
	Mass flux (includes film thickness) [kg.m/s]. 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	USp_
	Momentum [kg/m/s2]. More...

volScalarField	pSp_
	Pressure [Pa]. More...

volScalarField	rhoSp_
	Mass [kg/m2/s]. More...

volVectorField	USpPrimary_
	Momentum [kg/m/s2]. More...

volScalarField	pSpPrimary_
	Pressure [Pa]. More...

volScalarField	rhoSpPrimary_
	Mass [kg/m2/s]. More...

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

volScalarField	pPrimary_
	Pressure [Pa]. More...

volScalarField	rhoPrimary_
	Density [kg/m3]. More...

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

autoPtr< filmThermoModel >	filmThermo_
	Film thermo model. More...

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

injectionModelList	injection_
	Cloud injection. More...

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

autoPtr< filmTurbulenceModel >	turbulence_
	Turbulence model. More...

forceList	forces_
	List of film forces. More...

scalar	addedMassTotal_
	Cumulative mass added via sources [kg]. More...

Protected Attributes inherited from surfaceFilmRegionModel
const dimensionedVector &	g_
	Acceleration due to gravity [m/s2]. More...

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

autoPtr< volScalarField >	magSfPtr_
	Face area magnitudes / [m2]. 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...

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< AMIPatchToPatchInterpolation > >	interRegionAMI_
	List of AMI objects per coupled region. More...

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

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

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

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

Public Types inherited from dictionary
typedef Searcher< true >	const_searcher
	Searcher with const access. More...

typedef Searcher< false >	searcher
	Searcher with non-const access. More...

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 *p)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (refPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (refPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (tmp< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (tmp< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept
	Status of output file banner. More...

static bool	bannerEnabled (bool on) noexcept
	Enable/disable an output file banner. More...

static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class StringType >
static word	groupName (StringType base, const word &group)
	Create dot-delimited name.group string. More...

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

static word	scopedName (const std::string &scope, const word &name)
	Create scope:name or scope_name string. More...

static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
	Return the IOobject, but also consider an alternative file name. More...

static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

static Ostream &	writeDivider (Ostream &os)
	Write the standard file section divider. More...

static Ostream &	writeEndDivider (Ostream &os)
	Write the standard end file divider. More...

Static Public Member Functions inherited from dictionary
static int	reportOptional () noexcept
	Return the state of reporting optional (default) entries. More...

static int	reportOptional (const int level) noexcept
	Change the state of reporting optional (default) entries. More...

static autoPtr< dictionary >	New (Istream &is)
	Construct top-level dictionary on freestore from Istream. More...

Public Attributes inherited from dictionary
friend	const_searcher
	Declare friendship with the searcher classes. More...

friend	searcher

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

Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames
	Names for the fileCheckTypes. More...

static char	scopeSeparator
	Character for scoping object names (':' or '_') More...

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

static float	fileModificationSkew
	Time skew (seconds) for file modification checks. More...

static int	maxFileModificationPolls
	Max number of times to poll for file modification changes. More...

Static Public Attributes inherited from dictionary
static int	writeOptionalEntries
	Report optional keywords and values if not present in dictionary. More...

static const dictionary	null
	An empty dictionary, which is also the parent for all dictionaries. More...

static refPtr< OSstream >	reportingOutput
	Output location when reporting default values. More...

Static Protected Member Functions inherited from IOobject
static void	writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)

static void	writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)

Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects. More...

Detailed Description

Kinematic form of single-cell layer surface film model.

Source files

Definition at line 67 of file kinematicSingleLayer.H.

Constructor & Destructor Documentation

◆ kinematicSingleLayer()

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

Construct from components.

Definition at line 436 of file kinematicSingleLayer.C.

References IOobject::AUTO_WRITE, Foam::fvc::flux(), Foam::constant::electromagnetic::phi0, IOobject::READ_IF_PRESENT, Foam::readFields(), and timeName.

Here is the call graph for this function:

◆ ~kinematicSingleLayer()

~kinematicSingleLayer ( )

virtual

Destructor.

Definition at line 823 of file kinematicSingleLayer.C.

Member Function Documentation

◆ read()

bool read ( )

protectedvirtual

Read control parameters from dictionary.

Reimplemented from surfaceFilmRegionModel.

Reimplemented in thermoSingleLayer.

Definition at line 59 of file kinematicSingleLayer.C.

References kinematicSingleLayer::momentumPredictor_, kinematicSingleLayer::nCorr_, kinematicSingleLayer::nNonOrthCorr_, kinematicSingleLayer::nOuterCorr_, surfaceFilmRegionModel::read(), dictionary::readEntry(), dictionary::readIfPresent(), regionModel::solution(), and dictionary::subDict().

Referenced by thermoSingleLayer::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ correctThermoFields()

void correctThermoFields ( )

protectedvirtual

Correct the thermo fields.

Reimplemented in thermoSingleLayer.

Definition at line 76 of file kinematicSingleLayer.C.

References kinematicSingleLayer::filmThermo_, kinematicSingleLayer::mu_, kinematicSingleLayer::rho_, and kinematicSingleLayer::sigma_.

Referenced by kinematicSingleLayer::preEvolveRegion().

Here is the caller graph for this function:

◆ resetPrimaryRegionSourceTerms()

void resetPrimaryRegionSourceTerms ( )

protectedvirtual

Reset source term fields.

Reimplemented in thermoSingleLayer.

Definition at line 84 of file kinematicSingleLayer.C.

References DebugInFunction, Foam::endl(), kinematicSingleLayer::pSp_, kinematicSingleLayer::pSpPrimary_, kinematicSingleLayer::rhoSp_, kinematicSingleLayer::rhoSpPrimary_, kinematicSingleLayer::USp_, kinematicSingleLayer::USpPrimary_, and Foam::Zero.

Referenced by kinematicSingleLayer::postEvolveRegion(), and thermoSingleLayer::resetPrimaryRegionSourceTerms().

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

Definition at line 94 of file kinematicSingleLayer.C.

References GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), DebugInFunction, Foam::endl(), kinematicSingleLayer::muPrimary_, kinematicSingleLayer::pPrimary_, kinematicSingleLayer::rhoPrimary_, and kinematicSingleLayer::UPrimary_.

Referenced by kinematicSingleLayer::preEvolveRegion(), and thermoSingleLayer::transferPrimaryRegionThermoFields().

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

Definition at line 107 of file kinematicSingleLayer.C.

References dictionary::add(), kinematicSingleLayer::addedMassTotal_, GeometricField< Type, PatchField, GeoMesh >::boundaryField(), GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), Foam::expressions::patchExpr::debug, DebugInFunction, TimeState::deltaTValue(), Foam::endl(), forAll, singleLayerRegion::magSf(), regionModel::outputProperties(), regionModel::primaryMesh(), kinematicSingleLayer::pSp_, kinematicSingleLayer::pSpPrimary_, dictionary::readIfPresent(), Foam::returnReduce(), kinematicSingleLayer::rhoSp_, kinematicSingleLayer::rhoSpPrimary_, regionModel::time(), regionModel::time_, kinematicSingleLayer::USp_, and kinematicSingleLayer::USpPrimary_.

Referenced by kinematicSingleLayer::preEvolveRegion(), and thermoSingleLayer::transferPrimaryRegionSourceFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pu()

tmp< volScalarField > pu ( )

protectedvirtual

Explicit pressure source contribution.

Definition at line 162 of file kinematicSingleLayer.C.

References kinematicSingleLayer::delta_, Foam::fvc::laplacian(), IOobject::NO_READ, IOobject::NO_WRITE, kinematicSingleLayer::pPrimary_, kinematicSingleLayer::pSp_, regionModel::regionMesh(), kinematicSingleLayer::sigma_, regionModel::time_, and Time::timeName().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pp()

tmp< volScalarField > pp ( )

protectedvirtual

Implicit pressure source coefficient.

Definition at line 184 of file kinematicSingleLayer.C.

References kinematicSingleLayer::gNormClipped(), IOobject::NO_READ, IOobject::NO_WRITE, regionModel::regionMesh(), kinematicSingleLayer::rho_, regionModel::time_, and Time::timeName().

Referenced by thermoSingleLayer::evolveRegion(), kinematicSingleLayer::evolveRegion(), thermoSingleLayer::updateSurfaceTemperatures(), and kinematicSingleLayer::updateSurfaceVelocities().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ correctAlpha()

void correctAlpha ( )

protectedvirtual

Correct film coverage field.

Reimplemented in thermoSingleLayer.

Definition at line 204 of file kinematicSingleLayer.C.

References kinematicSingleLayer::alpha_, kinematicSingleLayer::delta_, kinematicSingleLayer::deltaSmall_, and Foam::pos().

Referenced by kinematicSingleLayer::preEvolveRegion().

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

Definition at line 210 of file kinematicSingleLayer.C.

References kinematicSingleLayer::availableMass_, kinematicSingleLayer::cloudDiameterTrans_, kinematicSingleLayer::cloudMassTrans_, transferModelList::correct(), injectionModelList::correct(), DebugInFunction, TimeState::deltaT(), Foam::endl(), kinematicSingleLayer::injection_, singleLayerRegion::magSf(), kinematicSingleLayer::rhoSp_, regionModel::time(), kinematicSingleLayer::transfer_, and kinematicSingleLayer::turbulence_.

Referenced by kinematicSingleLayer::evolveRegion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ continuityCheck()

void continuityCheck ( )

protectedvirtual

Continuity check.

Definition at line 227 of file kinematicSingleLayer.C.

References kinematicSingleLayer::cumulativeContErr_, Foam::expressions::patchExpr::debug, kinematicSingleLayer::deltaRho_, Foam::dimMass, Foam::dimVolume, Foam::fvc::domainIntegrate(), Foam::endl(), globalContErr, InfoInFunction, Foam::mag(), singleLayerRegion::magSf(), kinematicSingleLayer::mass(), Foam::nl, kinematicSingleLayer::solveContinuity(), sumLocalContErr, totalMass, and Foam::type().

Here is the call graph for this function:

◆ updateSurfaceVelocities()

void updateSurfaceVelocities ( )

protectedvirtual

Update film surface velocities.

Definition at line 275 of file kinematicSingleLayer.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), polyMesh::boundaryMesh(), GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), regionModel::intCoupledPatchIDs_, singleLayerRegion::nHat(), kinematicSingleLayer::pp(), regionModel::regionMesh(), kinematicSingleLayer::turbulence_, kinematicSingleLayer::U_, kinematicSingleLayer::Us_, and kinematicSingleLayer::Uw_.

Referenced by kinematicSingleLayer::preEvolveRegion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ constrainFilmField()

void constrainFilmField	(	Type &	field,
		const typename Type::cmptType &	value
	)

protected

Constrain a film region master/slave boundaries of a field to a.

given value

Definition at line 43 of file kinematicSingleLayerTemplates.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), field(), forAll, and Foam::Info.

Here is the call graph for this function:

◆ solveContinuity()

void solveContinuity ( )

protectedvirtual

Solve continuity equation.

Definition at line 261 of file kinematicSingleLayer.C.

References Foam::fvm::ddt(), DebugInFunction, kinematicSingleLayer::deltaRho_, Foam::fvc::div(), Foam::endl(), kinematicSingleLayer::phi_, kinematicSingleLayer::rhoSp_, and Foam::solve().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ solveMomentum()

tmp< Foam::fvVectorMatrix > solveMomentum	(	const volScalarField &	pu,
		const volScalarField &	pp
	)

protectedvirtual

Solve for film velocity.

Definition at line 293 of file kinematicSingleLayer.C.

References Foam::fvm::ddt(), DebugInFunction, Foam::fvm::div(), Foam::endl(), Foam::fvc::flux(), Foam::fvc::interpolate(), Foam::fvc::reconstruct(), Foam::fvc::snGrad(), Foam::solve(), tUEqn(), and UEqn.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ solveThickness()

void solveThickness	(	const volScalarField &	pu,
		const volScalarField &	pp,
		fvVectorMatrix &	UEqn
	)

protectedvirtual

Solve coupled velocity-thickness equations.

Definition at line 348 of file kinematicSingleLayer.C.

References Foam::fvm::ddt(), DebugInFunction, Foam::fvm::div(), Foam::endl(), Foam::fvc::flux(), fvMatrix< Type >::flux(), Foam::fvc::interpolate(), Foam::fvm::laplacian(), phid(), Foam::fvc::reconstruct(), rhof(), Foam::fvc::snGrad(), fvMatrix< Type >::solve(), and UEqn.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "kinematicSingleLayer" )

Runtime type information.

◆ CourantNumber()

scalar CourantNumber ( ) const

virtual

Courant number evaluation.

Implements surfaceFilmModel.

Definition at line 921 of file kinematicSingleLayer.C.

References kinematicSingleLayer::alpha_, CoNum, kinematicSingleLayer::delta_, kinematicSingleLayer::deltaCoLimit_, kinematicSingleLayer::deltaRho_, TimeState::deltaTValue(), Foam::endl(), forAll, Foam::Info, Foam::mag(), singleLayerRegion::magSf(), Foam::max(), kinematicSingleLayer::phi_, GeometricField< Type, PatchField, GeoMesh >::primitiveField(), Foam::reduce(), regionModel::regionMesh(), Foam::fvc::surfaceSum(), and regionModel::time_.

Here is the call graph for this function:

◆ momentumPredictor()

Switch momentumPredictor ( ) const

inline

Return the momentum predictor.

Definition at line 44 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::momentumPredictor_.

◆ nOuterCorr()

label nOuterCorr ( ) const

inline

Return the number of outer correctors.

Definition at line 50 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::nOuterCorr_.

◆ nCorr()

label nCorr ( ) const

inline

Return the number of PISO correctors.

Definition at line 56 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::nCorr_.

◆ nNonOrthCorr()

label nNonOrthCorr ( ) const

inline

Return the number of non-orthogonal correctors.

Definition at line 62 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::nNonOrthCorr_.

◆ deltaSmall()

const dimensionedScalar & deltaSmall ( ) const

inline

Return small delta.

Definition at line 68 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::deltaSmall_.

Referenced by thixotropicViscosity::correct().

Here is the caller graph for this function:

◆ mu()

const volScalarField & mu ( ) const

inline

Return const access to the dynamic viscosity [Pa.s].

Definition at line 74 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::mu_.

◆ sigma()

const volScalarField & sigma ( ) const

inlinevirtual

Return const access to the surface tension [kg/s2].

Implements surfaceFilmRegionModel.

Definition at line 80 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::sigma_.

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

Here is the caller graph for this function:

◆ delta()

const volScalarField & delta ( ) const

inlinevirtual

Return const access to the film thickness [m].

Implements surfaceFilmRegionModel.

Definition at line 86 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::delta_.

Referenced by drippingInjection::correct(), BrunDrippingInjection::correct(), curvatureSeparation::correct(), thixotropicViscosity::correct(), standardPhaseChange::correctModel(), and waxSolventEvaporation::correctModel().

Here is the caller graph for this function:

◆ alpha()

const volScalarField & alpha ( ) const

inlinevirtual

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

Implements surfaceFilmRegionModel.

Definition at line 92 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::alpha_.

Referenced by thixotropicViscosity::correct(), and solidification::correctModel().

Here is the caller graph for this function:

◆ U()

const volVectorField & U ( ) const

virtual

Return the film velocity [m/s].

Implements surfaceFilmRegionModel.

Definition at line 952 of file kinematicSingleLayer.C.

References kinematicSingleLayer::U_.

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

Here is the caller graph for this function:

◆ Us()

const volVectorField & Us ( ) const

virtual

Return the film surface velocity [m/s].

Implements surfaceFilmRegionModel.

Definition at line 958 of file kinematicSingleLayer.C.

References kinematicSingleLayer::Us_.

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

Here is the caller graph for this function:

◆ Uw()

const volVectorField & Uw ( ) const

virtual

Return the film wall velocity [m/s].

Implements surfaceFilmRegionModel.

Definition at line 964 of file kinematicSingleLayer.C.

References kinematicSingleLayer::Uw_.

Referenced by thixotropicViscosity::correct().

Here is the caller graph for this function:

◆ deltaRho()

const volScalarField & deltaRho ( ) const

virtual

Return the film thickness*density (helper field) [kg/m3].

Definition at line 970 of file kinematicSingleLayer.C.

References kinematicSingleLayer::deltaRho_.

Referenced by thixotropicViscosity::correct(), and waxSolventEvaporation::correctModel().

Here is the caller graph for this function:

◆ phi()

const surfaceScalarField & phi ( ) const

virtual

Return the film flux [kg.m/s].

Definition at line 976 of file kinematicSingleLayer.C.

References kinematicSingleLayer::phi_.

Referenced by curvatureSeparation::correct(), thixotropicViscosity::correct(), and waxSolventEvaporation::correctModel().

Here is the caller graph for this function:

◆ rho()

const volScalarField & rho ( ) const

virtual

Return the film density [kg/m3].

Implements surfaceFilmRegionModel.

Definition at line 982 of file kinematicSingleLayer.C.

References kinematicSingleLayer::rho_.

Referenced by drippingInjection::correct(), BrunDrippingInjection::correct(), curvatureSeparation::correct(), standardPhaseChange::correctModel(), waxSolventEvaporation::correctModel(), and solidification::correctModel().

Here is the caller graph for this function:

◆ T()

const volScalarField & T ( ) const

virtual

Return the film mean temperature [K].

Implements surfaceFilmRegionModel.

Reimplemented in thermoSingleLayer.

Definition at line 988 of file kinematicSingleLayer.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, GeometricField< scalar, fvPatchField, volMesh >::null(), and Foam::type().

Here is the call graph for this function:

◆ Ts()

const volScalarField & Ts ( ) const

virtual

Return the film surface temperature [K].

Implements surfaceFilmRegionModel.

Reimplemented in thermoSingleLayer.

Definition at line 997 of file kinematicSingleLayer.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, GeometricField< scalar, fvPatchField, volMesh >::null(), and Foam::type().

Here is the call graph for this function:

◆ Tw()

const volScalarField & Tw ( ) const

virtual

Return the film wall temperature [K].

Implements surfaceFilmRegionModel.

Reimplemented in thermoSingleLayer.

Definition at line 1006 of file kinematicSingleLayer.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, GeometricField< scalar, fvPatchField, volMesh >::null(), and Foam::type().

Here is the call graph for this function:

◆ hs()

const volScalarField & hs ( ) const

virtual

Return the film surface enthalpy [J/kg].

Implements surfaceFilmRegionModel.

Reimplemented in thermoSingleLayer.

Definition at line 1015 of file kinematicSingleLayer.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, GeometricField< scalar, fvPatchField, volMesh >::null(), and Foam::type().

Here is the call graph for this function:

◆ Cp()

const volScalarField & Cp ( ) const

virtual

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

Implements surfaceFilmRegionModel.

Reimplemented in thermoSingleLayer.

Definition at line 1024 of file kinematicSingleLayer.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, GeometricField< scalar, fvPatchField, volMesh >::null(), and Foam::type().

Here is the call graph for this function:

◆ kappa()

const volScalarField & kappa ( ) const

virtual

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

Implements surfaceFilmRegionModel.

Reimplemented in thermoSingleLayer.

Definition at line 1033 of file kinematicSingleLayer.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, GeometricField< scalar, fvPatchField, volMesh >::null(), and Foam::type().

Here is the call graph for this function:

◆ primaryMassTrans()

tmp< volScalarField > primaryMassTrans ( ) const

virtual

Return mass transfer source - Eulerian phase only.

Implements surfaceFilmRegionModel.

Definition at line 1042 of file kinematicSingleLayer.C.

References kinematicSingleLayer::primaryMassTrans_.

◆ cloudMassTrans()

const volScalarField & cloudMassTrans ( ) const

virtual

Return the film mass available for transfer to cloud.

Implements surfaceFilmRegionModel.

Definition at line 1048 of file kinematicSingleLayer.C.

References kinematicSingleLayer::cloudMassTrans_.

◆ cloudDiameterTrans()

const volScalarField & cloudDiameterTrans ( ) const

virtual

Return the parcel diameters originating from film to cloud.

Implements surfaceFilmRegionModel.

Definition at line 1054 of file kinematicSingleLayer.C.

References kinematicSingleLayer::cloudDiameterTrans_.

◆ addSources()

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

virtual

External hook to add sources to the film.

Implements surfaceFilmRegionModel.

Reimplemented in thermoSingleLayer.

Definition at line 830 of file kinematicSingleLayer.C.

References DebugInFunction, Foam::endl(), Foam::nl, and Foam::type().

Referenced by thermoSingleLayer::addSources().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ USpPrimary()

volVectorField & USpPrimary ( )

inline

Momentum [kg/m/s2].

Definition at line 98 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::USpPrimary_.

◆ pSpPrimary()

volScalarField & pSpPrimary ( )

inline

Pressure [Pa].

Definition at line 104 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::pSpPrimary_.

◆ rhoSpPrimary()

volScalarField & rhoSpPrimary ( )

inline

Mass [kg/m2/s].

Definition at line 110 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::rhoSpPrimary_.

◆ USp() [1/2]

volVectorField & USp ( )

inline

Momentum [kg/m/s2].

Definition at line 116 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::USp_.

◆ pSp() [1/2]

volScalarField & pSp ( )

inline

Pressure [Pa].

Definition at line 122 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::pSp_.

◆ rhoSp() [1/2]

volScalarField & rhoSp ( )

inline

Mass [kg/m2/s].

Definition at line 128 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::rhoSp_.

Referenced by thixotropicViscosity::correct(), and waxSolventEvaporation::correctModel().

Here is the caller graph for this function:

◆ USp() [2/2]

const volVectorField & USp ( ) const

inline

Momentum [kg/m/s2].

Definition at line 134 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::USp_.

◆ pSp() [2/2]

const volScalarField & pSp ( ) const

inline

Pressure [Pa].

Definition at line 140 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::pSp_.

◆ rhoSp() [2/2]

const volScalarField & rhoSp ( ) const

inline

Mass [kg/m2/s].

Definition at line 146 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::rhoSp_.

◆ UPrimary()

const volVectorField & UPrimary ( ) const

inline

Velocity [m/s].

Definition at line 152 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::UPrimary_.

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

Here is the caller graph for this function:

◆ pPrimary()

const volScalarField & pPrimary ( ) const

inline

Pressure [Pa].

Definition at line 158 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::pPrimary_.

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

Here is the caller graph for this function:

◆ rhoPrimary()

const volScalarField & rhoPrimary ( ) const

inline

Density [kg/m3].

Definition at line 164 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::rhoPrimary_.

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

Here is the caller graph for this function:

◆ muPrimary()

const volScalarField & muPrimary ( ) const

inline

Viscosity [Pa.s].

Definition at line 170 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::muPrimary_.

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

Here is the caller graph for this function:

◆ filmThermo()

const filmThermoModel & filmThermo ( ) const

inline

Film thermo.

Definition at line 176 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::filmThermo_.

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

Here is the caller graph for this function:

◆ injection()

injectionModelList & injection ( )

inline

Injection.

Definition at line 182 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::injection_.

◆ transfer()

transferModelList & transfer ( )

inline

Transfer.

Definition at line 188 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::transfer_.

◆ turbulence()

const filmTurbulenceModel & turbulence ( ) const

inline

Turbulence.

Definition at line 194 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::turbulence_.

◆ mass()

tmp< volScalarField > mass ( ) const

inline

Return the current film mass.

Definition at line 200 of file kinematicSingleLayerI.H.

References kinematicSingleLayer::deltaRho_, and singleLayerRegion::magSf().

Referenced by kinematicSingleLayer::continuityCheck(), and kinematicSingleLayer::preEvolveRegion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deltaMass()

tmp< volScalarField > deltaMass ( ) const

inline

Return the change in film mass due to sources/sinks.

Definition at line 206 of file kinematicSingleLayerI.H.

References TimeState::deltaT(), singleLayerRegion::magSf(), kinematicSingleLayer::rhoSp_, and regionModel::time().

Here is the call graph for this function:

◆ gNorm()

tmp< volScalarField > gNorm ( ) const

inline

Return the gravity normal-to-patch component contribution.

Definition at line 212 of file kinematicSingleLayerI.H.

References surfaceFilmRegionModel::g_, singleLayerRegion::nHat(), IOobject::NO_READ, IOobject::NO_WRITE, regionModel::regionMesh(), regionModel::time(), and timeName.

Referenced by drippingInjection::correct(), BrunDrippingInjection::correct(), and kinematicSingleLayer::gTan().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gNormClipped()

tmp< volScalarField > gNormClipped ( ) const

inline

Return the gravity normal-to-patch component contribution.

Clipped so that only non-zero if g & nHat_ < 0

Definition at line 234 of file kinematicSingleLayerI.H.

References surfaceFilmRegionModel::g_, singleLayerRegion::nHat(), IOobject::NO_READ, IOobject::NO_WRITE, tmp< T >::ref(), regionModel::regionMesh(), regionModel::time(), and timeName.

Referenced by kinematicSingleLayer::pp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gTan() [1/2]

tmp< volVectorField > gTan ( ) const

inline

Return the gravity tangential component contributions.

Definition at line 259 of file kinematicSingleLayerI.H.

References surfaceFilmRegionModel::g_, kinematicSingleLayer::gNorm(), singleLayerRegion::nHat(), IOobject::NO_READ, IOobject::NO_WRITE, regionModel::regionMesh(), regionModel::time(), and timeName.

Here is the call graph for this function:

◆ gTan() [2/2]

tmp< vectorField > gTan ( const label patchI ) const

inline

Return the gravity tangential component contributions for patchI.

Definition at line 281 of file kinematicSingleLayerI.H.

References g.

◆ preEvolveRegion()

void preEvolveRegion ( )

virtual

Pre-evolve film hook.

Reimplemented from regionModel.

Reimplemented in thermoSingleLayer.

Definition at line 853 of file kinematicSingleLayer.C.

Referenced by thermoSingleLayer::preEvolveRegion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ evolveRegion()

void evolveRegion ( )

virtual

Evolve the film equations.

Reimplemented from regionModel.

Reimplemented in thermoSingleLayer.

Definition at line 877 of file kinematicSingleLayer.C.

References DebugInFunction, kinematicSingleLayer::delta_, kinematicSingleLayer::deltaRho_, Foam::endl(), kinematicSingleLayer::nCorr_, kinematicSingleLayer::nOuterCorr_, kinematicSingleLayer::pp(), kinematicSingleLayer::pu(), kinematicSingleLayer::rho_, kinematicSingleLayer::solveContinuity(), kinematicSingleLayer::solveMomentum(), kinematicSingleLayer::solveThickness(), tUEqn(), UEqn, and kinematicSingleLayer::updateSubmodels().

Here is the call graph for this function:

◆ postEvolveRegion()

void postEvolveRegion ( )

virtual

Post-evolve film hook.

Reimplemented from regionModel.

Definition at line 912 of file kinematicSingleLayer.C.

References DebugInFunction, Foam::endl(), and kinematicSingleLayer::resetPrimaryRegionSourceTerms().

Here is the call graph for this function:

◆ Srho() [1/2]

tmp< volScalarField::Internal > Srho ( ) const

virtual

Return total mass source - Eulerian phase only.

Implements surfaceFilmModel.

Reimplemented in thermoSingleLayer.

Definition at line 1085 of file kinematicSingleLayer.C.

References Foam::dimMass, Foam::dimTime, Foam::dimVolume, tmp< T >::New(), IOobject::NO_READ, IOobject::NO_WRITE, regionModel::primaryMesh(), regionModel::time(), timeName, and Foam::Zero.

Here is the call graph for this function:

◆ Srho() [2/2]

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

virtual

Return mass source for specie i - Eulerian phase only.

Implements surfaceFilmModel.

Reimplemented in thermoSingleLayer.

Definition at line 1105 of file kinematicSingleLayer.C.

References Foam::dimMass, Foam::dimTime, Foam::dimVolume, Foam::name(), tmp< T >::New(), IOobject::NO_READ, IOobject::NO_WRITE, timeName, and Foam::Zero.

Here is the call graph for this function:

◆ Sh()

tmp< volScalarField::Internal > Sh ( ) const

virtual

Return enthalpy source - Eulerian phase only.

Implements surfaceFilmModel.

Reimplemented in thermoSingleLayer.

Definition at line 1126 of file kinematicSingleLayer.C.

References Foam::dimEnergy, Foam::dimTime, Foam::dimVolume, tmp< T >::New(), IOobject::NO_READ, IOobject::NO_WRITE, regionModel::primaryMesh(), regionModel::time(), timeName, and Foam::Zero.

Here is the call graph for this function:

◆ info()

void info ( )

virtual

Provide some feedback.

Reimplemented from regionModel.

Reimplemented in thermoSingleLayer.

Definition at line 1060 of file kinematicSingleLayer.C.

References kinematicSingleLayer::addedMassTotal_, kinematicSingleLayer::alpha_, kinematicSingleLayer::delta_, kinematicSingleLayer::deltaRho_, Foam::endl(), Foam::gMax(), Foam::gMin(), Foam::gSum(), Foam::indent(), injectionModelList::info(), transferModelList::info(), Foam::Info, kinematicSingleLayer::injection_, Foam::mag(), singleLayerRegion::magSf(), Foam::nl, regionModel::outputProperties(), GeometricField< Type, PatchField, GeoMesh >::primitiveField(), dictionary::readIfPresent(), Foam::returnReduce(), kinematicSingleLayer::transfer_, Foam::type(), and kinematicSingleLayer::U_.

Referenced by thermoSingleLayer::info().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ momentumPredictor_

Switch momentumPredictor_

protected

Momentum predictor.

Definition at line 89 of file kinematicSingleLayer.H.

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

◆ nOuterCorr_

label nOuterCorr_

protected

Number of outer correctors.

Definition at line 92 of file kinematicSingleLayer.H.

Referenced by thermoSingleLayer::evolveRegion(), kinematicSingleLayer::evolveRegion(), kinematicSingleLayer::nOuterCorr(), and kinematicSingleLayer::read().

◆ nCorr_

label nCorr_

protected

Number of PISO-like correctors.

Definition at line 95 of file kinematicSingleLayer.H.

Referenced by thermoSingleLayer::evolveRegion(), kinematicSingleLayer::evolveRegion(), kinematicSingleLayer::nCorr(), and kinematicSingleLayer::read().

◆ nNonOrthCorr_

label nNonOrthCorr_

protected

Number of non-orthogonal correctors.

Definition at line 98 of file kinematicSingleLayer.H.

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

◆ cumulativeContErr_

scalar cumulativeContErr_

protected

Cumulative continuity error.

Definition at line 101 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::continuityCheck().

◆ deltaSmall_

const dimensionedScalar deltaSmall_

protected

Small delta.

Definition at line 104 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::correctAlpha(), and kinematicSingleLayer::deltaSmall().

◆ deltaCoLimit_

scalar deltaCoLimit_

protected

Film thickness above which Courant number calculation in valid.

Definition at line 107 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::CourantNumber().

◆ rho_

volScalarField rho_

protected

Density [kg/m3].

Definition at line 115 of file kinematicSingleLayer.H.

Referenced by thermoSingleLayer::correctThermoFields(), kinematicSingleLayer::correctThermoFields(), thermoSingleLayer::evolveRegion(), kinematicSingleLayer::evolveRegion(), kinematicSingleLayer::pp(), and kinematicSingleLayer::rho().

◆ mu_

volScalarField mu_

protected

Dynamic viscosity [Pa.s].

Definition at line 118 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::correctThermoFields(), and kinematicSingleLayer::mu().

◆ sigma_

volScalarField sigma_

protected

Surface tension [m/s2].

Definition at line 121 of file kinematicSingleLayer.H.

Referenced by thermoSingleLayer::correctThermoFields(), kinematicSingleLayer::correctThermoFields(), kinematicSingleLayer::pu(), and kinematicSingleLayer::sigma().

◆ delta_

volScalarField delta_

protected

Film thickness [m].

Definition at line 127 of file kinematicSingleLayer.H.

Referenced by thermoSingleLayer::correctAlpha(), kinematicSingleLayer::correctAlpha(), kinematicSingleLayer::CourantNumber(), kinematicSingleLayer::delta(), thermoSingleLayer::evolveRegion(), kinematicSingleLayer::evolveRegion(), kinematicSingleLayer::info(), and kinematicSingleLayer::pu().

◆ alpha_

volScalarField alpha_

protected

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

Definition at line 130 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::alpha(), thermoSingleLayer::correctAlpha(), kinematicSingleLayer::correctAlpha(), kinematicSingleLayer::CourantNumber(), kinematicSingleLayer::info(), and thermoSingleLayer::q().

◆ U_

volVectorField U_

protected

Velocity - mean [m/s].

Definition at line 133 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::info(), kinematicSingleLayer::U(), and kinematicSingleLayer::updateSurfaceVelocities().

◆ Us_

volVectorField Us_

protected

Velocity - surface [m/s].

Definition at line 136 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::updateSurfaceVelocities(), and kinematicSingleLayer::Us().

◆ Uw_

volVectorField Uw_

protected

Velocity - wall [m/s].

Definition at line 139 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::updateSurfaceVelocities(), and kinematicSingleLayer::Uw().

◆ deltaRho_

volScalarField deltaRho_

protected

Film thickness*density (helper field) [kg/m2].

Definition at line 142 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::continuityCheck(), kinematicSingleLayer::CourantNumber(), kinematicSingleLayer::deltaRho(), thermoSingleLayer::evolveRegion(), kinematicSingleLayer::evolveRegion(), kinematicSingleLayer::info(), kinematicSingleLayer::mass(), kinematicSingleLayer::solveContinuity(), and thermoSingleLayer::solveEnergy().

◆ phi_

surfaceScalarField phi_

protected

Mass flux (includes film thickness) [kg.m/s].

Definition at line 145 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::CourantNumber(), kinematicSingleLayer::phi(), kinematicSingleLayer::solveContinuity(), and thermoSingleLayer::solveEnergy().

◆ primaryMassTrans_

volScalarField primaryMassTrans_

protected

Film mass available for transfer to the primary region.

Definition at line 151 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::preEvolveRegion(), kinematicSingleLayer::primaryMassTrans(), thermoSingleLayer::Srho(), and thermoSingleLayer::updateSubmodels().

◆ cloudMassTrans_

volScalarField cloudMassTrans_

protected

Film mass available for transfer to cloud.

Definition at line 154 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::cloudMassTrans(), kinematicSingleLayer::preEvolveRegion(), thermoSingleLayer::updateSubmodels(), and kinematicSingleLayer::updateSubmodels().

◆ cloudDiameterTrans_

volScalarField cloudDiameterTrans_

protected

Parcel diameters originating from film to cloud.

Definition at line 157 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::cloudDiameterTrans(), kinematicSingleLayer::preEvolveRegion(), thermoSingleLayer::updateSubmodels(), and kinematicSingleLayer::updateSubmodels().

◆ USp_

volVectorField USp_

protected

Momentum [kg/m/s2].

Definition at line 167 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::resetPrimaryRegionSourceTerms(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), and kinematicSingleLayer::USp().

◆ pSp_

volScalarField pSp_

protected

Pressure [Pa].

Definition at line 170 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::pSp(), kinematicSingleLayer::pu(), kinematicSingleLayer::resetPrimaryRegionSourceTerms(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), and thermoSingleLayer::updateSubmodels().

◆ rhoSp_

volScalarField rhoSp_

protected

Mass [kg/m2/s].

Definition at line 173 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::deltaMass(), kinematicSingleLayer::resetPrimaryRegionSourceTerms(), kinematicSingleLayer::rhoSp(), kinematicSingleLayer::solveContinuity(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), thermoSingleLayer::updateSubmodels(), and kinematicSingleLayer::updateSubmodels().

◆ USpPrimary_

volVectorField USpPrimary_

protected

Momentum [kg/m/s2].

Definition at line 180 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::resetPrimaryRegionSourceTerms(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), and kinematicSingleLayer::USpPrimary().

◆ pSpPrimary_

volScalarField pSpPrimary_

protected

Pressure [Pa].

Definition at line 183 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::pSpPrimary(), kinematicSingleLayer::resetPrimaryRegionSourceTerms(), and kinematicSingleLayer::transferPrimaryRegionSourceFields().

◆ rhoSpPrimary_

volScalarField rhoSpPrimary_

protected

Mass [kg/m2/s].

Definition at line 186 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::resetPrimaryRegionSourceTerms(), kinematicSingleLayer::rhoSpPrimary(), and kinematicSingleLayer::transferPrimaryRegionSourceFields().

◆ UPrimary_

volVectorField UPrimary_

protected

Velocity [m/s].

Definition at line 193 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::transferPrimaryRegionThermoFields(), and kinematicSingleLayer::UPrimary().

◆ pPrimary_

volScalarField pPrimary_

protected

Pressure [Pa].

Definition at line 196 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::pPrimary(), kinematicSingleLayer::pu(), thermoSingleLayer::solveEnergy(), and kinematicSingleLayer::transferPrimaryRegionThermoFields().

◆ rhoPrimary_

volScalarField rhoPrimary_

protected

Density [kg/m3].

Definition at line 199 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::rhoPrimary(), kinematicSingleLayer::transferPrimaryRegionThermoFields(), and thermoSingleLayer::updateSubmodels().

◆ muPrimary_

volScalarField muPrimary_

protected

Viscosity [Pa.s].

Definition at line 202 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::muPrimary(), and kinematicSingleLayer::transferPrimaryRegionThermoFields().

◆ filmThermo_

autoPtr<filmThermoModel> filmThermo_

protected

Film thermo model.

Definition at line 208 of file kinematicSingleLayer.H.

Referenced by thermoSingleLayer::correctThermoFields(), kinematicSingleLayer::correctThermoFields(), and kinematicSingleLayer::filmThermo().

◆ availableMass_

scalarField availableMass_

protected

Available mass for transfer via sub-models.

Definition at line 211 of file kinematicSingleLayer.H.

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

◆ injection_

injectionModelList injection_

protected

Cloud injection.

Definition at line 214 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::info(), kinematicSingleLayer::injection(), thermoSingleLayer::updateSubmodels(), and kinematicSingleLayer::updateSubmodels().

◆ transfer_

transferModelList transfer_

protected

Transfer with the continuous phase.

Definition at line 217 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::info(), kinematicSingleLayer::transfer(), thermoSingleLayer::updateSubmodels(), and kinematicSingleLayer::updateSubmodels().

◆ turbulence_

autoPtr<filmTurbulenceModel> turbulence_

protected

Turbulence model.

Definition at line 220 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::turbulence(), thermoSingleLayer::updateSubmodels(), kinematicSingleLayer::updateSubmodels(), and kinematicSingleLayer::updateSurfaceVelocities().

◆ forces_

forceList forces_

protected

List of film forces.

Definition at line 223 of file kinematicSingleLayer.H.

◆ addedMassTotal_

scalar addedMassTotal_

protected

Cumulative mass added via sources [kg].

Definition at line 229 of file kinematicSingleLayer.H.

Referenced by kinematicSingleLayer::info(), and kinematicSingleLayer::transferPrimaryRegionSourceFields().

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

src/regionModels/surfaceFilmModels/kinematicSingleLayer/kinematicSingleLayer.H
src/regionModels/surfaceFilmModels/kinematicSingleLayer/kinematicSingleLayer.C
src/regionModels/surfaceFilmModels/kinematicSingleLayer/kinematicSingleLayerI.H
src/regionModels/surfaceFilmModels/kinematicSingleLayer/kinematicSingleLayerTemplates.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ kinematicSingleLayer()

◆ ~kinematicSingleLayer()

Member Function Documentation

◆ read()

◆ correctThermoFields()

◆ resetPrimaryRegionSourceTerms()

◆ transferPrimaryRegionThermoFields()

◆ transferPrimaryRegionSourceFields()

◆ pu()

◆ pp()

◆ correctAlpha()

◆ updateSubmodels()

◆ continuityCheck()

◆ updateSurfaceVelocities()

◆ constrainFilmField()

◆ solveContinuity()

◆ solveMomentum()

◆ solveThickness()

◆ TypeName()

◆ CourantNumber()

◆ momentumPredictor()

◆ nOuterCorr()

◆ nCorr()

◆ nNonOrthCorr()

◆ deltaSmall()

◆ mu()

◆ sigma()

◆ delta()

◆ alpha()

◆ U()

◆ Us()

◆ Uw()

◆ deltaRho()

◆ phi()

◆ rho()

◆ T()

◆ Ts()

◆ Tw()

◆ hs()

◆ Cp()

◆ kappa()

◆ primaryMassTrans()

◆ cloudMassTrans()

◆ cloudDiameterTrans()

◆ addSources()

◆ USpPrimary()

◆ pSpPrimary()

◆ rhoSpPrimary()

◆ USp() [1/2]

◆ pSp() [1/2]

◆ rhoSp() [1/2]

◆ USp() [2/2]

◆ pSp() [2/2]

◆ rhoSp() [2/2]

◆ UPrimary()

◆ pPrimary()

◆ rhoPrimary()

◆ muPrimary()

◆ filmThermo()

◆ injection()

◆ transfer()

◆ turbulence()

◆ mass()

◆ deltaMass()

◆ gNorm()

◆ gNormClipped()

◆ gTan() [1/2]

◆ gTan() [2/2]

◆ preEvolveRegion()

◆ evolveRegion()

◆ postEvolveRegion()

◆ Srho() [1/2]

◆ Srho() [2/2]

◆ Sh()