vorticity Class Reference

This function object calculates and outputs the vorticity, the curl of the velocity as a volvectorField. The field is stored on the mesh database so that it can be retrieved and used for other applications. More...

Collaboration diagram for vorticity:

Public Member Functions
	TypeName ("vorticity")
	Runtime type information. More...
	vorticity (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
	Construct for given objectRegistry and dictionary. More...
virtual	~vorticity ()
	Destructor. More...
virtual const word &	name () const
	Return name of the set of vorticity. More...
virtual void	read (const dictionary &)
	Read the vorticity data. More...
virtual void	execute ()
	Execute, currently does nothing. More...
virtual void	end ()
	Execute at the final time-loop, currently does nothing. More...
virtual void	timeSet ()
	Called when time was set at the end of the Time::operator++. More...
virtual void	write ()
	Calculate the vorticity and write. More...
virtual void	updateMesh (const mapPolyMesh &)
	Update for changes of mesh. More...
virtual void	movePoints (const polyMesh &)
	Update for changes of mesh. More...

Private Member Functions
	vorticity (const vorticity &)
	Disallow default bitwise copy construct. More...
void	operator= (const vorticity &)
	Disallow default bitwise assignment. More...

Private Attributes
word	name_
	Name of this set of vorticity objects. More...
const objectRegistry &	obr_
	Reference to the database. More...
bool	active_
	On/off switch. More...
word	UName_
	Name of velocity field, default is "U". More...
word	resultName_
	Name of vorticity field. More...
Switch	log_
	Switch to send output to Info as well as to file. More...

Detailed Description

This function object calculates and outputs the vorticity, the curl of the velocity as a volvectorField. The field is stored on the mesh database so that it can be retrieved and used for other applications.

Example of function object specification to calculate the vorticity:

vorticity1
{
    type        vorticity;
    functionObjectLibs ("libutilityFunctionObjects.so");
    ...
}

Function object usage

Property	Description	Required	Default value
type	Type name: vorticity	yes
UName	Name of velocity field	no	U
resultName	Name of Courant number field	no	<function name>
log	Log to standard output	no	yes

Source files

• vorticity.H
• vorticity.C
• IOvorticity.H

Definition at line 106 of file vorticity.H.

Constructor & Destructor Documentation

vorticity() [1/2]

vorticity ( const vorticity &  )

private

Disallow default bitwise copy construct.

vorticity() [2/2]

vorticity	(	const word &	name,
		const objectRegistry &	obr,
		const dictionary &	dict,
		const bool	loadFromFiles = false
	)

Construct for given objectRegistry and dictionary.

Allow the possibility to load fields from files

Definition at line 42 of file vorticity.C.

References dict, Foam::dimless, Foam::dimTime, Foam::endl(), mesh, Foam::nl, Foam::read(), and WarningInFunction.

Here is the call graph for this function:

~vorticity()

~vorticity ( )

virtual

Destructor.

Definition at line 95 of file vorticity.C.

Member Function Documentation

operator=()

void operator= ( const vorticity &  )

private

Disallow default bitwise assignment.

TypeName()

TypeName

(

"vorticity"

)

Runtime type information.

name()

virtual const word& name ( ) const

inlinevirtual

Return name of the set of vorticity.

Definition at line 164 of file vorticity.H.

References vorticity::name_.

Referenced by vorticity::write().

Here is the caller graph for this function:

read()

void read ( const dictionary &  dict )

virtual

Read the vorticity data.

Definition at line 101 of file vorticity.C.

References dict, and dictionary::readIfPresent().

Here is the call graph for this function:

execute()

void execute ( )

virtual

Execute, currently does nothing.

Definition at line 120 of file vorticity.C.

References Foam::fvc::curl(), and U.

Here is the call graph for this function:

end()

void end ( )

virtual

Execute at the final time-loop, currently does nothing.

Definition at line 137 of file vorticity.C.

timeSet()

void timeSet ( )

virtual

Called when time was set at the end of the Time::operator++.

Definition at line 143 of file vorticity.C.

write()

void write ( )

virtual

Calculate the vorticity and write.

Definition at line 149 of file vorticity.C.

References Foam::endl(), Foam::Info, vorticity::name(), Foam::nl, Foam::type(), and vorticity::write().

Referenced by vorticityWriter::write(), and vorticity::write().

Here is the call graph for this function:

Here is the caller graph for this function:

updateMesh()

virtual void updateMesh ( const mapPolyMesh &  )

inlinevirtual

Update for changes of mesh.

Definition at line 185 of file vorticity.H.

movePoints()

virtual void movePoints ( const polyMesh &  )

inlinevirtual

Update for changes of mesh.

Definition at line 189 of file vorticity.H.

Field Documentation

name_

word name_

private

Name of this set of vorticity objects.

Definition at line 111 of file vorticity.H.

Referenced by vorticity::name().

obr_

const objectRegistry& obr_

private

Reference to the database.

Definition at line 114 of file vorticity.H.

active_

bool active_

private

On/off switch.

Definition at line 117 of file vorticity.H.

UName_

word UName_

private

Name of velocity field, default is "U".

Definition at line 120 of file vorticity.H.

resultName_

word resultName_

private

Name of vorticity field.

Definition at line 123 of file vorticity.H.

log_

Switch log_

private

Switch to send output to Info as well as to file.

Definition at line 126 of file vorticity.H.

---

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

• src/postProcessing/functionObjects/utilities/vorticity/vorticity.H
• src/postProcessing/functionObjects/utilities/vorticity/vorticity.C