correlationFunction Class Reference

Public Types
typedef pTraits< Type >::cmptType	cmptType

Public Member Functions
	correlationFunction (const polyMesh &, const dictionary &, const label tZeroBufferSize)
	correlationFunction (const polyMesh &, const label tZeroBufferSize, const scalar duration, const scalar sampleInterval, const scalar averagingInterval)
	~correlationFunction ()
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

Source files

• correlationFunction.H
• correlationFunctionI.H
• correlationFunction.C
• correlationFunctionIO.C

Definition at line 45 of file correlationFunction.H.

Member Typedef Documentation

cmptType

typedef pTraits<Type>::cmptType cmptType

Definition at line 90 of file correlationFunction.H.

Constructor & Destructor Documentation

correlationFunction() [1/2]

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

correlationFunction() [2/2]

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

~correlationFunction()

~correlationFunction

(

)

Definition at line 115 of file correlationFunction.C.

Member Function Documentation

calculateCorrelationFunction() [1/2]

void calculateCorrelationFunction

(

const Field< Type > &

)

calculateCorrelationFunction() [2/2]

void calculateCorrelationFunction

(

const Type &

)

integral()

Foam::scalar integral

(

)

const

Definition at line 193 of file correlationFunction.C.

writeAveraged()

bool writeAveraged

(

Ostream &

os

)

const

Definition at line 25 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 23 of file correlationFunctionI.H.

duration()

Foam::scalar duration ( ) const

inline

Definition at line 30 of file correlationFunctionI.H.

sampleInterval()

Foam::scalar sampleInterval ( ) const

inline

Definition at line 37 of file correlationFunctionI.H.

averagingInterval()

Foam::scalar averagingInterval ( ) const

inline

Definition at line 44 of file correlationFunctionI.H.

sampleSteps()

Foam::label sampleSteps ( ) const

inline

Definition at line 51 of file correlationFunctionI.H.

measurandFieldSize()

Foam::label measurandFieldSize ( ) const

inline

Definition at line 58 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 95 of file correlationFunction.H.

---

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

• src/lagrangian/molecularDynamics/molecularMeasurements/correlationFunction/correlationFunction.H
• src/lagrangian/molecularDynamics/molecularMeasurements/correlationFunction/correlationFunction.C
• src/lagrangian/molecularDynamics/molecularMeasurements/correlationFunction/correlationFunctionI.H
• src/lagrangian/molecularDynamics/molecularMeasurements/correlationFunction/correlationFunctionIO.C