Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
correlationFunction< Type > Class Template Reference

Public Types

typedef pTraits< Type >::cmptType cmptType
 Component type. More...
 

Public Member Functions

 correlationFunction (const polyMesh &, const dictionary &, const label tZeroBufferSize)
 Construct from dictionary. More...
 
 correlationFunction (const polyMesh &, const label tZeroBufferSize, const scalar duration, const scalar sampleInterval, const scalar averagingInterval)
 Construct from components. More...
 
 ~correlationFunction ()
 Destructor. More...
 
void calculateCorrelationFunction (const Field< Type > &)
 
void calculateCorrelationFunction (const Type &)
 
scalar integral () const
 
bool writeAveraged (Ostream &) const
 
const Field< Field< Type > > & tZeroBuffers () const
 
scalar duration () const
 
scalar sampleInterval () const
 
scalar averagingInterval () const
 
label sampleSteps () const
 
label measurandFieldSize () const
 

Static Public Attributes

static const char *const typeName
 

Friends

Ostream & operator (Ostream &, const correlationFunction< Type > &)
 

Detailed Description

template<class Type>
class Foam::correlationFunction< Type >

Source files

Definition at line 49 of file correlationFunction.H.

Member Typedef Documentation

◆ cmptType

typedef pTraits<Type>::cmptType cmptType

Component type.

Definition at line 94 of file correlationFunction.H.

Constructor & Destructor Documentation

◆ correlationFunction() [1/2]

correlationFunction ( const polyMesh &  mesh,
const dictionary &  dict,
const label  tZeroBufferSize 
)

Construct from dictionary.

Definition at line 83 of file correlationFunction.C.

◆ correlationFunction() [2/2]

correlationFunction ( const polyMesh &  mesh,
const label  tZeroBufferSize,
const scalar  duration,
const scalar  sampleInterval,
const scalar  averagingInterval 
)

Construct from components.

Definition at line 101 of file correlationFunction.C.

◆ ~correlationFunction()

~correlationFunction ( )

Destructor.

Definition at line 122 of file correlationFunction.C.

Member Function Documentation

◆ calculateCorrelationFunction() [1/2]

void calculateCorrelationFunction ( const Field< Type > &  currentValues)

Definition at line 130 of file correlationFunction.C.

References Foam::abort(), Foam::component(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::nl, and Foam::Zero.

Here is the call graph for this function:

◆ calculateCorrelationFunction() [2/2]

void calculateCorrelationFunction ( const Type &  currentValue)

Definition at line 182 of file correlationFunction.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ integral()

Foam::scalar integral ( ) const

Definition at line 200 of file correlationFunction.C.

◆ writeAveraged()

bool writeAveraged ( Ostream &  os) const

Definition at line 32 of file correlationFunctionIO.C.

References forAll, Foam::nl, and os().

Here is the call graph for this function:

◆ tZeroBuffers()

const Foam::Field< Foam::Field< Type > > & tZeroBuffers ( ) const
inline

Definition at line 30 of file correlationFunctionI.H.

◆ duration()

Foam::scalar duration ( ) const
inline

Definition at line 37 of file correlationFunctionI.H.

◆ sampleInterval()

Foam::scalar sampleInterval ( ) const
inline

Definition at line 44 of file correlationFunctionI.H.

◆ averagingInterval()

Foam::scalar averagingInterval ( ) const
inline

Definition at line 51 of file correlationFunctionI.H.

◆ sampleSteps()

Foam::label sampleSteps ( ) const
inline

Definition at line 58 of file correlationFunctionI.H.

◆ measurandFieldSize()

Foam::label measurandFieldSize ( ) const
inline

Definition at line 65 of file correlationFunctionI.H.

Friends And Related Function Documentation

◆ operator

Ostream& operator ( Ostream &  ,
const correlationFunction< Type > &   
)
friend

Member Data Documentation

◆ typeName

const char *const typeName
static

Definition at line 99 of file correlationFunction.H.

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