Public Member Functions | List of all members
vorticity Class Reference

This function object calculates the vorticity, the curl of the velocity. More...

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 wordname () 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...
 

Detailed Description

This function object calculates the vorticity, the curl of the velocity.

Source files

Definition at line 58 of file vorticity.H.

Constructor & Destructor Documentation

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 Foam::dimless, Foam::dimTime, Foam::endl(), mesh, Foam::nl, IOobject::NO_READ, IOobject::NO_WRITE, Foam::read(), fvMesh::time(), Time::timeName(), WarningIn, and Vector< Cmpt >::zero.

Here is the call graph for this function:

~vorticity ( )
virtual

Destructor.

Definition at line 102 of file vorticity.C.

Member Function Documentation

TypeName ( "vorticity"  )

Runtime type information.

virtual const word& name ( ) const
inlinevirtual

Return name of the set of vorticity.

Definition at line 113 of file vorticity.H.

References vorticity::end(), vorticity::execute(), vorticity::read(), vorticity::timeSet(), and vorticity::write().

Here is the call graph for this function:

void read ( const dictionary dict)
virtual

Read the vorticity data.

Definition at line 108 of file vorticity.C.

References dictionary::lookupOrDefault().

Referenced by vorticity::name().

Here is the call graph for this function:

Here is the caller graph for this function:

void execute ( )
virtual

Execute, currently does nothing.

Definition at line 121 of file vorticity.C.

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

Referenced by vorticity::name().

Here is the call graph for this function:

Here is the caller graph for this function:

void end ( )
virtual

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

Definition at line 138 of file vorticity.C.

Referenced by vorticity::name().

Here is the caller graph for this function:

void timeSet ( )
virtual

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

Definition at line 147 of file vorticity.C.

Referenced by vorticity::name().

Here is the caller graph for this function:

void write ( )
virtual

Calculate the vorticity and write.

Definition at line 153 of file vorticity.C.

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

Referenced by vorticity::name().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void updateMesh ( const mapPolyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 134 of file vorticity.H.

virtual void movePoints ( const polyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 138 of file vorticity.H.


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