Generates, registers and optionally writes the zoneSet generated by a zoneGenerator. More...

Inheritance diagram for generateZone:

Collaboration diagram for generateZone:

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

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

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

virtual	~generateZone ()
	Destructor. More...

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

virtual bool	execute ()
	Remove the registered objects. More...

virtual bool	write ()
	Do nothing. More...

void	operator= (const generateZone &)=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)
	Construct from the region objectRegistry. More...

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

virtual	~fvMeshFunctionObject ()
	Destructor. More...

const fvMesh &	mesh () const
	Return a reference to the mesh. 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)
	Construct from the region objectRegistry. 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 objectRegistryFunctionObject
	TypeName ("objectRegistryFunctionObject")
	Runtime type information. More...

	objectRegistryFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from an objectRegistry and dictionary. More...

	objectRegistryFunctionObject (const word &name, const objectRegistry &obr)
	Construct from an objectRegistry. More...

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

virtual	~objectRegistryFunctionObject ()
	Destructor. More...

virtual bool	read (const dictionary &)
	Read optional controls. More...

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

	functionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from dictionary. 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 scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. 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 execute at start time. More...

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

Protected Member Functions inherited from objectRegistryFunctionObject
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...

void	cannotFindObjects (const wordList &fieldNames)
	Prints a warning message that fieldNames 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 >
ObjectType &	store (const tmp< ObjectType > &tfield)
	Store the given field in the objectRegistry. More...

template<class ObjectType >
ObjectType &	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 objectRegistryFunctionObject
const objectRegistry &	obr_
	Reference to the objectRegistry. More...

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

Detailed Description

Generates, registers and optionally writes the zoneSet generated by a zoneGenerator.

Usage

Property	Description	Required	Default value
`type`	type name: generateZone	yes
`zone`	zoneGenerator specification	yes

Example of a functionObjects::generateZone which creates a cellZone named kZone of the cells in which the value of the turbulent kinetic energy is within the highest 10% and then functionObjects::volFieldValue is used to average the velocity within this zone:

    kZone
    {
        type generateZone;

        libs        ("libutilityFunctionObjects.so");

        executeControl  writeTime;
        writeControl    writeTime;

        zone
        {
            type coded;

            code
            #{
                // Lookup field from the objectRegistry, e.g. k
                const volScalarField& k =
                    mesh().lookupObject<volScalarField>("k");

                // Calculate the minimum and maximum k values
                const scalar mink = min(k).value();
                const scalar maxk = max(k).value();

                // Fraction of the range of k
                const scalar f = 0.1;

                // Lowest k in selection
                const scalar lowk = f*mink + (1.0 - f)*maxk;

                cellIndices = selectIndices
                (
                    k,
                    [&](const scalar k)
                    {
                        return k > lowk;
                    }
                );
            #};
        }
    }

    UAverage
    {
        type            volFieldValue;

        libs            ("libfieldFunctionObjects.so");

        executeControl  writeTime;
        writeControl    writeTime;

        writeFields     no;

        cellZone        kZone;

        operation       volAverage;

        fields          (U);
    }

See also: Foam::functionObject

Source files

Definition at line 142 of file generateZone.H.

Constructor & Destructor Documentation

◆ generateZone() [1/2]

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

Construct from Time and dictionary.

Definition at line 45 of file generateZone.C.

◆ generateZone() [2/2]

generateZone ( const generateZone & )

delete

Disallow default bitwise copy construction.

◆ ~generateZone()

~generateZone ( )

virtual

Destructor.

Definition at line 61 of file generateZone.C.

Member Function Documentation

◆ TypeName()

TypeName ( "generateZone" )

Runtime type information.

◆ fields()

virtual wordList fields ( ) const

inlinevirtual

Return the list of fields required.

Implements functionObject.

Definition at line 179 of file generateZone.H.

References List< word >::null().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Remove the registered objects.

Implements functionObject.

Definition at line 67 of file generateZone.C.

◆ write()

bool write ( )

virtual

Do nothing.

Implements functionObject.

Definition at line 74 of file generateZone.C.

References polyMesh::cellZones(), mesh, IOobject::updateTimeInstance(), and regIOobject::write().

Here is the call graph for this function:

◆ operator=()

void operator= ( const generateZone & )

delete

Disallow default bitwise assignment.

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

src/functionObjects/utilities/generateZone/generateZone.H
src/functionObjects/utilities/generateZone/generateZone.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ generateZone() [1/2]

◆ generateZone() [2/2]

◆ ~generateZone()

Member Function Documentation

◆ TypeName()

◆ fields()

◆ execute()

◆ write()

◆ operator=()