FreeFOAM The Cross-Platform CFD Toolkit
correlationFunction< Type > Class Template Reference

#include <molecularMeasurements/correlationFunction.H>


Detailed Description

+ Inheritance diagram for correlationFunction< Type >:
+ Collaboration diagram for correlationFunction< Type >:

List of all members.

Public Types

typedef pTraits< Type >::cmptType cmptType
 Component type.
- Public Types inherited from bufferedAccumulator< scalar >
- Public Types inherited from List< Field< scalar > >
typedef SubList< Field< scalar > > subList
 Declare type of subList.
- Public Types inherited from UList< Field< scalar > >
typedef Field< scalar > value_type
 Type of values the UList contains.
typedef Field< scalar > & reference
 Type that can be used for storing into.
typedef const Field< scalar > & const_reference
 Type that can be used for storing into.
typedef label difference_type
 The type that can represent the difference between any two.
typedef label size_type
 The type that can represent the size of a UList.
typedef Field< scalar > * iterator
 Random access iterator for traversing UList.
typedef const Field< scalar > * const_iterator
 Random access iterator for traversing UList.
typedef Field< scalar > * reverse_iterator
 Reverse iterator for reverse traversal of UList.
typedef const Field< scalar > * const_reverse_iterator
 Reverse iterator for reverse traversal of constant UList.

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
- Public Member Functions inherited from bufferedAccumulator< scalar >
 bufferedAccumulator ()
 Construct null.
 bufferedAccumulator (const label nBuffers, const label bufferLength, const label bufferingInterval)
 Construct from components.
 bufferedAccumulator (const bufferedAccumulator< scalar > &)
 Construct as copy.
 ~bufferedAccumulator ()
label addToBuffers (const List< scalar > &valuesToAdd)
Field< scalar > averaged () const
void resetAveraging ()
label averagesTaken () const
label nBuffers () const
label bufferLength () const
const List< label > & bufferOffsets () const
void setSizes (const label nBuffers, const label bufferLength, const label bufferingInterval)
void operator= (const bufferedAccumulator< scalar > &)
- Public Member Functions inherited from List< Field< scalar > >
label size () const
 Return the number of elements in the UList.
 List ()
 Null constructor.
 List (const label)
 Construct with given size.
 List (const label, const Field< scalar > &)
 Construct with given size and value for all elements.
 List (const List< Field< scalar > > &)
 Copy constructor.
 List (const Xfer< List< Field< scalar > > > &)
 Construct by transferring the parameter contents.
 List (List< Field< scalar > > &, bool reUse)
 Construct as copy or re-use as specified.
 List (const UList< Field< scalar > > &, const unallocLabelList &mapAddressing)
 Construct as subset.
 List (InputIterator first, InputIterator last)
 Construct given start and end iterators.
 List (const FixedList< Field< scalar >, Size > &)
 Construct as copy of FixedList<T, Size>
 List (const PtrList< Field< scalar > > &)
 Construct as copy of PtrList<T>
 List (const SLList< Field< scalar > > &)
 Construct as copy of SLList<T>
 List (const IndirectList< Field< scalar > > &)
 Construct as copy of IndirectList<T>
 List (const UIndirectList< Field< scalar > > &)
 Construct as copy of UIndirectList<T>
 List (const BiIndirectList< Field< scalar > > &)
 Construct as copy of BiIndirectList<T>
 List (Istream &)
 Construct from Istream.
autoPtr< List< Field< scalar > > > clone () const
 Clone.
 ~List ()
void resize (const label)
 Reset size of List.
void resize (const label, const Field< scalar > &)
 Reset size of List and value for new elements.
void setSize (const label)
 Reset size of List.
void setSize (const label, const Field< scalar > &)
 Reset size of List and value for new elements.
void clear ()
 Clear the list, i.e. set size to zero.
void append (const UList< Field< scalar > > &)
 Append a List at the end of this list.
void append (const UIndirectList< Field< scalar > > &)
 Append a UIndirectList at the end of this list.
void transfer (List< Field< scalar > > &)
 Transfer the contents of the argument List into this list.
void transfer (DynamicList< Field< scalar >, SizeInc, SizeMult, SizeDiv > &)
 Transfer the contents of the argument List into this list.
void transfer (SortableList< Field< scalar > > &)
 Transfer the contents of the argument List into this list.
Xfer< List< Field< scalar > > > xfer ()
 Transfer contents to the Xfer container.
Field< scalar > & newElmt (const label)
 Return subscript-checked element of UList.
void operator= (const UList< Field< scalar > > &)
 Assignment from UList operator. Takes linear time.
void operator= (const List< Field< scalar > > &)
 Assignment operator. Takes linear time.
void operator= (const SLList< Field< scalar > > &)
 Assignment from SLList operator. Takes linear time.
void operator= (const IndirectList< Field< scalar > > &)
 Assignment from IndirectList operator. Takes linear time.
void operator= (const UIndirectList< Field< scalar > > &)
 Assignment from UIndirectList operator. Takes linear time.
void operator= (const BiIndirectList< Field< scalar > > &)
 Assignment from BiIndirectList operator. Takes linear time.
void operator= (const Field< scalar > &)
 Assignment of all entries to the given value.
- Public Member Functions inherited from UList< Field< scalar > >
 UList ()
 Null constructor.
 UList (Field< scalar > *__restrict__ v, label size)
 Construct from components.
label fcIndex (const label i) const
 Return the forward circular index, i.e. the next index.
label rcIndex (const label i) const
 Return the reverse circular index, i.e. the previous index.
label byteSize () const
 Return the binary size in number of characters of the UList.
const Field< scalar > * cdata () const
 Return a const pointer to the first data element,.
Field< scalar > * data ()
 Return a pointer to the first data element,.
void checkStart (const label start) const
 Check start is within valid range (0 ... size-1).
void checkSize (const label size) const
 Check size is within valid range (0 ... size).
void checkIndex (const label i) const
 Check index i is within valid range (0 ... size-1).
void writeEntry (Ostream &) const
 Write the UList as a dictionary entry.
void writeEntry (const word &keyword, Ostream &) const
 Write the UList as a dictionary entry with keyword.
void assign (const UList< Field< scalar > > &)
 Assign elements to those from UList.
Field< scalar > & operator[] (const label)
 Return element of UList.
const Field< scalar > & operator[] (const label) const
 Return element of constant UList.
 operator const Foam::List< Field< scalar > > & () const
 Allow cast to a const List<T>&.
iterator begin ()
 Return an iterator to begin traversing the UList.
const_iterator begin () const
 Return const_iterator to begin traversing the constant UList.
iterator end ()
 Return an iterator to end traversing the UList.
const_iterator end () const
 Return const_iterator to end traversing the constant UList.
const_iterator cbegin () const
 Return const_iterator to begin traversing the constant UList.
const_iterator cend () const
 Return const_iterator to end traversing the constant UList.
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList.
reverse_iterator rend ()
 Return reverse_iterator to end reverse traversing the UList.
const_reverse_iterator rend () const
 Return const_reverse_iterator to end reverse traversing the UList.
const_reverse_iterator crbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator crend () const
 Return const_reverse_iterator to end reverse traversing the UList.
label max_size () const
 Return size of the largest possible UList.
bool empty () const
 Return true if the UList is empty (ie, size() is zero).
void swap (UList< Field< scalar > > &)
 Swap two ULists of the same type in constant time.
bool operator== (const UList< Field< scalar > > &) const
 Equality operation on ULists of the same type.
bool operator!= (const UList< Field< scalar > > &) const
 The opposite of the equality operation. Takes linear time.
bool operator< (const UList< Field< scalar > > &) const
 Compare two ULists lexicographically. Takes linear time.
bool operator> (const UList< Field< scalar > > &) const
 Compare two ULists lexicographically. Takes linear time.
bool operator<= (const UList< Field< scalar > > &) const
 Return true if !(a > b). Takes linear time.
bool operator>= (const UList< Field< scalar > > &) const
 Return true if !(a < b). Takes linear time.

Static Public Attributes

static const char *const typeName
- Static Public Attributes inherited from bufferedAccumulator< scalar >

Friends

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

Member Typedef Documentation

typedef pTraits<Type>::cmptType cmptType

Component type.

Reimplemented from bufferedAccumulator< scalar >.

Definition at line 93 of file correlationFunction.H.


Constructor & Destructor Documentation

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.

Definition at line 123 of file correlationFunction.C.


Member Function Documentation

void calculateCorrelationFunction ( const Field< Type > &  currentValues)
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.


Friends And Related Function Documentation

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

Member Data Documentation

const char *const typeName
static

Reimplemented from bufferedAccumulator< scalar >.

Definition at line 98 of file correlationFunction.H.


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