PiersonMoskowitz Class Reference

Inheritance diagram for PiersonMoskowitz:

Collaboration diagram for PiersonMoskowitz:

Public Member Functions
	TypeName ("PiersonMoskowitz")
	Runtime type information. More...
	PiersonMoskowitz (const PiersonMoskowitz &spectrum)
	Construct a copy. More...
	PiersonMoskowitz (const dictionary &dict, const scalar g)
	Construct from a dictionary and gravity. More...
virtual autoPtr< waveSpectrum >	clone () const
	Construct a clone. More...
virtual	~PiersonMoskowitz ()
	Destructor. More...
virtual tmp< scalarField >	S (const scalarField &f) const
	Evaluate the wave spectral density at the given frequencies [m^2/Hz]. More...
virtual tmp< scalarField >	integralS (const scalarField &f) const
	Evaluate the integral of the wave spectral density at the given. 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< scalarField >	integralFS (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< waveSpectrum >	New (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 131 of file PiersonMoskowitz.H.

Constructor & Destructor Documentation

PiersonMoskowitz() [1/2]

PiersonMoskowitz

(

const PiersonMoskowitz &

spectrum

)

Construct a copy.

Definition at line 46 of file PiersonMoskowitz.C.

Referenced by PiersonMoskowitz::clone().

Here is the caller graph for this function:

PiersonMoskowitz() [2/2]

PiersonMoskowitz	(	const dictionary &	dict,
		const scalar	g
	)

Construct from a dictionary and gravity.

Definition at line 58 of file PiersonMoskowitz.C.

~PiersonMoskowitz()

~PiersonMoskowitz ( )

virtual

Destructor.

Definition at line 73 of file PiersonMoskowitz.C.

Member Function Documentation

TypeName()

TypeName

(

"PiersonMoskowitz"

)

Runtime type information.

clone()

virtual autoPtr<waveSpectrum> clone ( ) const

inlinevirtual

Construct a clone.

Implements waveSpectrum.

Definition at line 162 of file PiersonMoskowitz.H.

References PiersonMoskowitz::PiersonMoskowitz().

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 PiersonMoskowitz.C.

References Foam::exp(), f(), Foam::pow4(), Foam::pow5(), Foam::sqr(), Foam::constant::mathematical::twoPi(), and w0.

Here is the call graph for this function:

integralS()

Foam::tmp< Foam::scalarField > integralS ( const scalarField &  f ) const

virtual

Evaluate the integral of the wave spectral density at the given.

frequencies [m^2]

Reimplemented from waveSpectrum.

Definition at line 90 of file PiersonMoskowitz.C.

References Foam::exp(), f(), Foam::pow4(), Foam::sqr(), Foam::constant::mathematical::twoPi(), and w0.

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 power falls []

Implements waveSpectrum.

Definition at line 102 of file PiersonMoskowitz.C.

References Foam::log(), Foam::pow025(), Foam::constant::mathematical::twoPi(), and w0.

Here is the call graph for this function:

write()

void write ( Ostream &  os ) const

virtual

Write.

Reimplemented from waveSpectrum.

Definition at line 112 of file PiersonMoskowitz.C.

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

Here is the call graph for this function:

---

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

• src/waves/waveModels/irregular/waveSpectra/PiersonMoskowitz/PiersonMoskowitz.H
• src/waves/waveModels/irregular/waveSpectra/PiersonMoskowitz/PiersonMoskowitz.C