Provides options to set the velocity and flux fields as a function of time. More...

Inheritance diagram for setFlow:

Collaboration diagram for setFlow:

Public Member Functions
	TypeName ("setFlow")

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

	setFlow (const setFlow &)=delete

void	operator= (const setFlow &)=delete

virtual	~setFlow ()=default

virtual bool	read (const dictionary &dict)

virtual bool	execute ()

virtual bool	write ()

Public Member Functions inherited from fvMeshFunctionObject
	TypeName ("fvMeshFunctionObject")

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

	fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)

virtual	~fvMeshFunctionObject ()=default

Public Member Functions inherited from regionFunctionObject
	TypeName ("regionFunctionObject")

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

	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)

virtual	~regionFunctionObject ()=default

template<class ObjectType >
const ObjectType *	lookupObjectPtr (const word &fieldName) const

template<class ObjectType >
ObjectType *	lookupObjectRefPtr (const word &fieldName) const

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

virtual	~stateFunctionObject ()=default

dictionary &	propertyDict ()

bool	foundProperty (const word &entryName) const

void	clearTrigger ()

label	getTrigger () const

bool	setTrigger (const label triggeri, bool increaseOnly=true)

bool	getDict (const word &entryName, dictionary &dict) const

bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const

template<class Type >
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const

template<class Type >
bool	getProperty (const word &entryName, Type &value) const

template<class Type >
void	setProperty (const word &entryName, const Type &value)

template<class Type >
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const

template<class Type >
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const

template<class Type >
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)

template<class Type >
void	setResult (const word &entryName, const Type &value)

template<class Type >
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)

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

template<class Type >
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const

template<class Type >
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const

word	resultType (const word &entryName) const

word	objectResultType (const word &objectName, const word &entryName) const

wordList	objectResultEntries () const

wordList	objectResultEntries (const word &objectName) const

void	writeResultEntries (Ostream &os) const

void	writeResultEntries (const word &objectName, Ostream &os) const

void	writeAllResultEntries (Ostream &os) const

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)

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

Protected Member Functions inherited from fvMeshFunctionObject
	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete

void	operator= (const fvMeshFunctionObject &)=delete

Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry &	obr () const

template<class ObjectType >
bool	foundObject (const word &fieldName) const

template<class ObjectType >
const ObjectType *	cfindObject (const word &fieldName) const

template<class ObjectType >
const ObjectType *	findObject (const word &fieldName) const

template<class ObjectType >
ObjectType *	findObject (const word &fieldName)

template<class ObjectType >
ObjectType *	getObjectPtr (const word &fieldName) const

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName) const

template<class ObjectType >
bool	store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)

template<class ObjectType >
bool	storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr)

bool	writeObject (const word &fieldName)

bool	clearObject (const word &fieldName)

void	clearObjects (const wordList &objNames)

	regionFunctionObject (const regionFunctionObject &)=delete

void	operator= (const regionFunctionObject &)=delete

Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const

functionObjects::properties &	stateDict ()

	stateFunctionObject (const stateFunctionObject &)=delete

void	operator= (const stateFunctionObject &)=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 inherited from fvMeshFunctionObject
const fvMesh &	mesh_

Protected Attributes inherited from regionFunctionObject
word	subRegistryName_

const objectRegistry &	obr_

const objectRegistry *	obrPtr_

Protected Attributes inherited from timeFunctionObject
const Time &	time_

Detailed Description

Provides options to set the velocity and flux fields as a function of time.

Useful for testing advection behaviour of numerical schemes by e.g. imposing solid body rotation, vortex flows. All types include a scaling Function1 type enabling the strength of the transformation to vary as a function of time.

Operands:

Operand	Type	Location
`input`	{vol,surface}<Type>Field	$FOAM_CASE/<time>/<inpField>
`output` file	-	-
`output` field	{vol,surface}<Type>Field	$FOAM_CASE/<time>/<outField>

where <Type>=Scalar/Vector/SphericalTensor/SymmTensor/Tensor.

Usage

Minimal example by using system/controlDict.functions:

setFlow1
{
    // Mandatory entries (unmodifiable)
    type        setFlow;
    libs        (fieldFunctionObjects);

    // Mandatory entries (runtime modifiable)
    mode        rotation;
    scale       1;

    // Optional entries (runtime modifiable)
    U           U;
    rho         none;
    phi         phi;
    reverseTime 1;

    // When mode=function
    velocity    (1 0 0);

    // When mode=rotation
    omega       6.28318530718;
    origin      (0.5 0 0.5);
    refDir      (1 0 0);
    axis        (0 1 0);

    // When mode=(vortex2D|vortex3D)
    origin      (0.5 0 0.5);
    refDir      (1 0 0);
    axis        (0 1 0);

    // Optional (inherited) entries
    ...
}

where the entries mean:

Property	Description	Type	Req'd	Dflt
`type`	Type name: readFields	word	yes	-
`libs`	Library name: fieldFunctionObjects	word	yes	-
`mode`	Operating mode - see below	word	yes	-
`scale`	Scaling function	Function1<scalar>	yes	-
`U`	Name of velocity field	word	no	U
`rho`	Name of density field	word	no	none
`phi`	Name of flux field	word	no	phi
`reverseTime`	Specified time to reverse flow direction	scalar	no	VGREAT
`velocity`	Velocity function	Function1<vector>	conditional	-
`omega`	Rotational speed function	Function1<scalar>	conditional	-
`origin`	Rotation vector origin	vector	conditional	-
`refDir`	Rotation vector reference direction	vector	conditional	-
`axis`	Rotation vector axis	vector	conditional	-

Options for the mode entry:

      function
      rotation
      vortex2D
      vortex3D

The inherited entries are elaborated in:

functionObject.H

Usage by the postProcess utility is not available.

See also

Foam::functionObject
Foam::functionObjects::fvMeshFunctionObject
ExtendedCodeGuide::functionObjects::field::setFlow

Source files

Definition at line 268 of file setFlow.H.

Constructor & Destructor Documentation

◆ setFlow() [1/2]

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

Definition at line 94 of file setFlow.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ setFlow() [2/2]

setFlow ( const setFlow & )

delete

◆ ~setFlow()

virtual ~setFlow ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "setFlow" )

◆ operator=()

void operator= ( const setFlow & )

delete

◆ read()

bool read ( const dictionary & dict )

virtual

Reimplemented from regionFunctionObject.

Definition at line 118 of file setFlow.C.

References dict, Foam::endl(), Foam::Info, Foam::name(), Vector< Cmpt >::normalise(), and regionFunctionObject::read().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Implements functionObject.

Definition at line 192 of file setFlow.C.

References C::C(), Field::component(), GeometricField::component(), Cp, Foam::dimLength, Foam::dimVelocity, Foam::endl(), forAll, Foam::gMax(), Foam::Info, Log, Foam::mag(), Foam::name(), Foam::nl, phi, phic(), Foam::constant::mathematical::pi(), Field::replace(), s, Foam::sin(), Foam::sqr(), Foam::fvc::surfaceIntegrate(), U, Uf, x, Vector< scalar >::X, y, Vector< scalar >::Y, and Vector< scalar >::Z.

Here is the call graph for this function:

◆ write()

bool write ( )

virtual

Implements functionObject.

Definition at line 411 of file setFlow.C.

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

src/functionObjects/field/setFlow/setFlow.H
src/functionObjects/field/setFlow/setFlow.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ setFlow() [1/2]

◆ setFlow() [2/2]

◆ ~setFlow()

Member Function Documentation

◆ TypeName()

◆ operator=()

◆ read()

◆ execute()

◆ write()