Creates a relative velocity field for rotating cases. The rotation can be 'specified', reference a 'MRF' or even solid body motion with a rotatingMotion (cellZones only). More...

Inheritance diagram for relativeVelocityFunctionObject:

[legend]

Collaboration diagram for relativeVelocityFunctionObject:

[legend]

Public Types
enum	backgroundMode { ZERO, SPECIFIED, COPY }
	Enumeration for the initial background velocity field. More...

enum	rotationMode { SPECIFIED, MRF, SOLID_BODY_ROTATION }
	Enumeration for the tyoe of rotation specification. More...

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

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

	relativeVelocityFunctionObject (const relativeVelocityFunctionObject &)=delete
	No copy construct. More...

void	operator= (const relativeVelocityFunctionObject &)=delete
	No copy assignment. More...

virtual	~relativeVelocityFunctionObject ()=default
	Destructor. More...

virtual bool	read (const dictionary &dict)
	Read the function-object dictionary. More...

virtual bool	execute ()
	Calculate/update the relative velocity field. More...

virtual bool	write ()
	Write the relative velocity field (if it exists) 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...

virtual	~fvMeshFunctionObject ()=default
	Destructor. 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...

virtual	~regionFunctionObject ()=default
	Destructor. More...

template<class ObjectType >
const ObjectType *	lookupObjectPtr (const word &fieldName) const
	Deprecated(2018-10) More...

template<class ObjectType >
ObjectType *	lookupObjectRefPtr (const word &fieldName) const
	Deprecated(2018-10) More...

Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)
	Construct from components. More...

virtual	~stateFunctionObject ()=default
	Destructor. More...

dictionary &	propertyDict ()
	Return access to the property dictionary. More...

bool	foundProperty (const word &entryName) const
	Return true if the property exists. More...

void	clearTrigger ()
	Remove the trigger index from the properties. More...

label	getTrigger () const
	Get the current trigger index. More...

bool	setTrigger (const label triggeri)
	Set new trigger index. More...

bool	getDict (const word &entryName, dictionary &dict) const
	Set dictionary, return true if set. More...

bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
	Set dictionary from named object, return true if set. More...

template<class Type >
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property. More...

template<class Type >
bool	getProperty (const word &entryName, Type &value) const
	Set generic property, return true if set. More...

template<class Type >
void	setProperty (const word &entryName, const Type &value)
	Add generic property. More...

template<class Type >
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from named object. More...

template<class Type >
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const
	Set generic property from named object, return true if set. More...

template<class Type >
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)
	Add generic property from named object. More...

bool	getObjectResultDict (const word &objectName, dictionary &dict) const

template<class Type >
void	setResult (const word &entryName, const Type &value)
	Add result. More...

template<class Type >
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)
	Add result from named object. More...

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

template<class Type >
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result from named object. More...

template<class Type >
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const
	Set result from named object, return true if set. More...

word	resultType (const word &entryName) const
	Retrieve the result type. More...

word	objectResultType (const word &objectName, const word &entryName) const
	Return the type of result. More...

wordList	objectResultEntries () const
	Retrieve the result entries. More...

wordList	objectResultEntries (const word &objectName) const
	Return result entries for named object. More...

void	writeResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

void	writeResultEntries (const word &objectName, Ostream &os) const
	Write the results entries for named object to stream. More...

void	writeAllResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

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

virtual	~timeFunctionObject ()=default
	Destructor. More...

const Time &	time () const
	Return time database. More...

objectRegistry &	storedObjects ()
	Write access to the output objects ("functionObjectObjects") registered on Time. More...

const objectRegistry &	storedObjects () const
	Const access to the output objects ("functionObjectObjects") registered on Time. More...

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)
	Construct from components. More...

autoPtr< functionObject >	clone () const
	Return clone. More...

virtual	~functionObject ()=default
	Destructor. More...

virtual const word &	type () const =0
	Runtime type information. More...

const word &	name () const noexcept
	Return the name of this functionObject. More...

bool	useNamePrefix () const noexcept
	Return the flag for adding a scoping name prefix. More...

bool	useNamePrefix (bool on) noexcept
	Modify the flag for adding a scoping name prefix. More...

virtual bool	execute (const label subIndex)
	Execute using the specified subIndex. More...

virtual bool	end ()
	Called when Time::run() determines that the time-loop exits. More...

virtual bool	adjustTimeStep ()
	Called at the end of Time::adjustDeltaT() if adjustTime is true. More...

virtual bool	filesModified () const
	Did any file get changed during execution? More...

virtual void	updateMesh (const mapPolyMesh &mpm)
	Update for changes of mesh. More...

virtual void	movePoints (const polyMesh &mesh)
	Update for changes of mesh. More...

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &runTime, const dictionary &dict)
	Select from dictionary, based on its "type" entry. More...

Public Attributes inherited from functionObject
bool	log
	Flag to write log into Info. More...

Static Public Attributes inherited from functionObject
static int	debug
	Flag to execute debug content. More...

static bool	postProcess
	Global post-processing mode switch. More...

static bool	defaultUseNamePrefix
	Global default for useNamePrefix. More...

static word	outputPrefix
	Directory prefix. More...

Protected Member Functions inherited from fvMeshFunctionObject
	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	No copy construct. More...

void	operator= (const fvMeshFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry &	obr () const
	The region or sub-region registry being used. More...

template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find object (eg, a field) in the (sub) objectRegistry. More...

template<class ObjectType >
const ObjectType *	cfindObject (const word &fieldName) const
	Return const pointer to the object (eg, a field) in the (sub) objectRegistry. More...

template<class ObjectType >
const ObjectType *	findObject (const word &fieldName) const
	Return const pointer to the object (eg, a field) in the (sub) objectRegistry. More...

template<class ObjectType >
ObjectType *	findObject (const word &fieldName)
	Return non-const pointer to the object of the given Type, (sub) objectRegistry. More...

template<class ObjectType >
ObjectType *	getObjectPtr (const word &fieldName) const
	Return non-const pointer to the object of the given Type, using a const-cast to have it behave like a mutable. More...

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry. More...

template<class ObjectType >
bool	store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
	Store the field in the (sub) objectRegistry under the given name. More...

template<class ObjectType >
bool	storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr)
	Store the field in an optional objectRegistry under the given name. More...

bool	writeObject (const word &fieldName)
	Write field if present in the (sub) objectRegistry. More...

bool	clearObject (const word &fieldName)
	Clear field from the (sub) objectRegistry if present. More...

void	clearObjects (const wordList &objNames)
	Clear fields from the (sub) objectRegistry if present. More...

	regionFunctionObject (const regionFunctionObject &)=delete
	No copy construct. More...

void	operator= (const regionFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const
	Return a const reference to the state dictionary. More...

functionObjects::properties &	stateDict ()
	Return non-const access to the state dictionary. More...

	stateFunctionObject (const stateFunctionObject &)=delete
	No copy construct. More...

void	operator= (const stateFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	Remove specified items from "functionObjectObjects". More...

	timeFunctionObject (const timeFunctionObject &)=delete
	No copy construct. More...

void	operator= (const timeFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
	Return a scoped (prefixed) name. More...

Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
	Reference to the fvMesh. More...

Protected Attributes inherited from regionFunctionObject
word	subRegistryName_
	Name for alternative object registry. More...

const objectRegistry &	obr_
	Reference to the region objectRegistry. More...

const objectRegistry *	obrPtr_
	Pointer to alternative (eg, sub-region) objectRegistry. More...

Protected Attributes inherited from timeFunctionObject
const Time &	time_
	Reference to the time database. More...

Detailed Description

Creates a relative velocity field for rotating cases. The rotation can be 'specified', reference a 'MRF' or even solid body motion with a rotatingMotion (cellZones only).

Usage

Minimal example:

relative
{
    // Mandatory entries
    type        relativeVelocity;
    libs        (fieldFunctionObjects);

    // Optional entries
    U           UMean;
    result      U_rel;

    // mandatory
    rotationMode    specified;  // specified | MRF | solidBodyRotation

    specified   // single zone
    {
        origin  (0 -0.1 0);
        axis    (0 1 0);
        rpm     25;
        zone    ...;  // optional
    }
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`type`	Type name: relativeVel	word	yes	-
`libs`	Library name: fieldFunctionObjects	word	yes	-
`U`	The input velocity field name	word	no	U
`result`	The output field name	word	no	U_relative
`rotationMode`	Rotation mode (see below)	word	yes
`backgroundMode`	Background velocity type (see below)	word	no	zero
`refVelocity`	Velocity for 'specified' background	vector	cndtnl
`specified`	Coefficient dictionary for 'specified'	dict	cndtnl

The rotationMode can be (specified | MRF | solidBodyRotation). For (MRF | solidBodyRotation) modes, the corresponding models provide sufficient information.

For the specified mode, the user can specify a single, flat "specified" dictionary with the following contents:

Property	Description	Type	Reqd
`origin`	The rotation origin	vector	yes*
`axis`	The rotation axis	vector	yes*
`omega`	The rotation speed (rad/s)	scalar	yes*
`rpm`	The rotation speed (rev/min)	scalar	yes*
`n`	The rotation speed (rev/s)	scalar	yes*
`zone`	The cellZone selector	wordRe	no

Alternatively, in specified mode, the user can specify multiple regions using a dictionary of dictionaries. For example,

    specified   // multi-zone
    {
        inside
        {
            origin  (0 -0.1 0);
            axis    (0 1 0);
            rpm     25;
            zone    inner;   //< The zone name
        }
        ".*Outer"   //< The zone name
        {
            origin  (0 -0.1 0);
            axis    (0 1 0);
            rpm     -50;
        }
    }

The background velocity is initialized based on the backgroundMode (zero | copy | specified):

zero : zero velocity for the background
specified : refVelocity for the background
copy : copy from input field

The inherited entries are elaborated in:

functionObject.H

Source files

Definition at line 248 of file relativeVelocityFunctionObject.H.

Member Enumeration Documentation

◆ backgroundMode

enum backgroundMode

strong

Enumeration for the initial background velocity field.

Enumerator
ZERO	zero velocity for the background
SPECIFIED	refVelocity for the background
COPY	copy from input field

Definition at line 259 of file relativeVelocityFunctionObject.H.

◆ rotationMode

enum rotationMode

strong

Enumeration for the tyoe of rotation specification.

Enumerator
SPECIFIED	user-specified rotations
MRF	rotations from MRF zones
SOLID_BODY_ROTATION	rotations from solidBodyMotion

Definition at line 269 of file relativeVelocityFunctionObject.H.

Constructor & Destructor Documentation

◆ relativeVelocityFunctionObject() [1/2]

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

Construct from name, Time and dictionary.

◆ relativeVelocityFunctionObject() [2/2]

relativeVelocityFunctionObject ( const relativeVelocityFunctionObject & )

delete

No copy construct.

◆ ~relativeVelocityFunctionObject()

virtual ~relativeVelocityFunctionObject ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "relativeVelocity" )

Runtime type information.

◆ operator=()

void operator= ( const relativeVelocityFunctionObject & )

delete

No copy assignment.

◆ read()

virtual bool read ( const dictionary & dict )

virtual

Read the function-object dictionary.

Reimplemented from regionFunctionObject.

◆ execute()

virtual bool execute ( )

virtual

Calculate/update the relative velocity field.

Implements functionObject.

◆ write()

virtual bool write ( )

virtual

Write the relative velocity field (if it exists)

Implements functionObject.

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

src/functionObjects/field/relativeVelocity/relativeVelocityFunctionObject.H

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ backgroundMode

◆ rotationMode

Constructor & Destructor Documentation

◆ relativeVelocityFunctionObject() [1/2]

◆ relativeVelocityFunctionObject() [2/2]

◆ ~relativeVelocityFunctionObject()

Member Function Documentation

◆ TypeName()

◆ operator=()

◆ read()

◆ execute()

◆ write()