JONSWAP Class Reference
Inheritance diagram for JONSWAP:
Collaboration diagram for JONSWAP:

Public Member Functions

 TypeName ("JONSWAP")
 Runtime type information. More...
 
 JONSWAP (const JONSWAP &spectrum)
 Construct a copy. More...
 
 JONSWAP (const dictionary &dict, const scalar g)
 Construct from a dictionary and gravity. More...
 
virtual autoPtr< waveSpectrumclone () const
 Construct a clone. More...
 
virtual ~JONSWAP ()
 Destructor. More...
 
virtual tmp< scalarFieldS (const scalarField &f) const
 Evaluate the wave spectral density at the given frequencies [m^2/Hz]. More...
 
virtual scalar fFraction (const scalar fraction) const
 Return the frequency below which a given fraction of the spectrum's. More...
 
virtual void write (Ostream &os) const
 Write. More...
 
- Public Member Functions inherited from waveSpectrum
 TypeName ("waveSpectrum")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, waveSpectrum, dictionary,(const dictionary &dict, const scalar g),(dict, g))
 
 waveSpectrum (const waveSpectrum &spectrum)
 Construct a copy. More...
 
 waveSpectrum (const dictionary &dict, const scalar g)
 Construct from a dictionary and gravity. More...
 
virtual ~waveSpectrum ()
 Destructor. More...
 
scalar g () const
 Access the gravitation acceleration [m/s^2]. More...
 
virtual tmp< scalarFieldintegralS (const scalarField &f) const
 Evaluate the integral of the wave spectral density at the given. More...
 
virtual tmp< scalarFieldintegralFS (const scalarField &f) const
 Evaluate the integral of the wave spectral density multiplied by. More...
 
void operator= (const waveSpectrum &)=delete
 Disallow default bitwise assignment. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from waveSpectrum
static autoPtr< waveSpectrumNew (const dictionary &dict, const scalar g)
 Select given a dictionary and gravity. More...
 
- Protected Member Functions inherited from waveSpectrum
scalar fFraction (const scalar fraction, const scalar f1) const
 Return the frequency below which a given fraction of the spectrum's. More...
 

Detailed Description

Definition at line 107 of file JONSWAP.H.

Constructor & Destructor Documentation

◆ JONSWAP() [1/2]

JONSWAP ( const JONSWAP spectrum)

Construct a copy.

Definition at line 46 of file JONSWAP.C.

Referenced by JONSWAP::clone().

Here is the caller graph for this function:

◆ JONSWAP() [2/2]

JONSWAP ( const dictionary dict,
const scalar  g 
)

Construct from a dictionary and gravity.

Definition at line 58 of file JONSWAP.C.

◆ ~JONSWAP()

~JONSWAP ( )
virtual

Destructor.

Definition at line 73 of file JONSWAP.C.

Member Function Documentation

◆ TypeName()

TypeName ( "JONSWAP"  )

Runtime type information.

◆ clone()

virtual autoPtr<waveSpectrum> clone ( ) const
inlinevirtual

Construct a clone.

Implements waveSpectrum.

Definition at line 138 of file JONSWAP.H.

References JONSWAP::JONSWAP().

Here is the call graph for this function:

◆ S()

Foam::tmp< Foam::scalarField > S ( const scalarField f) const
virtual

Evaluate the wave spectral density at the given frequencies [m^2/Hz].

Implements waveSpectrum.

Definition at line 79 of file JONSWAP.C.

References alpha(), Foam::exp(), f(), Foam::pos(), Foam::pow(), Foam::pow4(), Foam::pow5(), Foam::constant::physicoChemical::sigma, Foam::sqr(), and Foam::constant::mathematical::twoPi().

Here is the call graph for this function:

◆ fFraction()

Foam::scalar fFraction ( const scalar  fraction) const
virtual

Return the frequency below which a given fraction of the spectrum's.

total energy falls []

Implements waveSpectrum.

Definition at line 93 of file JONSWAP.C.

References waveSpectrum::fFraction(), Foam::pow(), Foam::pow025(), Foam::sqr(), and Foam::constant::mathematical::twoPi().

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Write.

Reimplemented from waveSpectrum.

Definition at line 101 of file JONSWAP.C.

References waveSpectrum::write(), Foam::writeEntry(), and Foam::writeEntryIfDifferent().

Here is the call graph for this function:

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