This functionObject writes the phase-fraction map field alpha.map with incremental value ranges for each phase e.g., with values 0 for water, 1 for air, 2 for oil etc. More...

Inheritance diagram for phaseMap:

[legend]

Collaboration diagram for phaseMap:

[legend]

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

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

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

virtual	~phaseMap ()
	Destructor. More...

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

virtual bool	execute ()
	Calculate the force fields. More...

virtual bool	write ()
	Write the force fields. More...

void	operator= (const phaseMap &)=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...

virtual bool	read (const dictionary &)
	Read optional controls. 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...

Protected Attributes
const phaseSystem::phaseModelList &	phases_
	Constant access to phases. 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...

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

Detailed Description

This functionObject writes the phase-fraction map field alpha.map with incremental value ranges for each phase e.g., with values 0 for water, 1 for air, 2 for oil etc.

Example of function object specification:

phaseMap
{
    type            phaseMap;
    libs            ("libmultiphaseEulerFoamFunctionObjects.so");
    writeControl    writeTime;
}

Usage

Property	Description	Required	Default value
`type`	type name: phaseMap	yes

See also: Foam::functionObjects::fvMeshFunctionObject Foam::functionObject

Source files

Definition at line 83 of file phaseMap.H.

Constructor & Destructor Documentation

◆ phaseMap() [1/2]

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

Construct from Time and dictionary.

Definition at line 43 of file phaseMap.C.

◆ phaseMap() [2/2]

phaseMap ( const phaseMap & )

delete

Disallow default bitwise copy construction.

◆ ~phaseMap()

~phaseMap ( )

virtual

Destructor.

Definition at line 60 of file phaseMap.C.

Member Function Documentation

◆ TypeName()

TypeName ( "phaseMap" )

Runtime type information.

◆ fields()

virtual wordList fields ( ) const

inlinevirtual

Return the list of fields required.

Implements functionObject.

Definition at line 122 of file phaseMap.H.

References List< word >::null().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Calculate the force fields.

Implements functionObject.

Definition at line 66 of file phaseMap.C.

◆ write()

bool write ( )

virtual

Write the force fields.

Implements functionObject.

Definition at line 72 of file phaseMap.C.

References IOobject::AUTO_WRITE, Foam::dimless, forAll, IOobject::groupName(), IOobject::NO_READ, and phaseMap::write().

Referenced by phaseMap::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

void operator= ( const phaseMap & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ phases_

const phaseSystem::phaseModelList& phases_

protected

Constant access to phases.

Definition at line 92 of file phaseMap.H.

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ phaseMap() [1/2]

◆ phaseMap() [2/2]

◆ ~phaseMap()

Member Function Documentation

◆ TypeName()

◆ fields()

◆ execute()

◆ write()

◆ operator=()

Member Data Documentation

◆ phases_