Calculates the mass flux for surface film models. More...

Inheritance diagram for filmFlux:

Collaboration diagram for filmFlux:

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

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

	filmFlux (const filmFlux &)=delete
	No copy construct. More...

void	operator= (const filmFlux &)=delete
	No copy assignment. More...

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

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

virtual bool	execute ()
	Execute. More...

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

Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)
	Construct from components. More...

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

dictionary &	propertyDict ()
	Return access to the property dictionary. More...

bool	foundProperty (const word &entryName) const
	Return true if the property exists. More...

void	clearTrigger ()
	Remove the trigger index from the properties. More...

label	getTrigger () const
	Get the current trigger index. More...

bool	setTrigger (const label triggeri, bool increaseOnly=true)
	Set the trigger index. Normally only if greater than current. More...

bool	getDict (const word &entryName, dictionary &dict) const
	Set dictionary, return true if set. More...

bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
	Set dictionary from named object, return true if set. More...

template<class Type >
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property. More...

template<class Type >
bool	getProperty (const word &entryName, Type &value) const
	Set generic property, return true if set. More...

template<class Type >
void	setProperty (const word &entryName, const Type &value)
	Add generic property. More...

template<class Type >
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from named object. More...

template<class Type >
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const
	Set generic property from named object, return true if set. More...

template<class Type >
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)
	Add generic property from named object. More...

template<class Type >
void	setResult (const word &entryName, const Type &value)
	Add result. More...

template<class Type >
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)
	Add result from named object. More...

template<class Type >
Type	getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result. More...

template<class Type >
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result from named object. More...

template<class Type >
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const
	Set result from named object, return true if set. More...

word	resultType (const word &entryName) const
	Retrieve the result type. More...

word	objectResultType (const word &objectName, const word &entryName) const
	Return the type of result. More...

wordList	objectResultEntries () const
	Retrieve the result entries. More...

wordList	objectResultEntries (const word &objectName) const
	Return result entries for named object. More...

void	writeResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

void	writeResultEntries (const word &objectName, Ostream &os) const
	Write the results entries for named object to stream. More...

void	writeAllResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)
	Construct from Time. More...

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

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

objectRegistry &	storedObjects ()

const objectRegistry &	storedObjects () const

Public Member Functions inherited from functionObject
	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix)
	Construct from components. More...

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

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

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

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

bool	useNamePrefix () const noexcept
	Return the flag for adding a scoping name prefix. More...

bool	useNamePrefix (bool on) noexcept
	Modify the flag for adding a scoping name prefix. More...

virtual bool	execute (const label subIndex)
	Execute using the specified subIndex. More...

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

virtual bool	adjustTimeStep ()
	Called at the end of Time::adjustDeltaT() if adjustTime is true. More...

virtual bool	filesModified () const
	Did any file get changed during execution? More...

virtual void	updateMesh (const mapPolyMesh &mpm)
	Update for changes of mesh. More...

virtual void	movePoints (const polyMesh &mesh)
	Update for changes of mesh. More...

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

Public Attributes inherited from functionObject
bool	log
	Flag to write log into Info. More...

Static Public Attributes inherited from functionObject
static int	debug
	Flag to execute debug content. More...

static bool	postProcess
	Global post-processing mode switch. More...

static bool	defaultUseNamePrefix
	Global default for useNamePrefix. More...

static word	outputPrefix
	Directory prefix. More...

Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const
	Return a const reference to the state dictionary. More...

functionObjects::properties &	stateDict ()
	Return non-const access to the state dictionary. More...

	stateFunctionObject (const stateFunctionObject &)=delete
	No copy construct. More...

void	operator= (const stateFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	Remove specified items from "functionObjectObjects". More...

	timeFunctionObject (const timeFunctionObject &)=delete
	No copy construct. More...

void	operator= (const timeFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
	Return a scoped (prefixed) name. More...

Protected Attributes inherited from timeFunctionObject
const Time &	time_
	Reference to the time database. More...

Detailed Description

Calculates the mass flux for surface film models.

Operands:

Operand	Type	Location
`input`	dictionary	constant/<surfaceFilmProperties>
`output` file	-	-
`output` field	surfaceScalarField	<time>/<filmRegion>/<outField>

Usage

Minimal example by using system/controlDict.functions:

filmFlux1
{
    // Mandatory entries (unmodifiable)
    type        filmFlux;

    // Optional entries (runtime modifiable)
    film        <surfaceFilmPropertiesDictionary>;
    result      <resultName>;

    // Optional (inherited) entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Dflt
`type`	Type name: filmFlux	word	yes	-
`film`	Name of surface film properties dictionary	dict	no	surfaceFilmProperties
`result`	Name of result field	word	no	filmFlux

The inherited entries are elaborated in:

stateFunctionObject.H

Usage by the postProcess utility is not available.

See also

Foam::functionObjects::stateFunctionObject

Source files

Definition at line 143 of file filmFlux.H.

Constructor & Destructor Documentation

◆ filmFlux() [1/2]

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

Construct from Time and dictionary.

Definition at line 56 of file filmFlux.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ filmFlux() [2/2]

filmFlux ( const filmFlux & )

delete

No copy construct.

◆ ~filmFlux()

virtual ~filmFlux ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "filmFlux" )

Runtime type information.

◆ operator=()

void operator= ( const filmFlux & )

delete

No copy assignment.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the field data.

Reimplemented from functionObject.

Definition at line 72 of file filmFlux.C.

References dict, and functionObject::read().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Execute.

Implements functionObject.

Definition at line 86 of file filmFlux.C.

References Foam::dimLength, Foam::dimMass, Foam::dimTime, filmMesh(), Foam::fvc::interpolate(), Foam::max(), IOobject::NO_READ, IOobject::NO_WRITE, phi, GeometricField< Type, PatchField, GeoMesh >::ref(), and Foam::Zero.

Here is the call graph for this function:

◆ write()

bool write ( )

virtual

Write the field.

Implements functionObject.

Definition at line 146 of file filmFlux.C.

References filmMesh(), and Foam::vtk::write().

Here is the call graph for this function:

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

src/regionModels/surfaceFilmModels/functionObjects/filmFlux/filmFlux.H
src/regionModels/surfaceFilmModels/functionObjects/filmFlux/filmFlux.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ filmFlux() [1/2]

◆ filmFlux() [2/2]

◆ ~filmFlux()

Member Function Documentation

◆ TypeName()

◆ operator=()

◆ read()

◆ execute()

◆ write()