correlationFunction Class Reference

Collaboration diagram for correlationFunction:

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

Private Member Functions
void	setTimesAndSizes (const label)
	correlationFunction (const correlationFunction< Type > &)
	Disallow default bitwise copy construct. More...
void	operator= (const correlationFunction< Type > &)
	Disallow default bitwise assignment. More...

Private Attributes
const polyMesh &	mesh_
Field< Field< Type > >	tZeroBuffers_
scalar	duration_
scalar	sampleInterval_
scalar	averagingInterval_
label	sampleSteps_

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

Detailed Description

Source files

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

Definition at line 47 of file correlationFunction.H.

Member Typedef Documentation

cmptType

typedef pTraits<Type>::cmptType cmptType

Component type.

Definition at line 92 of file correlationFunction.H.

Constructor & Destructor Documentation

correlationFunction() [1/3]

correlationFunction ( const correlationFunction< Type > &  )

private

Disallow default bitwise copy construct.

correlationFunction() [2/3]

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

Construct from dictionary.

correlationFunction() [3/3]

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

Construct from components.

~correlationFunction()

~correlationFunction

(

)

Destructor.

Definition at line 123 of file correlationFunction.C.

Member Function Documentation

setTimesAndSizes()

void setTimesAndSizes ( const label  tZeroBufferSize )

private

Definition at line 39 of file correlationFunction.C.

operator=()

void operator= ( const correlationFunction< Type > &  )

private

Disallow default bitwise assignment.

calculateCorrelationFunction() [1/2]

void calculateCorrelationFunction

(

const Field< Type > &

)

calculateCorrelationFunction() [2/2]

void calculateCorrelationFunction

(

const Type &

)

integral()

Foam::scalar integral

(

)

const

Definition at line 201 of file correlationFunction.C.

writeAveraged()

bool writeAveraged

(

Ostream &

os

)

const

Definition at line 30 of file correlationFunctionIO.C.

References forAll, IOstream::good(), and Foam::nl.

Here is the call graph for this function:

tZeroBuffers()

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

inline

Definition at line 28 of file correlationFunctionI.H.

duration()

Foam::scalar duration ( ) const

inline

Definition at line 35 of file correlationFunctionI.H.

sampleInterval()

Foam::scalar sampleInterval ( ) const

inline

Definition at line 42 of file correlationFunctionI.H.

averagingInterval()

Foam::scalar averagingInterval ( ) const

inline

Definition at line 49 of file correlationFunctionI.H.

sampleSteps()

Foam::label sampleSteps ( ) const

inline

Definition at line 56 of file correlationFunctionI.H.

measurandFieldSize()

Foam::label measurandFieldSize ( ) const

inline

Definition at line 63 of file correlationFunctionI.H.

Friends And Related Function Documentation

operator

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

friend

Field Documentation

mesh_

const polyMesh& mesh_

private

Definition at line 67 of file correlationFunction.H.

tZeroBuffers_

Field< Field<Type> > tZeroBuffers_

private

Definition at line 69 of file correlationFunction.H.

duration_

scalar duration_

private

Definition at line 71 of file correlationFunction.H.

sampleInterval_

scalar sampleInterval_

private

Definition at line 72 of file correlationFunction.H.

averagingInterval_

scalar averagingInterval_

private

Definition at line 73 of file correlationFunction.H.

sampleSteps_

label sampleSteps_

private

Definition at line 75 of file correlationFunction.H.

typeName

const char *const typeName

static

Definition at line 97 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