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

Perform noise analysis on surface-based pressure data. More...

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

Public Member Functions

 TypeName ("surfaceNoise")
 
 surfaceNoise (const dictionary &dict, const bool readFields=true)
 
virtual ~surfaceNoise ()=default
 
virtual bool read (const dictionary &dict)
 
virtual void calculate ()
 
- Public Member Functions inherited from noiseModel
 TypeName ("noiseModel")
 
 declareRunTimeSelectionTable (autoPtr, noiseModel, dictionary,(const dictionary &dict),(dict))
 
 noiseModel (const dictionary &dict, const bool readFields=true)
 
virtual ~noiseModel ()=default
 
tmp< Foam::scalarFieldPSD (const scalarField &PSDf) const
 
tmp< scalarFieldSPL (const scalarField &Prms2, const scalar f) const
 
tmp< scalarFieldSPL (const scalarField &Prms2, const scalarField &f) const
 
void cleanFFTW ()
 
void writeWeightings () const
 

Protected Member Functions

void initialise (const fileName &fName)
 
void readSurfaceData (const labelList &procFaceOffset, List< scalarField > &pData)
 
scalar writeSurfaceData (const fileName &outDirBase, const word &fName, const word &title, const scalar freq, const scalarField &data, const labelList &procFaceOffset, const bool writeSurface) const
 
scalar surfaceAverage (const scalarField &data, const labelList &procFaceOffset) const
 
- Protected Member Functions inherited from noiseModel
void readWriteOption (const dictionary &dict, const word &lookup, bool &option) const
 
scalar checkUniformTimeStep (const scalarList &times) const
 
bool validateBounds (const scalarList &p) const
 
label findStartTimeIndex (const instantList &allTimes, const scalar startTime) const
 
fileName baseFileDir (const label dataseti) const
 
tmp< scalarFielduniformFrequencies (const scalar deltaT, const bool check) const
 
tmp< scalarFieldoctaves (const scalarField &data, const scalarField &f, const labelUList &freqBandIDs) const
 
tmp< scalarFieldPf (const scalarField &p) const
 
tmp< scalarFieldmeanPf (const scalarField &p) const
 
tmp< scalarFieldRMSmeanPf (const scalarField &p) const
 
tmp< scalarFieldPSDf (const scalarField &p, const scalar deltaT) const
 
scalar RAf (const scalar f) const
 
scalar gainA (const scalar f) const
 
scalar RBf (const scalar f) const
 
scalar gainB (const scalar f) const
 
scalar RCf (const scalar f) const
 
scalar gainC (const scalar f) const
 
scalar RDf (const scalar f) const
 
scalar gainD (const scalar f) const
 

Protected Attributes

List< fileNameinputFileNames_
 
word pName_
 
label pIndex_
 
scalarList times_
 
scalar deltaT_
 
label startTimeIndex_
 
label nFace_
 
label fftWriteInterval_
 
bool areaAverage_
 
word readerType_
 
autoPtr< surfaceReaderreaderPtr_
 
autoPtr< surfaceWriterwriterPtr_
 
- Protected Attributes inherited from noiseModel
const dictionary dict_
 
scalar rhoRef_
 
label nSamples_
 
scalar fLower_
 
scalar fUpper_
 
scalar startTime_
 
autoPtr< windowModelwindowModelPtr_
 
word graphFormat_
 
weightingType SPLweighting_
 
scalar dBRef_
 
scalar minPressure_
 
scalar maxPressure_
 
fileName outputPrefix_
 
bool writePrmsf_
 
bool writeSPL_
 
bool writePSD_
 
bool writePSDf_
 
bool writeOctaves_
 
planInfo planInfo_
 

Additional Inherited Members

- Public Types inherited from noiseModel
enum  weightingType {
  none, dBA, dBB, dBC,
  dBD
}
 
- Static Public Member Functions inherited from noiseModel
static autoPtr< noiseModelNew (const dictionary &dict)
 
- Static Public Attributes inherited from noiseModel
static const Enum< weightingTypeweightingTypeNames_
 
- Static Protected Member Functions inherited from noiseModel
static void setOctaveBands (const scalarField &f, const scalar fLower, const scalar fUpper, const scalar octave, labelList &fBandIDs, scalarField &fCentre)
 

Detailed Description

Perform noise analysis on surface-based pressure data.

Input data is read from a dictionary, e.g.

// Pressure reference
pRef            0;

// Number of samples in sampling window, default = 2^16 (=65536)
N               4096;

// Lower frequency bounds
fl              25;

// Upper frequency bounds
fu              25;

// Start time
startTime       0;

windowModel     <modelType>
<modelType>Coeffs
{
    ...
}

// Input file
file            "postProcessing/faceSource1/surface/patch/patch.case";
//files           ("postProcessing/faceSource1/surface/patch/patch.case");

// Write interval for FFT data, default = 1
fftWriteInterval 100;

// Area-weighted averaging switch, default = no (ensemble) for backwards
// compatibility
areaAverage     yes;

// Surface reader
reader          ensight;

// Surface writer
writer          ensight;

// Collate times for ensight output - ensures geometry is only written once
writeOptions
{
    ensight
    {
        collateTimes true;
    }

    // Write Prmsf; default = yes
    writePrmsf  no;

    // Write SPL; default = yes
    writeSPL    yes;

    // Write PSD; default = yes
    writePSD    yes;

    // Write PSDf; default = yes
    writePSDf   no;

    // Write writeOctaves; default = yes
    writeOctaves yes;
}
Source files
See also
noiseModel.H

Definition at line 126 of file surfaceNoise.H.

Constructor & Destructor Documentation

◆ surfaceNoise()

surfaceNoise ( const dictionary dict,
const bool  readFields = true 
)

Definition at line 423 of file surfaceNoise.C.

References dict, surfaceNoise::read(), and Foam::readFields().

Here is the call graph for this function:

◆ ~surfaceNoise()

virtual ~surfaceNoise ( )
virtualdefault

Member Function Documentation

◆ initialise()

void initialise ( const fileName fName)
protected

◆ readSurfaceData()

void readSurfaceData ( const labelList procFaceOffset,
List< scalarField > &  pData 
)
protected

◆ writeSurfaceData()

scalar writeSurfaceData ( const fileName outDirBase,
const word fName,
const word title,
const scalar  freq,
const scalarField data,
const labelList procFaceOffset,
const bool  writeSurface 
) const
protected

◆ surfaceAverage()

scalar surfaceAverage ( const scalarField data,
const labelList procFaceOffset 
) const
protected

Definition at line 358 of file surfaceNoise.C.

References PstreamBuffers::finishedSends(), forAll, UPstream::master(), UPstream::nonBlocking, UPstream::parRun(), Pstream::scatter(), MeshedSurface::size(), UPstream::subProcs(), and Foam::sum().

Referenced by surfaceNoise::calculate().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ TypeName()

TypeName ( "surfaceNoise"  )

◆ read()

bool read ( const dictionary dict)
virtual

◆ calculate()

void calculate ( )
virtual

Member Data Documentation

◆ inputFileNames_

List<fileName> inputFileNames_
protected

Definition at line 136 of file surfaceNoise.H.

Referenced by surfaceNoise::calculate(), and surfaceNoise::read().

◆ pName_

word pName_
protected

Definition at line 139 of file surfaceNoise.H.

Referenced by surfaceNoise::initialise(), and surfaceNoise::read().

◆ pIndex_

label pIndex_
protected

Definition at line 142 of file surfaceNoise.H.

Referenced by surfaceNoise::initialise().

◆ times_

scalarList times_
protected

Definition at line 145 of file surfaceNoise.H.

Referenced by surfaceNoise::initialise().

◆ deltaT_

scalar deltaT_
protected

Definition at line 148 of file surfaceNoise.H.

Referenced by surfaceNoise::calculate(), and surfaceNoise::initialise().

◆ startTimeIndex_

label startTimeIndex_
protected

Definition at line 151 of file surfaceNoise.H.

Referenced by surfaceNoise::initialise().

◆ nFace_

label nFace_
protected

Definition at line 154 of file surfaceNoise.H.

Referenced by surfaceNoise::calculate(), and surfaceNoise::initialise().

◆ fftWriteInterval_

label fftWriteInterval_
protected

Definition at line 159 of file surfaceNoise.H.

Referenced by surfaceNoise::calculate(), and surfaceNoise::read().

◆ areaAverage_

bool areaAverage_
protected

Definition at line 163 of file surfaceNoise.H.

Referenced by surfaceNoise::read().

◆ readerType_

word readerType_
protected

Definition at line 166 of file surfaceNoise.H.

Referenced by surfaceNoise::initialise(), and surfaceNoise::read().

◆ readerPtr_

autoPtr<surfaceReader> readerPtr_
mutableprotected

Definition at line 169 of file surfaceNoise.H.

Referenced by surfaceNoise::initialise().

◆ writerPtr_

autoPtr<surfaceWriter> writerPtr_
mutableprotected

Definition at line 172 of file surfaceNoise.H.

Referenced by surfaceNoise::read().


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