This function object calculates and outputs the second invariant of the velocity gradient tensor [1/s^2]. More...

Public Member Functions

 TypeName ("Q")
 Runtime type information. More...
 
 Q (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
 Construct for given objectRegistry and dictionary. More...
 
virtual ~Q ()
 Destructor. More...
 
virtual const wordname () const
 Return name of the set of Q. More...
 
virtual void read (const dictionary &)
 Read the Q 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 Q 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 and outputs the second invariant of the velocity gradient tensor [1/s^2].

\[ Q = 0.5(sqr(tr(\nabla U)) - tr(((\nabla U) \cdot (\nabla U)))) \]

Source files

Definition at line 66 of file Q.H.

Constructor & Destructor Documentation

Q ( 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 Q.C.

References Foam::dimless, Foam::dimTime, Foam::endl(), mesh, Foam::nl, sqr(), fvMesh::time(), Time::timeName(), Foam::type(), and WarningIn.

Here is the call graph for this function:

~Q ( )
virtual

Destructor.

Definition at line 101 of file Q.C.

Member Function Documentation

TypeName ( "Q"  )

Runtime type information.

virtual const word& name ( ) const
inlinevirtual

Return name of the set of Q.

Definition at line 118 of file Q.H.

void read ( const dictionary dict)
virtual

Read the Q data.

Definition at line 107 of file Q.C.

References dictionary::lookupOrDefault().

Here is the call graph for this function:

void execute ( )
virtual

Execute, currently does nothing.

Definition at line 116 of file Q.C.

References Foam::fvc::grad(), objectRegistry::lookupObject(), mesh, Foam::sqr(), Foam::tr(), Foam::type(), and U.

Here is the call graph for this function:

void end ( )
virtual

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

Definition at line 138 of file Q.C.

void timeSet ( )
virtual

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

Definition at line 147 of file Q.C.

void write ( )
virtual

Calculate the Q and write.

Definition at line 153 of file Q.C.

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

Referenced by molecule::writeFields().

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 139 of file Q.H.

virtual void movePoints ( const polyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 143 of file Q.H.


The documentation for this class was generated from the following files:
  • src/postProcessing/functionObjects/utilities/Q/Q.H
  • src/postProcessing/functionObjects/utilities/Q/Q.C