Inheritance diagram for Hanning:

Collaboration diagram for Hanning:

Public Member Functions
	TypeName ("Hanning")

	Hanning (const dictionary &dict, const label nSamples)

virtual	~Hanning ()=default

bool	symmetric () const

bool	extended () const

scalar	alpha () const

Public Member Functions inherited from windowModel
	TypeName ("windowModel")

	declareRunTimeSelectionTable (autoPtr, windowModel, dictionary,(const dictionary &dict, const label nSamples),(dict, nSamples))

	windowModel (const dictionary &dict, const label nSamples)

virtual	~windowModel ()=default

label	nSamples () const

label	nWindow () const

label	nWindowsTotal (label nSamplesTotal) const

label	validate (label n)

template<class Type >
tmp< Field< Type > >	apply (const Field< Type > &fld, const label windowI) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	apply (const Field< Type > &fld, const label windowI) const

Public Member Functions inherited from Field
constexpr	Field () noexcept

	Field (const label len)

	Field (const label len, const Type &val)

	Field (const label len, const Foam::zero)

	Field (const Foam::one, const Type &val)

	Field (const Foam::one, Type &&val)

	Field (const Foam::one, const Foam::zero)

	Field (const Field< Type > &fld)

	Field (const UList< Type > &list)

template<class Addr >
	Field (const IndirectListBase< Type, Addr > &list)

	Field (Field< Type > &&fld)

	Field (List< Type > &&list)

template<int SizeMin>
	Field (DynamicList< Type, SizeMin > &&list)

	Field (const UList< Type > &mapF, const labelUList &mapAddressing)

	Field (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)

	Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)

	Field (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)

	Field (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)

	Field (const UList< Type > &mapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)

	Field (const UList< Type > &mapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)

	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const bool applyFlip=true)

	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)

	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)

	Field (Field< Type > &fld, bool reuse)

	Field (const tmp< Field< Type >> &tfld)

	Field (Istream &is)

	Field (const word &keyword, const dictionary &dict, const label len)

tmp< Field< Type > >	clone () const

void	map (const UList< Type > &mapF, const labelUList &mapAddressing)

void	map (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)

void	map (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)

void	map (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)

void	map (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)

void	map (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const bool applyFlip=true)

void	autoMap (const FieldMapper &map, const bool applyFlip=true)

void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing)

void	rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)

void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)

void	rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)

void	negate ()

tmp< Field< cmptType > >	component (const direction) const

void	replace (const direction, const UList< cmptType > &)

void	replace (const direction, const tmp< Field< cmptType >> &)

void	replace (const direction, const cmptType &)

template<class VSForm >
VSForm	block (const label start) const

tmp< Field< Type > >	T () const

void	writeEntry (const word &keyword, Ostream &os) const

SubField< Type >	slice (const label pos, label len=-1)

const SubField< Type >	slice (const label pos, label len=-1) const

SubField< Type >	slice (const labelRange &range)

const SubField< Type >	slice (const labelRange &range) const

void	operator= (const Field< Type > &)

void	operator= (const tmp< Field< Type >> &)

void	operator= (const UList< Type > &rhs)

void	operator= (const SubField< Type > &rhs)

template<class Addr >
void	operator= (const IndirectListBase< Type, Addr > &rhs)

void	operator= (Field< Type > &&rhs)

void	operator= (List< Type > &&rhs)

template<int SizeMin>
void	operator= (DynamicList< Type, SizeMin > &&rhs)

void	operator= (const Type &val)

void	operator= (const Foam::zero)

template<class Form , class Cmpt , direction nCmpt>
void	operator= (const VectorSpace< Form, Cmpt, nCmpt > &)

void	operator+= (const UList< Type > &)

void	operator+= (const tmp< Field< Type >> &)

void	operator-= (const UList< Type > &)

void	operator-= (const tmp< Field< Type >> &)

void	operator*= (const UList< scalar > &)

void	operator*= (const tmp< Field< scalar >> &)

void	operator/= (const UList< scalar > &)

void	operator/= (const tmp< Field< scalar >> &)

void	operator+= (const Type &)

void	operator-= (const Type &)

void	operator*= (const scalar &)

void	operator/= (const scalar &)

template<class Type >
	Field (const UList< Type > &mapF, const labelUList &mapAddressing)

template<class Type >
	Field (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)

template<class Type >
	Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &mapWeights)

template<class Type >
	Field (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &mapWeights)

template<class Type >
	Field (const UList< Type > &mapF, const FieldMapper &mapper, const bool applyFlip)

template<class Type >
	Field (const UList< Type > &mapF, const FieldMapper &mapper, const Type &defaultValue, const bool applyFlip)

template<class Type >
	Field (const UList< Type > &mapF, const FieldMapper &mapper, const UList< Type > &defaultValues, const bool applyFlip)

template<class Type >
	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &mapper, const bool applyFlip)

template<class Type >
	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &mapper, const Type &defaultValue, const bool applyFlip)

template<class Type >
	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &mapper, const UList< Type > &defaultValues, const bool applyFlip)

template<class Type >
	Field (const word &keyword, const dictionary &dict, const label len)

template<class Type >
void	operator= (const Field< Type > &rhs)

template<class Type >
void	operator= (const tmp< Field > &rhs)

template<class Type >
constexpr	Field () noexcept

template<class Type >
	Field (const label len)

template<class Type >
	Field (const label len, const Type &val)

template<class Type >
	Field (const label len, const Foam::zero)

template<class Type >
	Field (const Foam::one, const Type &val)

template<class Type >
	Field (const Foam::one, Type &&val)

template<class Type >
	Field (const Foam::one, const Foam::zero)

template<class Type >
	Field (const Field< Type > &fld)

template<class Type >
	Field (const UList< Type > &list)

template<class Type >
	Field (Field< Type > &&fld)

template<class Type >
	Field (List< Type > &&list)

template<class Type >
	Field (Field< Type > &fld, bool reuse)

template<class Type >
	Field (const tmp< Field< Type >> &tfld)

template<class Type >
	Field (Istream &is)

template<class Type >
void	operator= (const UList< Type > &rhs)

template<class Type >
void	operator= (const SubField< Type > &rhs)

template<class Type >
void	operator= (Field< Type > &&rhs)

template<class Type >
void	operator= (List< Type > &&rhs)

template<class Type >
void	operator= (const Type &val)

template<class Type >
void	operator= (const Foam::zero)

Protected Attributes
bool	symmetric_

bool	extended_

scalar	alpha_

Protected Attributes inherited from windowModel
label	nOverlapSamples_

label	nWindow_

Additional Inherited Members
Public Types inherited from Field
typedef pTraits< Type >::cmptType	cmptType

typedef SubField< Type >	subField

Static Public Member Functions inherited from windowModel
static autoPtr< windowModel >	New (const dictionary &dict, const label nSamples)

Static Public Member Functions inherited from Field
static const Field< Type > &	null ()

static autoPtr< Field< Type > >	New (Istream &is)

template<class Type2 >
static tmp< Field< Type > >	NewCalculatedType (const Field< Type2 > &f)

Detailed Description

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
	=	time
	=	window width

The window can be further manipulated by the controls:

symmetric: force the window to be symmetric
extended: 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

Source files

Definition at line 80 of file Hanning.H.

Constructor & Destructor Documentation

◆ Hanning()

Hanning	(	const dictionary &	dict,
		const label	nSamples
	)

Definition at line 40 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().

Here is the call graph for this function:

◆ ~Hanning()

virtual ~Hanning ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "Hanning" )

◆ symmetric()

bool symmetric ( ) const

Definition at line 88 of file Hanning.C.

References Hanning::symmetric_.

◆ extended()

bool extended ( ) const

Definition at line 94 of file Hanning.C.

References Hanning::extended_.

◆ alpha()

Foam::scalar alpha ( ) const

Definition at line 100 of file Hanning.C.

References Hanning::alpha_.

Member Data Documentation

◆ symmetric_

bool symmetric_

protected

Definition at line 90 of file Hanning.H.

Referenced by Hanning::Hanning(), and Hanning::symmetric().

◆ extended_

bool extended_

protected

Definition at line 93 of file Hanning.H.

Referenced by Hanning::extended(), and Hanning::Hanning().

◆ alpha_

scalar alpha_

protected

Definition at line 96 of file Hanning.H.

Referenced by Hanning::alpha(), and Hanning::Hanning().

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

src/randomProcesses/windowModels/Hanning/Hanning.H
src/randomProcesses/windowModels/Hanning/Hanning.C

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Hanning()

◆ ~Hanning()

Member Function Documentation

◆ TypeName()

◆ symmetric()

◆ extended()

◆ alpha()

Member Data Documentation

◆ symmetric_

◆ extended_

◆ alpha_