Public Member Functions | |
| TypeName ("Hanning") | |
| Runtime type information. More... | |
| Hanning (const dictionary &dict, const label nSamples) | |
| Construct from dictionary. More... | |
| virtual | ~Hanning ()=default |
| Destructor. More... | |
| bool | symmetric () const |
| Return the symmetric flag. More... | |
| bool | extended () const |
| Return the extended flag. More... | |
| scalar | alpha () const |
| Return the window coefficient. More... | |
 Public Member Functions inherited from windowModel | |
| TypeName ("windowModel") | |
| Runtime type information. More... | |
| declareRunTimeSelectionTable (autoPtr, windowModel, dictionary,(const dictionary &dict, const label nSamples),(dict, nSamples)) | |
| windowModel (const dictionary &dict, const label nSamples) | |
| Construct from dictionary. More... | |
| virtual | ~windowModel ()=default |
| Destructor. More... | |
| label | nSamples () const |
| Return the number of samples in the window. More... | |
| label | nWindow () const |
| Return the number of windows. More... | |
| label | nWindowsTotal (label nSamplesTotal) const |
| Return the total number of windows for a given number of samples. More... | |
| label | validate (label n) |
| Validate that the window is applicable to the data set size, and. More... | |
| template<class Type > | |
| tmp< Field< Type > > | apply (const Field< Type > &fld, const label windowI) const |
| Return the windowed data. More... | |
| template<class Type > | |
| Foam::tmp< Foam::Field< Type > > | apply (const Field< Type > &fld, const label windowI) const |
| Public Member Functions inherited from Field< scalar > | |
| constexpr | Field () noexcept |
| Default construct. More... | |
| Field (const label len) | |
| Construct given size. More... | |
| Field (const label len, const scalar &val) | |
| Construct given size and initial value. More... | |
| Field (const label len, const Foam::zero) | |
| Construct given size and initial values of zero. More... | |
| Field (const Foam::one, const scalar &val) | |
| Construct with length=1, copying the value as the only content. More... | |
| Field (const Foam::one, scalar &&val) | |
| Construct with length=1, moving the value as the only content. More... | |
| Field (const Foam::one, const Foam::zero) | |
| Construct with length=1, initializing content to zero. More... | |
| Field (const Field< scalar > &fld) | |
| Copy construct. More... | |
| Field (const UList< scalar > &list) | |
| Copy construct from UList<Type> More... | |
| Field (const IndirectListBase< scalar, Addr > &list) | |
| Copy construct from IndirectList. More... | |
| Field (Field< scalar > &&fld) | |
| Move construct from Field. More... | |
| Field (List< scalar > &&list) | |
| Move construct from List. More... | |
| Field (DynamicList< scalar, SizeMin > &&list) | |
| Move construct from DynamicList. More... | |
| Field (const UList< scalar > &mapF, const labelUList &mapAddressing) | |
| Construct by 1 to 1 mapping from the given field. More... | |
| Field (const tmp< Field< scalar > > &tmapF, const labelUList &mapAddressing) | |
| Construct by 1 to 1 mapping from the given tmp field. More... | |
| Field (const UList< scalar > &mapF, const labelListList &mapAddressing, const scalarListList &weights) | |
| Construct by interpolative mapping from the given field. More... | |
| Field (const tmp< Field< scalar > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights) | |
| Construct by interpolative mapping from the given tmp field. More... | |
| Field (const UList< scalar > &mapF, const FieldMapper &map, const bool applyFlip=true) | |
| Construct by mapping from the given field. More... | |
| Field (const UList< scalar > &mapF, const FieldMapper &map, const scalar &defaultValue, const bool applyFlip=true) | |
| Construct by mapping from the given field. More... | |
| Field (const UList< scalar > &mapF, const FieldMapper &map, const UList< scalar > &defaultValues, const bool applyFlip=true) | |
| Construct by mapping from the given field. More... | |
| Field (const tmp< Field< scalar > > &tmapF, const FieldMapper &map, const bool applyFlip=true) | |
| Construct by mapping from the given tmp field. More... | |
| Field (const tmp< Field< scalar > > &tmapF, const FieldMapper &map, const scalar &defaultValue, const bool applyFlip=true) | |
| Field (const tmp< Field< scalar > > &tmapF, const FieldMapper &map, const UList< scalar > &defaultValues, const bool applyFlip=true) | |
| Field (Field< scalar > &fld, bool reuse) | |
| Copy construct or re-use as specified. More... | |
| Field (const tmp< Field< scalar > > &tfld) | |
| Copy or move construct from tmp. More... | |
| Field (Istream &is) | |
| Construct from Istream. More... | |
| Field (const word &keyword, const dictionary &dict, const label len) | |
| Construct from a dictionary entry. More... | |
| tmp< Field< scalar > > | clone () const |
| Clone. More... | |
| void | map (const UList< scalar > &mapF, const labelUList &mapAddressing) |
| 1 to 1 map from the given field More... | |
| void | map (const tmp< Field< scalar > > &tmapF, const labelUList &mapAddressing) |
| 1 to 1 map from the given tmp field More... | |
| void | map (const UList< scalar > &mapF, const labelListList &mapAddressing, const scalarListList &weights) |
| Interpolative map from the given field. More... | |
| void | map (const tmp< Field< scalar > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights) |
| Interpolative map from the given tmp field. More... | |
| void | map (const UList< scalar > &mapF, const FieldMapper &map, const bool applyFlip=true) |
| Map from the given field. More... | |
| void | map (const tmp< Field< scalar > > &tmapF, const FieldMapper &map, const bool applyFlip=true) |
| Map from the given tmp field. More... | |
| void | autoMap (const FieldMapper &map, const bool applyFlip=true) |
| Map from self. More... | |
| void | rmap (const UList< scalar > &mapF, const labelUList &mapAddressing) |
| 1 to 1 reverse-map from the given field More... | |
| void | rmap (const tmp< Field< scalar > > &tmapF, const labelUList &mapAddressing) |
| 1 to 1 reverse-map from the given tmp field More... | |
| void | rmap (const UList< scalar > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights) |
| Interpolative reverse map from the given field. More... | |
| void | rmap (const tmp< Field< scalar > > &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights) |
| Interpolative reverse map from the given tmp field. More... | |
| void | negate () |
| Inplace negate this field (negative). More... | |
| void | normalise () |
| void | normalise () |
| void | normalise () |
| void | normalise () |
| Inplace normalise (float) vector field. More... | |
| void | normalise () |
| Inplace normalise (double) vector field. More... | |
| tmp< Field< cmptType > > | component (const direction) const |
| Return a component field of the field. More... | |
| void | replace (const direction, const UList< cmptType > &) |
| Replace a component field of the field. More... | |
| void | replace (const direction, const tmp< Field< cmptType > > &) |
| Replace a component field of the field. More... | |
| void | replace (const direction, const cmptType &) |
| Replace a component field of the field. More... | |
| VSForm | block (const label start) const |
| tmp< Field< scalar > > | T () const |
| Return the field transpose (only defined for second rank tensors) More... | |
| void | writeEntry (const word &keyword, Ostream &os) const |
| Write the field as a dictionary entry. More... | |
| SubField< scalar > | slice (const label pos, label len=-1) |
| Return SubField slice (non-const access) - no range checking. More... | |
| const SubField< scalar > | slice (const label pos, label len=-1) const |
| Return SubField slice (const access) - no range checking. More... | |
| SubField< scalar > | slice (const labelRange &range) |
| Return SubField slice (non-const access) - with range checking. More... | |
| const SubField< scalar > | slice (const labelRange &range) const |
| Return SubField slice (const access) - with range checking. More... | |
| void | operator= (const Field< scalar > &) |
| Copy assignment. More... | |
| void | operator= (const tmp< Field< scalar > > &) |
| void | operator= (const UList< scalar > &rhs) |
| void | operator= (const SubField< scalar > &rhs) |
| void | operator= (const IndirectListBase< scalar, Addr > &rhs) |
| Copy assign from IndirectList. More... | |
| void | operator= (Field< scalar > &&rhs) |
| Move assignment. More... | |
| void | operator= (List< scalar > &&rhs) |
| void | operator= (DynamicList< scalar, SizeMin > &&rhs) |
| void | operator= (const scalar &val) |
| Value assignment. More... | |
| void | operator= (const Foam::zero) |
| void | operator= (const VectorSpace< Form, Cmpt, nCmpt > &) |
| void | operator= (const tmp< Field > &rhs) |
| void | operator+= (const UList< scalar > &) |
| void | operator+= (const tmp< Field< scalar > > &) |
| void | operator+= (const scalar &) |
| void | operator-= (const UList< scalar > &) |
| void | operator-= (const tmp< Field< scalar > > &) |
| void | operator-= (const scalar &) |
| void | operator*= (const UList< scalar > &) |
| void | operator*= (const tmp< Field< scalar > > &) |
| void | operator*= (const scalar &) |
| void | operator/= (const UList< scalar > &) |
| void | operator/= (const tmp< Field< scalar > > &) |
| void | operator/= (const scalar &) |
| Public Member Functions inherited from FieldBase | |
| constexpr | FieldBase () noexcept |
| Default construct, refCount zero. More... | |
| Public Member Functions inherited from refCount | |
| constexpr | refCount () noexcept |
| Default construct, initializing count to 0. More... | |
| int | count () const noexcept |
| Return the current reference count. More... | |
| bool | unique () const noexcept |
| Return true if the reference count is zero. More... | |
| void | operator++ () noexcept |
| Increment the reference count. More... | |
| void | operator++ (int) noexcept |
| Increment the reference count. More... | |
| void | operator-- () noexcept |
| Decrement the reference count. More... | |
| void | operator-- (int) noexcept |
| Decrement the reference count. More... | |
| Public Member Functions inherited from List< T > | |
| constexpr | List () noexcept |
| Default construct. More... | |
| List (const label len) | |
| Construct with given size. More... | |
| List (const label len, const T &val) | |
| Construct with given size and value for all elements. More... | |
| List (const label len, const Foam::zero) | |
| Construct with given size initializing all elements to zero. More... | |
| List (const Foam::one, const T &val) | |
| Construct with length=1, copying the value as the only content. More... | |
| List (const Foam::one, T &&val) | |
| Construct with length=1, moving the value as the only content. More... | |
| List (const Foam::one, const Foam::zero) | |
| Construct with length=1, initializing content to zero. More... | |
| List (const List< T > &a) | |
| Copy construct from list. More... | |
| List (const UList< T > &a) | |
| Copy construct contents from list. More... | |
| List (List< T > &a, bool reuse) | |
| Construct as copy or re-use as specified. More... | |
| List (const UList< T > &list, const labelUList &indices) | |
| Copy construct subset of list. More... | |
| template<unsigned N> | |
| List (const UList< T > &list, const FixedList< label, N > &indices) | |
| Copy construct subset of list. More... | |
| template<unsigned N> | |
| List (const FixedList< T, N > &list) | |
| Construct as copy of FixedList<T, N> More... | |
| List (const PtrList< T > &list) | |
| Construct as copy of PtrList<T> More... | |
| List (const SLList< T > &list) | |
| Construct as copy of SLList<T> More... | |
| template<class Addr > | |
| List (const IndirectListBase< T, Addr > &list) | |
| Construct as copy of IndirectList contents. More... | |
| List (std::initializer_list< T > list) | |
| Construct from an initializer list. More... | |
| List (List< T > &&list) | |
| Move construct from List. More... | |
| template<int SizeMin> | |
| List (DynamicList< T, SizeMin > &&list) | |
| Move construct from DynamicList. More... | |
| List (SLList< T > &&list) | |
| Move construct from SLList. More... | |
| List (Istream &is) | |
| Construct from Istream. More... | |
| autoPtr< List< T > > | clone () const |
| Clone. More... | |
| ~List () | |
| Destructor. More... | |
| void | clear () |
| Clear the list, i.e. set size to zero. More... | |
| void | resize (const label len) |
| Adjust allocated size of list. More... | |
| void | resize (const label len, const T &val) |
| Adjust allocated size of list and set val for new elements. More... | |
| void | resize_nocopy (const label len) |
| Adjust allocated size of list without necessarily. More... | |
| void | setSize (const label n) |
| Alias for resize() More... | |
| void | setSize (const label n, const T &val) |
| Alias for resize() More... | |
| void | append (const T &val) |
| Append an element at the end of the list. More... | |
| void | append (T &&val) |
| Move append an element at the end of the list. More... | |
| void | append (const UList< T > &list) |
| Append a List to the end of this list. More... | |
| template<class Addr > | |
| void | append (const IndirectListBase< T, Addr > &list) |
| Append IndirectList contents at the end of this list. More... | |
| label | appendUniq (const T &val) |
| Append an element if not already in the list. More... | |
| void | transfer (List< T > &list) |
| template<int SizeMin> | |
| void | transfer (DynamicList< T, SizeMin > &list) |
| T & | newElmt (const label i) |
| void | operator= (const UList< T > &a) |
| Assignment to UList operator. Takes linear time. More... | |
| void | operator= (const List< T > &list) |
| Assignment operator. Takes linear time. More... | |
| void | operator= (const SLList< T > &list) |
| Assignment to SLList operator. Takes linear time. More... | |
| template<class Addr > | |
| void | operator= (const IndirectListBase< T, Addr > &list) |
| Assignment from IndirectList. Takes linear time. More... | |
| template<unsigned N> | |
| void | operator= (const FixedList< T, N > &list) |
| Copy assignment from FixedList. More... | |
| void | operator= (std::initializer_list< T > list) |
| Assignment to an initializer list. More... | |
| void | operator= (const T &val) |
| Assignment of all entries to the given value. More... | |
| void | operator= (const Foam::zero) |
| Assignment of all entries to zero. More... | |
| void | operator= (List< T > &&list) |
| Move assignment. Takes constant time. More... | |
| template<int SizeMin> | |
| void | operator= (DynamicList< T, SizeMin > &&list) |
| Move assignment. Takes constant time. More... | |
| void | operator= (SLList< T > &&list) |
| Move assignment. Takes constant time. More... | |
| Istream & | readList (Istream &is) |
| Read List from Istream, discarding contents of existing List. More... | |
| void | shallowCopy (const UList< T > &)=delete |
| No shallowCopy permitted. More... | |
| template<class TypeT = T> | |
| std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | set (const label i, bool val=true) |
| A bitSet::set() method for a list of bool. More... | |
| Istream & | readList (Istream &is) |
| void | resize (const label newLen) |
| Istream & | readList (Istream &is) |
| Public Member Functions inherited from UList< T > | |
| UList (const UList< T > &)=default | |
| Copy construct. More... | |
| constexpr | UList () noexcept |
| Default construct, zero-sized and nullptr. More... | |
| UList (T *__restrict__ v, const label len) noexcept | |
| Construct from components. More... | |
| label | fcIndex (const label i) const noexcept |
| label | rcIndex (const label i) const noexcept |
| const T & | fcValue (const label i) const |
| Return forward circular value (ie, next value in the list) More... | |
| T & | fcValue (const label i) |
| Return forward circular value (ie, next value in the list) More... | |
| const T & | rcValue (const label i) const |
| Return reverse circular value (ie, previous value in the list) More... | |
| T & | rcValue (const label i) |
| Return reverse circular value (ie, previous value in the list) More... | |
| const T * | cdata () const noexcept |
| Return pointer to the underlying array serving as data storage. More... | |
| T * | data () noexcept |
| Return pointer to the underlying array serving as data storage. More... | |
| const char * | cdata_bytes () const noexcept |
| Return pointer to the underlying array serving as data storage,. More... | |
| char * | data_bytes () noexcept |
| Return pointer to the underlying array serving as data storage,. 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... | |
| std::streamsize | size_bytes () const noexcept |
| Number of contiguous bytes for the List data. More... | |
| std::streamsize | byteSize () const |
| void | checkStart (const label start) const |
| Check start is within valid range [0,size) More... | |
| void | checkSize (const label size) const |
| Check size is within valid range [0,size]. More... | |
| void | checkRange (const label start, const label len) const |
| Check that start and length define a valid range. More... | |
| void | checkIndex (const label i) const |
| Check index is within valid range [0,size) More... | |
| bool | uniform () const |
| True if all entries have identical values, and list is non-empty. More... | |
| label | find (const T &val, label pos=0) const |
| Find index of the first occurrence of the value. More... | |
| label | rfind (const T &val, label pos=-1) const |
| Find index of the last occurrence of the value. More... | |
| bool | found (const T &val, label pos=0) const |
| True if the value if found in the list. More... | |
| void | moveFirst (const label i) |
| Move element to the first position. More... | |
| void | moveLast (const label i) |
| Move element to the last position. More... | |
| void | swapFirst (const label i) |
| Swap element with the first element. Fatal on an empty list. More... | |
| void | swapLast (const label i) |
| Swap element with the last element. Fatal on an empty list. More... | |
| void | shallowCopy (const UList< T > &list) |
| Copy the pointer and size held by the given UList. More... | |
| void | deepCopy (const UList< T > &list) |
| Copy elements of the given UList. Sizes must match! More... | |
| template<class Addr > | |
| void | deepCopy (const IndirectListBase< T, Addr > &list) |
| Copy elements of the given indirect list. Sizes must match! More... | |
| SubList< T > | slice (const label pos, label len=-1) |
| Return SubList slice (non-const access) - no range checking. More... | |
| const SubList< T > | slice (const label pos, label len=-1) const |
| Return SubList slice (const access) - no range checking. More... | |
| SubList< T > | slice (const labelRange &range) |
| Return SubList slice (non-const access) - with range checking. More... | |
| const SubList< T > | slice (const labelRange &range) const |
| Return SubList slice (const access) - with range checking. More... | |
| T & | operator[] (const label i) |
| Return element of UList. More... | |
| const T & | operator[] (const label i) 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 &val) |
| Assignment of all entries to the given value. More... | |
| void | operator= (const Foam::zero) |
| Assignment of all entries to zero. More... | |
| iterator | begin () noexcept |
| Return an iterator to begin traversing the UList. More... | |
| iterator | end () noexcept |
| Return an iterator to end traversing the UList. More... | |
| const_iterator | cbegin () const noexcept |
| Return const_iterator to begin traversing the constant UList. More... | |
| const_iterator | cend () const noexcept |
| Return const_iterator to end traversing the constant UList. More... | |
| const_iterator | begin () const noexcept |
| Return const_iterator to begin traversing the constant UList. More... | |
| const_iterator | end () const noexcept |
| 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 noexcept |
| The number of elements in the UList. More... | |
| bool | empty () const noexcept |
| True if the UList is empty (ie, size() is zero) More... | |
| void | swap (UList< T > &list) |
| Swap content with another UList of the same type in constant time. More... | |
| bool | operator== (const UList< T > &a) const |
| Equality operation on ULists of the same type. More... | |
| bool | operator!= (const UList< T > &a) const |
| The opposite of the equality operation. Takes linear time. More... | |
| bool | operator< (const UList< T > &list) const |
| Compare two ULists lexicographically. Takes linear time. More... | |
| bool | operator> (const UList< T > &a) const |
| Compare two ULists lexicographically. Takes linear time. More... | |
| bool | operator<= (const UList< T > &a) const |
| Return true if !(a > b). Takes linear time. More... | |
| bool | operator>= (const UList< T > &a) const |
| Return true if !(a < b). Takes linear time. More... | |
| Istream & | readList (Istream &is) |
| Read List contents from Istream. More... | |
| void | writeEntry (const word &keyword, Ostream &os) const |
| Write the List as a dictionary entry with keyword. More... | |
| Ostream & | writeList (Ostream &os, const label shortLen=0) const |
| Write List, with line-breaks in ASCII when length exceeds shortLen. More... | |
| template<class TypeT = T> | |
| std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | test (const label i) const |
| template<class TypeT = T> | |
| std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | get (const label i) const |
| template<class TypeT = T> | |
| std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | unset (const label i) |
| Istream & | readList (Istream &is) |
| Ostream & | writeList (Ostream &os, const label) const |
| const bool & | operator[] (const label i) const |
| Foam::UPstream::commsStruct & | operator[] (const label procID) |
| const Foam::UPstream::commsStruct & | operator[] (const label procID) const |
| UPstream::commsStruct & | operator[] (const label procID) |
| const UPstream::commsStruct & | operator[] (const label procID) const |
| Ostream & | writeList (Ostream &os, const label) const |
| Istream & | readList (Istream &is) |
Protected Attributes | |
| bool | symmetric_ |
| Symmetric switch. More... | |
| bool | extended_ |
| Extended switch. More... | |
| scalar | alpha_ |
| Window coefficient, default = 0.5. More... | |
| Protected Attributes inherited from windowModel | |
| label | nOverlapSamples_ |
| Number of overlap samples per window. More... | |
| label | nWindow_ |
| Number of windows. More... | |
Additional Inherited Members | |
| Public Types inherited from Field< scalar > | |
| typedef pTraits< scalar >::cmptType | cmptType |
| Component type. More... | |
| typedef SubField< scalar > | subField |
| Declare type of subField. More... | |
| Public Types inherited from List< T > | |
| typedef SubList< T > | subList |
| Declare type of subList. More... | |
| Public Types inherited from UList< T > | |
| typedef T | value_type |
| The value type the list contains. More... | |
| typedef T * | pointer |
| The pointer type for non-const access to value_type items. More... | |
| typedef const T * | const_pointer |
| The pointer type for const access to value_type items. More... | |
| typedef T & | reference |
| The type used for storing into value_type objects. More... | |
| typedef const T & | const_reference |
| The type used for reading from constant value_type objects. More... | |
| typedef T * | iterator |
| Random access iterator for traversing a UList. More... | |
| typedef const T * | const_iterator |
| Random access iterator for traversing a UList. More... | |
| typedef label | size_type |
| The type to represent the size of a UList. More... | |
| typedef label | difference_type |
| The difference between iterator objects. More... | |
| typedef std::reverse_iterator< iterator > | reverse_iterator |
| Reverse iterator (non-const access) More... | |
| typedef std::reverse_iterator< const_iterator > | const_reverse_iterator |
| Reverse iterator (const access) More... | |
| Static Public Member Functions inherited from windowModel | |
| static autoPtr< windowModel > | New (const dictionary &dict, const label nSamples) |
| Return a reference to the selected window model. More... | |
| Static Public Member Functions inherited from Field< scalar > | |
| static const Field< scalar > & | null () |
| Return nullObject reference Field. More... | |
| static autoPtr< Field< scalar > > | New (Istream &is) |
| Return a pointer to a new Field created on freestore. More... | |
| static tmp< Field< scalar > > | NewCalculatedType (const Field< Type2 > &f) |
| Static Public Member Functions inherited from List< T > | |
| static const List< T > & | null () |
| Return a null List. More... | |
| Static Public Member Functions inherited from UList< T > | |
| static const UList< T > & | null () |
| Return a UList reference to a nullObject. More... | |
| static constexpr label | max_size () noexcept |
| The size of the largest possible UList. More... | |
| Static Public Attributes inherited from FieldBase | |
| static const char *const | typeName |
| Typename for Field. More... | |
| static bool | allowConstructFromLargerSize = false |
| Permit read construct from a larger size. More... | |
| Protected Member Functions inherited from UList< T > | |
| void | setAddressableSize (const label n) noexcept |
| Set addressed size to be inconsistent with allocated storage. More... | |
| void | size (const label n) |
| Older name for setAddressableSize. More... | |
| void | writeEntry (Ostream &os) const |
| Write the UList with its compound type. More... | |
| labelRange | validateRange (const labelRange &requestedRange) const |
| UList< T > & | operator= (const UList< T > &)=delete |
| No copy assignment (default: shallow copy) More... | |
| void | writeEntry (Ostream &os) const |
| void | writeEntry (Ostream &os) const |
Hanning window.
The window is described by the function
\[ wf = (1 - \alpha) - \alpha cos(2 \pi t/m); \]
Where:
| \( \alpha \) | = | Coefficient with a default value of 0.5 |
| \( t \) | = | time |
| \( m \) | = | window width |
The window can be further manipulated by the controls:
symmetric: force the window to be symmetricextended: extend the window by 1 element at start and end to produce non-zero values at the start and end positions. Note: window is normalised to preserve energy content| Hanning | ( | const dictionary & | dict, |
| const label | nSamples | ||
| ) |
Construct from dictionary.
Definition at line 47 of file Hanning.C.
References Hanning::alpha_, Foam::cos(), Hanning::extended_, forAll, windowModel::nSamples(), Foam::sqr(), Foam::sqrt(), Foam::sum(), Foam::sumSqr(), Hanning::symmetric_, and Foam::constant::mathematical::twoPi().
|
virtualdefault |
Destructor.
| TypeName | ( | "Hanning" | ) |
Runtime type information.
| bool symmetric | ( | ) | const |
| bool extended | ( | ) | const |
| Foam::scalar alpha | ( | ) | const |
Return the window coefficient.
Definition at line 107 of file Hanning.C.
References Hanning::alpha_.
|
protected |
Symmetric switch.
Definition at line 94 of file Hanning.H.
Referenced by Hanning::Hanning(), and Hanning::symmetric().
|
protected |
Extended switch.
Definition at line 97 of file Hanning.H.
Referenced by Hanning::extended(), and Hanning::Hanning().
|
protected |
Window coefficient, default = 0.5.
Definition at line 100 of file Hanning.H.
Referenced by Hanning::alpha(), and Hanning::Hanning().
1.9.5