Wrapper that clones the supplied function object for each region. More...

Inheritance diagram for multiRegion:

Collaboration diagram for multiRegion:

Public Member Functions
	TypeName ("multiRegion")

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

virtual	~multiRegion ()=default

virtual bool	read (const dictionary &dict)

virtual bool	execute ()

virtual bool	write ()

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

virtual	~timeFunctionObject ()=default

const Time &	time () const

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)

autoPtr< functionObject >	clone () const

virtual	~functionObject ()=default

virtual const word &	type () const =0

const word &	name () const noexcept

bool	useNamePrefix () const noexcept

bool	useNamePrefix (bool on) noexcept

virtual bool	execute (const label subIndex)

virtual bool	end ()

virtual bool	adjustTimeStep ()

virtual bool	filesModified () const

virtual void	updateMesh (const mapPolyMesh &mpm)

virtual void	movePoints (const polyMesh &mesh)

Protected Member Functions
	multiRegion (const multiRegion &)=delete

void	operator= (const multiRegion &)=delete

Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)

	timeFunctionObject (const timeFunctionObject &)=delete

void	operator= (const timeFunctionObject &)=delete

Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const

Protected Attributes
PtrList< functionObject >	functions_

Protected Attributes inherited from timeFunctionObject
const Time &	time_

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &runTime, const dictionary &dict)

Public Attributes inherited from functionObject
bool	log

Static Public Attributes inherited from functionObject
static int	debug

static bool	postProcess

static bool	defaultUseNamePrefix

static word	outputPrefix

Detailed Description

Wrapper that clones the supplied function object for each region.

Simplifies the setup of identical post-processing requirements for multi-region cases. Applies the supplied function to all regions by default.

Usage

Minimal example by using system/controlDict.functions:

multiRegion
{
    // Mandatory entries
    type    multiRegion;
    libs    (utilityFunctionObjects);

    function
    {
        // Actual object specification
        type    fieldMinMax;
        libs    (fieldFunctionObjects);
        fields  (<field1> ... <fieldN>);
    }

    // Optional entries
    regions     (region1 region2);
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`type`	Type name: multiRegion	word	yes	-
`libs`	Library name: utilityFunctionObjects	word	yes	-
`function`	Function object sub-dictionary	dict	yes	-
`regions`	List of region names	wordList	no	all