Inheritance diagram for correlationFunction< Type >:

Collaboration diagram for correlationFunction< Type >:

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 T &	reference
	Type that can be used for storing into. More...

typedef const T &	const_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 T *	iterator
	Random access iterator for traversing UList. More...

typedef const T *	const_iterator
	Random access iterator for traversing UList. More...

typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator for reverse traversal of UList. More...

typedef std::reverse_iterator< const_iterator >	const_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 > &)
	Copy constructor. 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 > >
	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 label, const zero)
	Construct with given size initialising all elements to zero. More...

	List (const List< Field< scalar > > &)
	Copy constructor. More...

	List (const List< T2 > &)
	Copy constructor from list containing another type. More...

	List (List< Field< scalar > > &&)
	Move constructor. 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 (std::initializer_list< Field< scalar > >)
	Construct from an initialiser list. More...

	List (Istream &)
	Construct from Istream. More...

label	size () const
	Return the number of elements in the UList. 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...

Field< scalar > &	newElmt (const label)
	Return subscript-checked element of UList. More...

void	shallowCopy (const UList< Field< scalar > > &)=delete
	Disallow implicit shallowCopy. More...

void	operator= (const UList< Field< scalar > > &)
	Assignment to UList operator. Takes linear time. More...

void	operator= (const List< Field< scalar > > &)
	Assignment operator. Takes linear time. More...

void	operator= (List< Field< scalar > > &&)
	Move assignment operator. More...

void	operator= (const SLList< Field< scalar > > &)
	Assignment to SLList operator. Takes linear time. More...

void	operator= (const UIndirectList< Field< scalar > > &)
	Assignment to UIndirectList operator. Takes linear time. More...

void	operator= (const BiIndirectList< Field< scalar > > &)
	Assignment to BiIndirectList operator. Takes linear time. More...

void	operator= (std::initializer_list< Field< scalar > >)
	Assignment to an initialiser list. More...

void	operator= (const Field< scalar > &)
	Assignment of all entries to the given value. More...

void	operator= (const zero)
	Assignment of all entries to zero. 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 T *	cdata () const
	Return a const pointer to the first data element,. More...

T *	data ()
	Return a pointer to the first data element,. More...

T &	first ()
	Return the first element of the list. More...

const T &	first () const
	Return first element of the list. More...

T &	last ()
	Return the last element of the list. More...

const T &	last () 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	shallowCopy (const UList< T > &)
	Copy the pointer held by the given UList. More...

void	deepCopy (const UList< T > &)
	Copy elements of the given UList. More...

T &	operator[] (const label)
	Return element of UList. More...

const T &	operator[] (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...

void	operator= (const zero)
	Assignment of all entries to zero. 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
Ostream &	operator (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

◆ cmptType

typedef pTraits<Type>::cmptType cmptType

Component type.

Definition at line 92 of file correlationFunction.H.

Constructor & Destructor Documentation

◆ correlationFunction() [1/2]

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

Construct from dictionary.

Definition at line 81 of file correlationFunction.C.

◆ correlationFunction() [2/2]

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()

~correlationFunction ( )

Destructor.

Definition at line 123 of file correlationFunction.C.

References correlationFunction< Type >::calculateCorrelationFunction().

Here is the call graph for this function:

Member Function Documentation

◆ calculateCorrelationFunction() [1/2]

void calculateCorrelationFunction ( const Field< Type > & currentValues )

Definition at line 131 of file correlationFunction.C.

References Foam::abort(), Foam::component(), Foam::FatalError, FatalErrorInFunction, 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:

◆ calculateCorrelationFunction() [2/2]

void calculateCorrelationFunction ( const Type & currentValue )

Definition at line 183 of file correlationFunction.C.

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

Here is the call graph for this function:

◆ integral()

Foam::scalar integral ( ) const

Definition at line 201 of file correlationFunction.C.

References List< T >::size().

Here is the call graph for this function:

◆ 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

Member Data Documentation

◆ 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

Public Types

Public Member Functions

Static Public Attributes

Friends

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ cmptType

Constructor & Destructor Documentation

◆ correlationFunction() [1/2]

◆ correlationFunction() [2/2]

◆ ~correlationFunction()

Member Function Documentation

◆ calculateCorrelationFunction() [1/2]

◆ calculateCorrelationFunction() [2/2]

◆ integral()

◆ writeAveraged()

◆ tZeroBuffers()

◆ duration()

◆ sampleInterval()

◆ averagingInterval()

◆ sampleSteps()

◆ measurandFieldSize()

Friends And Related Function Documentation

◆ operator

Member Data Documentation

◆ typeName

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