This function looks up wall boiling wall functions and collects and writes out out the following data: More...

Inheritance diagram for wallBoilingProperties:

Collaboration diagram for wallBoilingProperties:

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

	wallBoilingProperties (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

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

virtual	~wallBoilingProperties ()
	Destructor. More...

virtual bool	read (const dictionary &)
	Read the wallBoilingProperties data. More...

virtual wordList	fields () const
	Return the list of fields required. More...

virtual bool	execute ()
	Calculate the wallBoilingProperties field. More...

virtual bool	write ()
	Write the wallBoilingProperties field. More...

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

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

	fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

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

virtual	~fvMeshFunctionObject ()
	Destructor. More...

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

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

	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

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

virtual	~regionFunctionObject ()
	Destructor. More...

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

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

virtual const word &	type () const =0
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name, const Time &runTime)
	Construct from components. More...

autoPtr< functionObject >	clone () const
	Return clone. More...

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

virtual	~functionObject ()
	Destructor. More...

const word &	name () const
	Return the name of this functionObject. More...

virtual bool	executeAtStart () const
	Return true if the functionObject should be executed at the start. More...

virtual bool	end ()
	Called when Time::run() determines that the time-loop exits. More...

virtual scalar	timeToNextAction ()
	Called by Time::adjustTimeStep(). Allows the functionObject to. More...

virtual void	movePoints (const polyMesh &mesh)
	Update topology using the given map. More...

virtual void	topoChange (const polyTopoChangeMap &map)
	Update topology using the given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

virtual void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution map. More...

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

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &, const dictionary &)
	Select from dictionary, based on its "type" entry. More...

Public Attributes inherited from functionObject
Switch	log
	Switch write log to Info. More...

Switch	executeAtStart_
	Switch write log to Info. More...

Static Public Attributes inherited from functionObject
static bool	postProcess
	Global post-processing mode switch. More...

Protected Member Functions inherited from regionFunctionObject
template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find field in the objectRegistry. More...

template<class ObjectType >
void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup object from the objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName)
	Lookup non-const object reference from the objectRegistry. More...

template<class ObjectType >
bool	store (const tmp< ObjectType > &tfield)
	Store the given field in the objectRegistry. More...

template<class ObjectType >
bool	store (const word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
	Store the given field in the objectRegistry under the given name. More...

bool	writeObject (const word &fieldName)
	Write field if present in objectRegistry. More...

bool	clearObject (const word &fieldName)
	Clear field from the objectRegistry if present. More...

Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
	Reference to the fvMesh. More...

Protected Attributes inherited from regionFunctionObject
const objectRegistry &	obr_
	Reference to the region objectRegistry. More...

Protected Attributes inherited from functionObject
const Time &	time_
	Reference to time. More...

Detailed Description

This function looks up wall boiling wall functions and collects and writes out out the following data:

Bubble departure diameter
Bubble departure frequency
Nucleation site density
Effective liquid fraction at the wall
Quenching heat flux
Evaporative heat flux

Example of function object specification:

writeWallBoilingProperties
{
    type            wallBoilingProperties;
    libs            ( "libmultiphaseEulerFoamFunctionObjects.so" );
    writeControl    writeTime;
    phase           liquid;
}

Usage

Property	Description	Required	Default value
`type`	type name: wallBoilingProperties	yes
`phase`	phase name	yes	none

Source files

Definition at line 92 of file wallBoilingProperties.H.

Constructor & Destructor Documentation

◆ wallBoilingProperties() [1/2]

wallBoilingProperties	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict
	)

Construct from Time and dictionary.

Definition at line 50 of file wallBoilingProperties.C.

References dict, and wallBoilingProperties::read().

Here is the call graph for this function:

◆ wallBoilingProperties() [2/2]

wallBoilingProperties ( const wallBoilingProperties & )

delete

Disallow default bitwise copy construction.

◆ ~wallBoilingProperties()

~wallBoilingProperties ( )

virtual

Destructor.

Definition at line 73 of file wallBoilingProperties.C.

Member Function Documentation

◆ TypeName()

TypeName ( "wallBoilingProperties" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the wallBoilingProperties data.

Reimplemented from regionFunctionObject.

Definition at line 79 of file wallBoilingProperties.C.

References dict, and regionFunctionObject::read().

Referenced by wallBoilingProperties::wallBoilingProperties().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fields()

virtual wordList fields ( ) const

inlinevirtual

Return the list of fields required.

Implements functionObject.

Definition at line 135 of file wallBoilingProperties.H.

References List< word >::null().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Calculate the wallBoilingProperties field.

Implements functionObject.

Definition at line 87 of file wallBoilingProperties.C.

◆ write()

bool write ( )

virtual

Write the wallBoilingProperties field.

Implements functionObject.

Definition at line 93 of file wallBoilingProperties.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), Foam::dimArea, Foam::dimEnergy, Foam::dimLength, Foam::dimless, Foam::dimTime, forAll, IOobject::groupName(), Foam::inv(), DimensionedField< Type, GeoMesh >::mesh(), GeometricField< Type, PatchField, GeoMesh >::New(), patchi, and regIOobject::write().

Here is the call graph for this function:

◆ operator=()

void operator= ( const wallBoilingProperties & )

delete

Disallow default bitwise assignment.

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

applications/modules/multiphaseEuler/functionObjects/wallBoilingProperties/wallBoilingProperties.H
applications/modules/multiphaseEuler/functionObjects/wallBoilingProperties/wallBoilingProperties.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ wallBoilingProperties() [1/2]

◆ wallBoilingProperties() [2/2]

◆ ~wallBoilingProperties()

Member Function Documentation

◆ TypeName()

◆ read()

◆ fields()

◆ execute()

◆ write()

◆ operator=()