Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
correlationFunction< Type > Class Template Reference
Inheritance diagram for correlationFunction< Type >:
Inheritance graph
[legend]
Collaboration diagram for correlationFunction< Type >:
Collaboration graph
[legend]

Public Types

typedef pTraits< Type >::cmptType cmptType
 Component type. More...
 
- Public Types inherited from bufferedAccumulator< scalar >
typedef pTraits< scalar >::cmptType cmptType
 Component type. More...
 
- Public Types inherited from List< Field< scalar > >
typedef SubList< Field< scalar > > subList
 Declare type of subList. More...
 
- Public Types inherited from UList< T >
typedef T value_type
 Type of values the UList contains. More...
 
typedef Treference
 Type that can be used for storing into. More...
 
typedef const Tconst_reference
 Type that can be used for storing into. More...
 
typedef label difference_type
 The type that can represent the difference between any two. More...
 
typedef label size_type
 The type that can represent the size of a UList. More...
 
typedef Titerator
 Random access iterator for traversing UList. More...
 
typedef const Tconst_iterator
 Random access iterator for traversing UList. More...
 
typedef Treverse_iterator
 Reverse iterator for reverse traversal of UList. More...
 
typedef const Tconst_reverse_iterator
 Reverse iterator for reverse traversal of constant UList. 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
 
- Public Member Functions inherited from bufferedAccumulator< scalar >
 bufferedAccumulator ()
 Construct null. More...
 
 bufferedAccumulator (const label nBuffers, const label bufferLength, const label bufferingInterval)
 Construct from components. More...
 
 bufferedAccumulator (const bufferedAccumulator< scalar > &)
 Construct as copy. More...
 
 ~bufferedAccumulator ()
 Destructor. More...
 
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. More...
 
 List ()
 Null constructor. More...
 
 List (const label)
 Construct with given size. More...
 
 List (const label, const Field< scalar > &)
 Construct with given size and value for all elements. More...
 
 List (const List< Field< scalar > > &)
 Copy constructor. More...
 
 List (const Xfer< List< Field< scalar > > > &)
 Construct by transferring the parameter contents. More...
 
 List (List< Field< scalar > > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 List (const UList< Field< scalar > > &, const labelUList &mapAddressing)
 Construct as subset. More...
 
 List (InputIterator first, InputIterator last)
 Construct given start and end iterators. More...
 
 List (const FixedList< Field< scalar >, Size > &)
 Construct as copy of FixedList<T, Size> More...
 
 List (const PtrList< Field< scalar > > &)
 Construct as copy of PtrList<T> More...
 
 List (const SLList< Field< scalar > > &)
 Construct as copy of SLList<T> More...
 
 List (const UIndirectList< Field< scalar > > &)
 Construct as copy of UIndirectList<T> More...
 
 List (const BiIndirectList< Field< scalar > > &)
 Construct as copy of BiIndirectList<T> More...
 
 List (Istream &)
 Construct from Istream. More...
 
autoPtr< List< Field< scalar > > > clone () const
 Clone. More...
 
 ~List ()
 Destructor. More...
 
void resize (const label)
 Alias for setSize(const label) More...
 
void resize (const label, const Field< scalar > &)
 Alias for setSize(const label, const T&) More...
 
void setSize (const label)
 Reset size of List. More...
 
void setSize (const label, const Field< scalar > &)
 Reset size of List and value for new elements. More...
 
void clear ()
 Clear the list, i.e. set size to zero. More...
 
void append (const Field< scalar > &)
 Append an element at the end of the list. More...
 
void append (const UList< Field< scalar > > &)
 Append a List at the end of this list. More...
 
void append (const UIndirectList< Field< scalar > > &)
 Append a UIndirectList at the end of this list. More...
 
void transfer (List< Field< scalar > > &)
 Transfer the contents of the argument List into this list. More...
 
void transfer (DynamicList< Field< scalar >, SizeInc, SizeMult, SizeDiv > &)
 Transfer the contents of the argument List into this list. More...
 
void transfer (SortableList< Field< scalar > > &)
 Transfer the contents of the argument List into this list. More...
 
Xfer< List< Field< scalar > > > xfer ()
 Transfer contents to the Xfer container. More...
 
Field< scalar > & newElmt (const label)
 Return subscript-checked element of UList. More...
 
void operator= (const UList< Field< scalar > > &)
 Assignment from UList operator. Takes linear time. More...
 
void operator= (const List< Field< scalar > > &)
 Assignment operator. Takes linear time. More...
 
void operator= (const SLList< Field< scalar > > &)
 Assignment from SLList operator. Takes linear time. More...
 
void operator= (const UIndirectList< Field< scalar > > &)
 Assignment from UIndirectList operator. Takes linear time. More...
 
void operator= (const BiIndirectList< Field< scalar > > &)
 Assignment from BiIndirectList operator. Takes linear time. More...
 
void operator= (const Field< scalar > &)
 Assignment of all entries to the given value. More...
 
- Public Member Functions inherited from UList< T >
 UList ()
 Null constructor. More...
 
 UList (T *__restrict__ v, label size)
 Construct from components. More...
 
label fcIndex (const label i) const
 Return the forward circular index, i.e. the next index. More...
 
label rcIndex (const label i) const
 Return the reverse circular index, i.e. the previous index. More...
 
std::streamsize byteSize () const
 Return the binary size in number of characters of the UList. More...
 
const Tcdata () const
 Return a const pointer to the first data element,. More...
 
Tdata ()
 Return a pointer to the first data element,. More...
 
Tfirst ()
 Return the first element of the list. More...
 
const Tfirst () const
 Return first element of the list. More...
 
Tlast ()
 Return the last element of the list. More...
 
const Tlast () const
 Return the last element of the list. More...
 
void checkStart (const label start) const
 Check start is within valid range (0 ... size-1). More...
 
void checkSize (const label size) const
 Check size is within valid range (0 ... size). More...
 
void checkIndex (const label i) const
 Check index i is within valid range (0 ... size-1). More...
 
void writeEntry (Ostream &) const
 Write the UList as a dictionary entry. More...
 
void writeEntry (const word &keyword, Ostream &) const
 Write the UList as a dictionary entry with keyword. More...
 
void assign (const UList< T > &)
 Assign elements to those from UList. More...
 
Toperator[] (const label)
 Return element of UList. More...
 
const Toperator[] (const label) const
 Return element of constant UList. More...
 
 operator const Foam::List< T > & () const
 Allow cast to a const List<T>&. More...
 
void operator= (const T &)
 Assignment of all entries to the given value. More...
 
iterator begin ()
 Return an iterator to begin traversing the UList. More...
 
iterator end ()
 Return an iterator to end traversing the UList. More...
 
const_iterator cbegin () const
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator cend () const
 Return const_iterator to end traversing the constant UList. More...
 
const_iterator begin () const
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator end () const
 Return const_iterator to end traversing the constant UList. More...
 
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the UList. More...
 
reverse_iterator rend ()
 Return reverse_iterator to end reverse traversing the UList. More...
 
const_reverse_iterator crbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator crend () const
 Return const_reverse_iterator to end reverse traversing the UList. More...
 
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator rend () const
 Return const_reverse_iterator to end reverse traversing the UList. More...
 
label size () const
 Return the number of elements in the UList. More...
 
label max_size () const
 Return size of the largest possible UList. More...
 
bool empty () const
 Return true if the UList is empty (ie, size() is zero). More...
 
void swap (UList< T > &)
 Swap two ULists of the same type in constant time. More...
 
bool operator== (const UList< T > &) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UList< T > &) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const UList< T > &) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator> (const UList< T > &) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator<= (const UList< T > &) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const UList< T > &) const
 Return true if !(a < b). Takes linear time. More...
 
template<>
const bool & operator[] (const label i) const
 

Static Public Attributes

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

Friends

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

Additional Inherited Members

- Static Public Member Functions inherited from List< Field< scalar > >
static const List< Field< scalar > > & null ()
 Return a null List. More...
 
- Static Public Member Functions inherited from UList< T >
static const UList< T > & null ()
 Return a null UList. More...
 
- Protected Member Functions inherited from List< Field< scalar > >
void size (const label)
 Override size to be inconsistent with allocated storage. More...
 

Detailed Description

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

Source files

Definition at line 47 of file correlationFunction.H.

Member Typedef Documentation

typedef pTraits<Type>::cmptType cmptType

Component type.

Definition at line 92 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.

Here is the call graph for this function:

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.

Destructor.

Definition at line 123 of file correlationFunction.C.

References correlationFunction< Type >::calculateCorrelationFunction().

Here is the call graph for this function:

Member Function Documentation

void calculateCorrelationFunction ( const Field< Type > &  currentValues)

Definition at line 131 of file correlationFunction.C.

References Foam::abort(), Foam::component(), Foam::FatalError, FatalErrorIn, forAll, Foam::nl, and List< Type >::size().

Referenced by correlationFunction< Type >::~correlationFunction().

Here is the call graph for this function:

Here is the caller graph for this function:

void calculateCorrelationFunction ( const Type &  currentValue)

Definition at line 183 of file correlationFunction.C.

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

Here is the call graph for this function:

Foam::scalar integral ( ) const

Definition at line 201 of file correlationFunction.C.

References List< T >::size().

Here is the call graph for this function:

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:

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

Definition at line 97 of file correlationFunction.H.


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