#include <molecularMeasurements/correlationFunction.H>
Definition at line 62 of file correlationFunction.H.
Inheritance diagram for correlationFunction< Type >: Collaboration diagram for correlationFunction< Type >:Public Types | |
| typedef pTraits< Type >::cmptType | cmptType |
| Component type.
| |
Public Member Functions | |
| correlationFunction (const polyMesh &, const dictionary &, const label tZeroBufferSize) | |
| Construct from dictionary.
| |
| correlationFunction (const polyMesh &, const label tZeroBufferSize, const scalar duration, const scalar sampleInterval, const scalar averagingInterval) | |
| Construct from components.
| |
| ~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 > &) |
Component type.
Reimplemented from bufferedAccumulator< scalar >.
Definition at line 93 of file correlationFunction.H.
| correlationFunction | ( | const polyMesh & | mesh, |
| const dictionary & | cfDict, | ||
| const label | tZeroBufferSize | ||
| ) |
Construct from dictionary.
Definition at line 81 of file correlationFunction.C.
References dictionary::lookup(), and readScalar.
| correlationFunction | ( | const polyMesh & | mesh, |
| const label | tZeroBufferSize, | ||
| const scalar | duration, | ||
| const scalar | sampleInterval, | ||
| const scalar | averagingInterval | ||
| ) |
Construct from components.
Definition at line 102 of file correlationFunction.C.
| ~correlationFunction | ( | ) |
Definition at line 123 of file correlationFunction.C.
| void calculateCorrelationFunction | ( | const Field< Type > & | currentValues ) |
Definition at line 131 of file correlationFunction.C.
References Foam::abort(), component(), Foam::FatalError, FatalErrorIn, forAll, Foam::nl, and List< Type >::size().
| void calculateCorrelationFunction | ( | const Type & | currentValue ) |
Definition at line 183 of file correlationFunction.C.
References Foam::abort(), Foam::FatalError, and FatalErrorIn.
| Foam::scalar integral | ( | ) | const |
Definition at line 201 of file correlationFunction.C.
References List< T >::size().
| bool writeAveraged | ( | Ostream & | os ) | const |
Definition at line 30 of file correlationFunctionIO.C.
References forAll, IOstream::good(), and Foam::nl.
| const Foam::Field< Foam::Field< Type > > & tZeroBuffers | ( | ) | const [inline]
|
Definition at line 28 of file correlationFunctionI.H.
| Foam::scalar duration | ( | ) | const [inline]
|
Definition at line 35 of file correlationFunctionI.H.
| Foam::scalar sampleInterval | ( | ) | const [inline]
|
Definition at line 42 of file correlationFunctionI.H.
| Foam::scalar averagingInterval | ( | ) | const [inline]
|
Definition at line 49 of file correlationFunctionI.H.
| Foam::label sampleSteps | ( | ) | const [inline]
|
Definition at line 56 of file correlationFunctionI.H.
| Foam::label measurandFieldSize | ( | ) | const [inline]
|
Definition at line 63 of file correlationFunctionI.H.
| Ostream& operator | ( | Ostream & | , |
| const correlationFunction< Type > & | |||
| ) | [friend]
|
const char *const typeName [static]
|
Reimplemented from bufferedAccumulator< scalar >.
Definition at line 98 of file correlationFunction.H.
