Public Member Functions | List of all members
proudmanAcousticPower Class Reference

Computes the acoustic power due to the volume of isotropic turbulence using Proudman's formula. More...

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

Public Member Functions

 TypeName ("proudmanAcousticPower")
 
 proudmanAcousticPower (const word &name, const Time &runTime, const dictionary &)
 
 proudmanAcousticPower (const proudmanAcousticPower &)=delete
 
void operator= (const proudmanAcousticPower &)=delete
 
virtual ~proudmanAcousticPower ()=default
 
virtual bool read (const dictionary &)
 
virtual bool execute ()
 
virtual bool write ()
 
- Public Member Functions inherited from fvMeshFunctionObject
 TypeName ("fvMeshFunctionObject")
 
 fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 
 fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
 
virtual ~fvMeshFunctionObject ()=default
 
- Public Member Functions inherited from regionFunctionObject
 TypeName ("regionFunctionObject")
 
 regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 
 regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
 
virtual ~regionFunctionObject ()=default
 
template<class ObjectType >
const ObjectType * lookupObjectPtr (const word &fieldName) const
 
template<class ObjectType >
ObjectType * lookupObjectRefPtr (const word &fieldName) const
 
- Public Member Functions inherited from stateFunctionObject
 stateFunctionObject (const word &name, const Time &runTime)
 
virtual ~stateFunctionObject ()=default
 
dictionarypropertyDict ()
 
bool foundProperty (const word &entryName) const
 
void clearTrigger ()
 
label getTrigger () const
 
bool setTrigger (const label triggeri, bool increaseOnly=true)
 
bool getDict (const word &entryName, dictionary &dict) const
 
bool getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
 
template<class Type >
Type getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
 
template<class Type >
bool getProperty (const word &entryName, Type &value) const
 
template<class Type >
void setProperty (const word &entryName, const Type &value)
 
template<class Type >
Type getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
 
template<class Type >
bool getObjectProperty (const word &objectName, const word &entryName, Type &value) const
 
template<class Type >
void setObjectProperty (const word &objectName, const word &entryName, const Type &value)
 
template<class Type >
void setResult (const word &entryName, const Type &value)
 
template<class Type >
void setObjectResult (const word &objectName, const word &entryName, const Type &value)
 
template<class Type >
Type getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
 
template<class Type >
Type getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
 
template<class Type >
bool getObjectResult (const word &objectName, const word &entryName, Type &value) const
 
word resultType (const word &entryName) const
 
word objectResultType (const word &objectName, const word &entryName) const
 
wordList objectResultEntries () const
 
wordList objectResultEntries (const word &objectName) const
 
void writeResultEntries (Ostream &os) const
 
void writeResultEntries (const word &objectName, Ostream &os) const
 
void writeAllResultEntries (Ostream &os) const
 
- Public Member Functions inherited from timeFunctionObject
 timeFunctionObject (const word &name, const Time &runTime)
 
virtual ~timeFunctionObject ()=default
 
const Timetime () const
 
objectRegistrystoredObjects ()
 
const objectRegistrystoredObjects () const
 
- 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)
 
autoPtr< functionObjectclone () const
 
virtual ~functionObject ()=default
 
virtual const wordtype () const =0
 
const wordname () const noexcept
 
bool useNamePrefix () const noexcept
 
bool useNamePrefix (bool on) noexcept
 
virtual bool execute (const label subIndex)
 
virtual bool end ()
 
virtual bool adjustTimeStep ()
 
virtual bool filesModified () const
 
virtual void updateMesh (const mapPolyMesh &mpm)
 
virtual void movePoints (const polyMesh &mesh)
 

Additional Inherited Members

- Static Public Member Functions inherited from functionObject
static autoPtr< functionObjectNew (const word &name, const Time &runTime, const dictionary &dict)
 
- Public Attributes inherited from functionObject
bool log
 
- Static Public Attributes inherited from functionObject
static int debug
 
static bool postProcess
 
static bool defaultUseNamePrefix
 
static word outputPrefix
 
- Protected Member Functions inherited from fvMeshFunctionObject
 fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
 
void operator= (const fvMeshFunctionObject &)=delete
 
- Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistryobr () const
 
template<class ObjectType >
bool foundObject (const word &fieldName) const
 
template<class ObjectType >
const ObjectType * cfindObject (const word &fieldName) const
 
template<class ObjectType >
const ObjectType * findObject (const word &fieldName) const
 
template<class ObjectType >
ObjectType * findObject (const word &fieldName)
 
template<class ObjectType >
ObjectType * getObjectPtr (const word &fieldName) const
 
template<class ObjectType >
const ObjectType & lookupObject (const word &fieldName) const
 
template<class ObjectType >
ObjectType & lookupObjectRef (const word &fieldName) const
 
template<class ObjectType >
bool store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
 
template<class ObjectType >
bool storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr)
 
bool writeObject (const word &fieldName)
 
bool clearObject (const word &fieldName)
 
void clearObjects (const wordList &objNames)
 
 regionFunctionObject (const regionFunctionObject &)=delete
 
void operator= (const regionFunctionObject &)=delete
 
- Protected Member Functions inherited from stateFunctionObject
const functionObjects::propertiesstateDict () const
 
functionObjects::propertiesstateDict ()
 
 stateFunctionObject (const stateFunctionObject &)=delete
 
void operator= (const stateFunctionObject &)=delete
 
- Protected Member Functions inherited from timeFunctionObject
void clearOutputObjects (const wordList &objNames)
 
 timeFunctionObject (const timeFunctionObject &)=delete
 
void operator= (const timeFunctionObject &)=delete
 
- Protected Member Functions inherited from functionObject
word scopedName (const word &name) const
 
- Protected Attributes inherited from fvMeshFunctionObject
const fvMeshmesh_
 
- Protected Attributes inherited from regionFunctionObject
word subRegistryName_
 
const objectRegistryobr_
 
const objectRegistryobrPtr_
 
- Protected Attributes inherited from timeFunctionObject
const Timetime_
 

Detailed Description

Computes the acoustic power due to the volume of isotropic turbulence using Proudman's formula.

The acoustic power, i.e. $ P_A $ [ $W/m^3$], in terms of turbulent kinetic energy, i.e. $ k $, and turbulent kinetic energy dissipation rate, i.e. $ \epsilon $, is given as:

\[ P_A = \alpha_\epsilon \rho \epsilon M_t^5 \]

where $ \alpha_\epsilon = 0.1 $ is a constant and

\[ M_t = \frac{\sqrt{2 k}}{a_0} \]

with $ a_0 $ the speed of sound. The acoustic power is also output in dB using:

\[ L_P = 10 \log \frac{P_A}{P_{ref}} \]

where $ P_{ref} = 1e^{-12} $ [ $W/m^3$] is a constant.

Operands:

Operand Type Location
input volScalarField $FOAM_CASE/<time>/<inpField>
output file - -
output field volScalarField $FOAM_CASE/<time>/<outField>
Usage
Minimal example by using system/controlDict.functions:
proudmanAcousticPower1
{
    // Mandatory entries (unmodifiable)
    type        proudmanAcousticPower;
    libs        (fieldFunctionObjects);

    // Optional entries (runtime modifiable)
    alphaEps    0.1;
    // For incompressible flow simulations
    rhoInf      1.225;
    aRef        340;
    // Turbulence field names (if not retrieved from the turb model)
    k           kMean;
    epsilon     epsilonMean;
    omega       none; // omegaMean

    // Optional (inherited) entries
    ...
}

where the entries mean:

Property Description Type Req'd Dflt
type Type name: proudmanAcousticPower word yes -
libs Library name: fieldFunctionObjects word yes -
rhoInf Freestream density (for incompressible) scalar conditional -
aRef Speed of sound (incompressible) scalar conditional -
alphaEps Empirical model coefficient scalar no 0.1
k Turbulence k field name word no none
epsilon Turbulence epsilon field name word no none
omega Turbulence omega field name word no none

The inherited entries are elaborated in:

Usage by the postProcess utility is not available.

Note
The freestream density and reference speed of sound are only necessary when a thermodynamics package is unavailable, typically for incompressible cases.
See also
Source files

Definition at line 212 of file proudmanAcousticPower.H.

Constructor & Destructor Documentation

◆ proudmanAcousticPower() [1/2]

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

Definition at line 140 of file proudmanAcousticPower.C.

References dict, Foam::dimless, Foam::dimPower, Foam::dimVolume, IOobject::NO_READ, IOobject::NO_WRITE, Foam::read(), and Foam::Zero.

Here is the call graph for this function:

◆ proudmanAcousticPower() [2/2]

◆ ~proudmanAcousticPower()

virtual ~proudmanAcousticPower ( )
virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "proudmanAcousticPower"  )

◆ operator=()

void operator= ( const proudmanAcousticPower )
delete

◆ read()

bool read ( const dictionary dict)
virtual

Reimplemented from regionFunctionObject.

Definition at line 198 of file proudmanAcousticPower.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::Info, Foam::name(), Foam::nl, regionFunctionObject::read(), and Foam::type().

Here is the call graph for this function:

◆ execute()

bool execute ( )
virtual

Implements functionObject.

Definition at line 252 of file proudmanAcousticPower.C.

References Foam::dimPower, Foam::dimVolume, Foam::constant::electromagnetic::e, epsilon, k, Foam::log10(), Foam::pow5(), and Foam::sqrt().

Here is the call graph for this function:

◆ write()

bool write ( )
virtual

Implements functionObject.

Definition at line 268 of file proudmanAcousticPower.C.

References Foam::endl(), Log, Foam::name(), Foam::nl, and Foam::type().

Here is the call graph for this function:

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