A zoneGenerator which activates the zoneSet returned by the given zoneGenerator for a given period with optional repetition. More...

Inheritance diagram for periodic:

[legend]

Collaboration diagram for periodic:

[legend]

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

	periodic (const word &name, const polyMesh &mesh, const dictionary &dict)
	Construct from dictionary. More...

virtual	~periodic ()
	Destructor. More...

virtual zoneSet	generate () const
	Generate and return the zoneSet. More...

virtual zoneSet	movePoints () const
	Regenerate the zoneSet following mesh point motion. More...

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

	declareRunTimeSelectionTable (autoPtr, zoneGenerator, dictionary,(const word &name, const polyMesh &mesh, const dictionary &dict),(name, mesh, dict))

	zoneGenerator (const word &name, const polyMesh &mesh, const dictionary &dict)
	Construct from name, polyMesh and dictionary. More...

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

virtual	~zoneGenerator ()
	Destructor. More...

const word &	name () const
	Return the zoneGenerator name. More...

const word &	zoneName () const
	Return the zone name. More...

const polyMesh &	mesh () const
	Return reference to the polyMesh. More...

bool	moveUpdate () const
	Return true if the zoneGenerator updates any of the zones. More...

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

Additional Inherited Members
Static Public Member Functions inherited from zoneGenerator
static autoPtr< zoneGenerator >	New (const word &name, const polyMesh &mesh, const dictionary &dict)
	Select constructed from name, mesh and dictionary. More...

static autoPtr< zoneGenerator >	New (const word &name, const zoneTypes &zoneType, const polyMesh &mesh, const dictionary &dict)
	Select constructed from name, zoneType, mesh and dictionary. More...

static autoPtr< zoneGenerator >	New (const polyMesh &mesh, const dictionary &dict)
	Select constructed from mesh and first valid dictionary. More...

static labelList	indices (const boolList &selected)
	Return the list of selected indices. More...

Protected Attributes inherited from zoneGenerator
const word	name_
	Name of zone generator. More...

const dictionary	dict_
	Dictionary cached for error context. More...

const word	zoneName_
	Name of the zone (defaults to the name of the generator) More...

const polyMesh &	mesh_
	Reference to the polyMesh. More...

bool	moveUpdate_
	Switch to update the zones if the mesh points are moved. More...

Detailed Description

A zoneGenerator which activates the zoneSet returned by the given zoneGenerator for a given period with optional repetition.

Usage

Property	Description	Required	Default value
`type`	Type: periodic	yes
`begin`	Begin time for the zones	no	Time::beginTime()
`end`	End time for the zones	no	Time::endTime()
`repeat`	Repetition period	no
`deactivate`	Invert the activation logic	no	false

These options are followed by a single zoneGenerator specification.

Example of the specification for a periodic box cellZone in the constant/zonesGenerator file:

        box1
        {
            type    periodic;

            begin   0.001;
            end     0.002;
            repeat  0.002;

            box1
            {
                type        box;
                zoneType    cell;
                moveUpdate  true;

                min     (-0.0075 0 -1);
                max     (-0.003 0.0025 1);
            }
        }

Source files

Definition at line 116 of file periodic.H.

Constructor & Destructor Documentation

◆ periodic()

periodic	(	const word &	name,
		const polyMesh &	mesh,
		const dictionary &	dict
	)

Construct from dictionary.

Definition at line 78 of file periodic.C.

References zoneGenerator::moveUpdate_.

◆ ~periodic()

~periodic ( )

virtual

Destructor.

Definition at line 117 of file periodic.C.

Member Function Documentation

◆ TypeName()

TypeName ( "periodic" )

Runtime type information.

◆ generate()

Foam::zoneSet generate ( ) const

virtual

Generate and return the zoneSet.

Implements zoneGenerator.

Definition at line 123 of file periodic.C.

References zoneSet::clone(), zoneSet::cValid(), zoneSet::fValid(), List< bool >::null(), List< label >::null(), and zoneSet::pValid().

Here is the call graph for this function:

◆ movePoints()

Foam::zoneSet movePoints ( ) const

virtual

Regenerate the zoneSet following mesh point motion.

Reimplemented from zoneGenerator.

Definition at line 180 of file periodic.C.

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

src/meshTools/zoneGenerators/periodic/periodic.H
src/meshTools/zoneGenerators/periodic/periodic.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ periodic()

◆ ~periodic()

Member Function Documentation

◆ TypeName()

◆ generate()

◆ movePoints()