Class for generating fifth order Stokes wave using Fenton's (Stokes) wave theory. More...

#include </home/runner/work/IBAMR/IBAMR/include/ibamr/FifthOrderStokesWaveGenerator.h>

Inheritance diagram for IBAMR::FifthOrderStokesWaveGenerator:

Public Member Functions
	FifthOrderStokesWaveGenerator (const std::string &object_name, SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > input_db)

double	getSurfaceElevation (double x, double time) const override

double	getVelocity (double x, double z_plus_d, double time, int comp_idx) const override

Public Member Functions inherited from IBAMR::StokesWaveGeneratorStrategy
	StokesWaveGeneratorStrategy (const std::string &object_name, SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > input_db)
	Constructor of the class.

virtual	~StokesWaveGeneratorStrategy ()=default
	Destructor of the class.

double	getWaterDepth () const

double	getWaveAngularFrequency () const

double	getWaveNumber () const

double	getWaveAmplitude () const

double	getGravity () const

Additional Inherited Members
Public Attributes inherited from IBAMR::StokesWaveGeneratorStrategy
WaveGenerationData	d_wave_gen_data

Protected Member Functions inherited from IBAMR::StokesWaveGeneratorStrategy
void	getFromInput (SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > db)

Protected Attributes inherited from IBAMR::StokesWaveGeneratorStrategy
std::string	d_object_name

double	d_depth
	Wave parameters. More...

double	d_omega

double	d_wave_number

double	d_amplitude

double	d_gravity

bool	d_deep_water_limit = false

Detailed Description

Class for generating fifth order Stokes wave using Fenton's (Stokes) wave theory.

Member Function Documentation

double IBAMR::FifthOrderStokesWaveGenerator::getSurfaceElevation	(	double	x,
		double	time
	)		const

overridevirtual

Get surface elevation at a specified horizontal position and time.

double IBAMR::FifthOrderStokesWaveGenerator::getVelocity	(	double	x,
		double	z_plus_d,
		double	time,
		int	comp_idx
	)		const

overridevirtual

Get velocity component at a specified position and time.

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

/home/runner/work/IBAMR/IBAMR/include/ibamr/FifthOrderStokesWaveGenerator.h
/home/runner/work/IBAMR/IBAMR/src/wave_generation/FifthOrderStokesWaveGenerator.cpp