Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
wallShearStress Class Reference

This function object evaluates and outputs the shear stress at wall patches. The result is written as a volVectorField to time directories as field 'wallShearStress'. More...

Inheritance diagram for wallShearStress:
Inheritance graph
[legend]
Collaboration diagram for wallShearStress:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("wallShearStress")
 Runtime type information. More...
 
 wallShearStress (const word &name, const Time &runTime, const dictionary &)
 Construct from Time and dictionary. More...
 
virtual ~wallShearStress ()
 Destructor. More...
 
virtual bool read (const dictionary &)
 Read the wallShearStress data. More...
 
virtual bool execute ()
 Calculate the wall shear-stress. More...
 
virtual bool write ()
 Write the wall shear-stress. More...
 
- Public Member Functions inherited from writeFiles
 writeFiles (const word &name, const Time &time, const dictionary &dict, const word &prefix)
 Construct from name, Time, dictionary and prefix. More...
 
 writeFiles (const word &name, const objectRegistry &obr, const dictionary &dict, const word &prefix)
 Construct from name, objectRegistry, dictionary and prefix. More...
 
virtual ~writeFiles ()
 Destructor. More...
 
const wordListnames () const
 Return const access to the names. More...
 
OFstreamfile ()
 Return access to the file (if only 1) More...
 
PtrList< OFstream > & files ()
 Return access to the files. More...
 
OFstreamfile (const label i)
 Return file 'i'. More...
 
- Public Member Functions inherited from writeFile
 writeFile (const word &name, const Time &t, const dictionary &dict, const word &prefix)
 Construct from name, Time, dictionary and prefix. More...
 
 writeFile (const word &name, const objectRegistry &obr, const dictionary &dict, const word &prefix)
 Construct from name, objectRegistry, dictionary and prefix. More...
 
virtual ~writeFile ()
 Destructor. More...
 
void writeCommented (Ostream &os, const string &str) const
 Write a commented string to stream. More...
 
void writeTabbed (Ostream &os, const string &str) const
 Write a tabbed string to stream. More...
 
void writeHeader (Ostream &os, const string &str) const
 Write a commented header to stream. More...
 
void writeTime (Ostream &os) const
 Write the current time to stream. More...
 
template<class Type >
void writeHeaderValue (Ostream &os, const string &property, const Type &value) const
 Write a (commented) header property and value pair. More...
 
label charWidth () const
 Return width of character stream output. 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 ()
 Destructor. More...
 
- Public Member Functions inherited from functionObject
virtual const wordtype () const =0
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))
 
 functionObject (const word &name)
 Construct from components. More...
 
autoPtr< functionObjectclone () const
 Return clone. More...
 
virtual ~functionObject ()
 Destructor. More...
 
const wordname () const
 Return the name of this functionObject. 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 void updateMesh (const mapPolyMesh &mpm)
 Update for changes of mesh. More...
 
virtual void movePoints (const polyMesh &mesh)
 Update for changes of mesh. More...
 

Protected Member Functions

virtual void writeFileHeader (const label i)
 File header information. More...
 
void calcShearStress (const fvMesh &mesh, const volSymmTensorField &Reff, volVectorField &shearStress)
 Calculate the shear stress. More...
 
- Protected Member Functions inherited from writeFiles
virtual void createFiles ()
 Create the output file. More...
 
virtual void resetNames (const wordList &names)
 Reset the list of names from a wordList. More...
 
virtual void resetName (const word &name)
 Reset the list of names to a single name entry. More...
 
 writeFiles (const writeFiles &)
 Disallow default bitwise copy construct. More...
 
void operator= (const writeFiles &)
 Disallow default bitwise assignment. More...
 
- Protected Member Functions inherited from writeFile
virtual void initStream (Ostream &os) const
 Initialise the output stream for writing. More...
 
virtual fileName baseFileDir () const
 Return the base directory for output. More...
 
virtual fileName baseTimeDir () const
 Return the base directory for the current time value. More...
 
virtual Omanip< int > valueWidth (const label offset=0) const
 Return the value width when writing to stream with optional offset. More...
 
 writeFile (const writeFile &)
 Disallow default bitwise copy construct. More...
 
void operator= (const writeFile &)
 Disallow default bitwise assignment. More...
 
- Protected Member Functions inherited from regionFunctionObject
template<class ObjectType >
bool foundObject (const word &fieldName) const
 Find field in the objectRegistry. More...
 
template<class ObjectType >
const ObjectType & lookupObject (const word &fieldName) const
 Lookup field from the objectRegistry. More...
 
template<class ObjectType >
bool store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
 Store the given field in the objectRegistry under the given name. More...
 
bool writeObject (const word &fieldName)
 Write field if present in objectRegistry. More...
 
bool clearObject (const word &fieldName)
 Clear field from the objectRegistry if present. More...
 

Protected Attributes

labelHashSet patchSet_
 Optional list of patches to process. More...
 
- Protected Attributes inherited from writeFile
const word prefix_
 Prefix. More...
 
- Protected Attributes inherited from regionFunctionObject
const Timetime_
 Reference to the Time. More...
 
const objectRegistryobr_
 Reference to the region objectRegistry. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from functionObject
static autoPtr< functionObjectNew (const word &name, const Time &, const dictionary &)
 Select from dictionary, based on its "type" entry. More...
 
- Public Attributes inherited from functionObject
Switch log
 Switch write log to Info. More...
 
- Static Public Attributes inherited from writeFile
static const word outputPrefix
 Directory prefix. More...
 
static label addChars = 7
 Additional characters for writing. More...
 
- Static Public Attributes inherited from functionObject
static int debug
 
static bool postProcess
 Global post-processing mode switch. More...
 

Detailed Description

This function object evaluates and outputs the shear stress at wall patches. The result is written as a volVectorField to time directories as field 'wallShearStress'.

\[ Stress = R \dot n \]

where

$ R $ = stress tensor
$ n $ = patch normal vector (into the domain)

The shear stress (symmetrical) tensor field is retrieved from the turbulence model. All wall patches are included by default; to restrict the calculation to certain patches, use the optional 'patches' entry.

Example of function object specification:

    wallShearStress1
    {
        type        wallShearStress;
        libs ("libfieldFunctionObjects.so");
        ...
        patches     (".*Wall");
    }
Usage
Property Description Required Default value
type type name: wallShearStress yes
patches list of patches to process no all wall patches
See also
Foam::functionObject Foam::functionObjects::writeFiles Foam::functionObjects::pressureTools Foam::functionObjects::timeControl
Source files

Definition at line 122 of file wallShearStress.H.

Constructor & Destructor Documentation

wallShearStress ( const word name,
const Time runTime,
const dictionary dict 
)

Construct from Time and dictionary.

Definition at line 84 of file wallShearStress.C.

References Foam::dimLength, Foam::dimTime, Foam::exit(), Foam::FatalError, FatalErrorInFunction, mesh, IOobject::NO_READ, IOobject::NO_WRITE, Foam::read(), Foam::sqr(), fvMesh::time(), Time::timeName(), Foam::type(), and Foam::Zero.

Here is the call graph for this function:

~wallShearStress ( )
virtual

Destructor.

Definition at line 132 of file wallShearStress.C.

Member Function Documentation

void writeFileHeader ( const label  i)
protectedvirtual

File header information.

Reimplemented from writeFile.

Definition at line 48 of file wallShearStress.C.

References wallShearStress::calcShearStress(), and Foam::endl().

Here is the call graph for this function:

void calcShearStress ( const fvMesh mesh,
const volSymmTensorField Reff,
volVectorField shearStress 
)
protected

Calculate the shear stress.

Definition at line 61 of file wallShearStress.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), forAllConstIter(), fvMesh::magSf(), patchi, and fvMesh::Sf().

Referenced by wallShearStress::writeFileHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeName ( "wallShearStress"  )

Runtime type information.

bool read ( const dictionary dict)
virtual
bool execute ( )
virtual

Calculate the wall shear-stress.

Implements functionObject.

Definition at line 194 of file wallShearStress.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, objectRegistry::foundObject(), objectRegistry::lookupObject(), turbulenceModel::propertiesName, and Foam::type().

Here is the call graph for this function:

bool write ( )
virtual

Member Data Documentation

labelHashSet patchSet_
protected

Optional list of patches to process.

Definition at line 131 of file wallShearStress.H.


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