Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
windowModel Class Reference

Base class for windowing models. More...

Inheritance diagram for windowModel:
Inheritance graph
[legend]
Collaboration diagram for windowModel:
Collaboration graph
[legend]

Public Member Functions

 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)
 

Static Public Member Functions

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)
 

Protected Attributes

label nOverlapSamples_
 
label nWindow_
 

Additional Inherited Members

- Public Types inherited from Field
typedef pTraits< Type >::cmptType cmptType
 
typedef SubField< Type > subField
 

Detailed Description

Base class for windowing models.

Source files

Definition at line 48 of file windowModel.H.

Constructor & Destructor Documentation

◆ windowModel()

windowModel ( const dictionary &  dict,
const label  nSamples 
)

Definition at line 34 of file windowModel.C.

References dict, windowModel::nOverlapSamples_, and windowModel::nSamples().

Here is the call graph for this function:

◆ ~windowModel()

virtual ~windowModel ( )
virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "windowModel"  )

◆ declareRunTimeSelectionTable()

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

◆ New()

Foam::autoPtr< Foam::windowModel > New ( const dictionary &  dict,
const label  nSamples 
)
static

Definition at line 26 of file windowModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, and nSamples().

Referenced by noiseModel::read().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ nSamples()

Foam::label nSamples ( ) const

Definition at line 49 of file windowModel.C.

Referenced by surfaceNoise::calculate(), Hanning::Hanning(), noiseFFT::meanPf(), pointNoise::processData(), noiseFFT::PSDf(), noiseFFT::RMSmeanPf(), and windowModel::windowModel().

Here is the caller graph for this function:

◆ nWindow()

Foam::label nWindow ( ) const

Definition at line 55 of file windowModel.C.

Referenced by noiseFFT::meanPf(), noiseFFT::PSDf(), and noiseFFT::RMSmeanPf().

Here is the caller graph for this function:

◆ nWindowsTotal()

Foam::label nWindowsTotal ( label  nSamplesTotal) const

Definition at line 61 of file windowModel.C.

References nSamples().

Here is the call graph for this function:

◆ validate()

Foam::label validate ( label  n)

Definition at line 69 of file windowModel.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, Foam::nl, and nSamples().

Here is the call graph for this function:

◆ apply() [1/2]

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

Referenced by noiseFFT::meanPf(), noiseFFT::PSDf(), and noiseFFT::RMSmeanPf().

Here is the caller graph for this function:

◆ apply() [2/2]

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

Definition at line 27 of file windowModelTemplates.C.

References Foam::abort(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, fld, Foam::New(), Foam::nl, nSamples(), and Foam::Zero.

Here is the call graph for this function:

Member Data Documentation

◆ nOverlapSamples_

label nOverlapSamples_
protected

Definition at line 58 of file windowModel.H.

Referenced by windowModel::windowModel().

◆ nWindow_

label nWindow_
protected

Definition at line 61 of file windowModel.H.

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17