wave_theory_utilities.WaveTheory Class Reference

Base class for waves calculations. More...

Inheritance diagram for wave_theory_utilities.WaveTheory:

Collaboration diagram for wave_theory_utilities.WaveTheory:

Public Member Functions
def	__init__ (self, depth, gravity=9.81, *period=0, wavelength=0, amplitude=0)
def	SetPeriod (self, period)
def	SetWavelength (self, wavelength)
def	SetAmplitude (self, amplitude)
def	horizontal_velocity (self)
def	phase_speed (self)
def	wavenumber (self)
def	frequency (self)

Public Attributes
	gravity
	depth
	period
	wavelength
	amplitude

Detailed Description

Base class for waves calculations.

Constructor & Destructor Documentation

__init__()

def wave_theory_utilities.WaveTheory.__init__	(		self,
			depth,
			gravity = 9.81,
		*	period = 0,
			wavelength = 0,
			amplitude = 0
	)

Member Function Documentation

frequency()

def wave_theory_utilities.WaveTheory.frequency

(

self

)

horizontal_velocity()

def wave_theory_utilities.WaveTheory.horizontal_velocity

(

self

)

phase_speed()

def wave_theory_utilities.WaveTheory.phase_speed

(

self

)

SetAmplitude()

def wave_theory_utilities.WaveTheory.SetAmplitude	(		self,
			amplitude
	)

SetPeriod()

def wave_theory_utilities.WaveTheory.SetPeriod	(		self,
			period
	)

SetWavelength()

def wave_theory_utilities.WaveTheory.SetWavelength	(		self,
			wavelength
	)

wavenumber()

def wave_theory_utilities.WaveTheory.wavenumber

(

self

)

Member Data Documentation

amplitude

wave_theory_utilities.WaveTheory.amplitude

depth

wave_theory_utilities.WaveTheory.depth

gravity

wave_theory_utilities.WaveTheory.gravity

period

wave_theory_utilities.WaveTheory.period

wavelength

wave_theory_utilities.WaveTheory.wavelength

---

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

• /home/runner/work/Documentation/Documentation/master/applications/ShallowWaterApplication/python_scripts/utilities/wave_theory_utilities.py