amr_wind::BreakingWaves Class Reference

#include <BreakingWaves.H>

Inheritance diagram for amr_wind::BreakingWaves:

Collaboration diagram for amr_wind::BreakingWaves:

Public Member Functions
	BreakingWaves (CFDSim &sim)
	~BreakingWaves () override
void	initialize_fields (int level, const amrex::Geometry &geom) override
void	post_init_actions () override
void	post_regrid_actions () override
void	pre_advance_work () override
void	post_advance_work () override

Static Public Member Functions
static std::string	identifier ()

Private Attributes
const CFDSim &	m_sim
Field &	m_velocity
Field &	m_levelset
Field &	m_density
amrex::Real	m_tke0 {0.000001}
	initial tke value
amrex::Real	m_sdr0 {1.0}
	initial sdr value
amrex::Real	m_amplitude {0.1}
	Initial free surface amplitude magnitude.
amrex::Real	m_air_vel_shear_rate {0.1}
amrex::Real	m_wavelength {2.0}
	Initial free surface wavelength.
amrex::Real	m_waterlevel {0.0}
	Initial zero-level free-surface water depth.
bool	m_laminar {false}

Detailed Description

Numerical Wave Basin physics

Constructor & Destructor Documentation

BreakingWaves()

amr_wind::BreakingWaves::BreakingWaves ( CFDSim & sim )

explicit

~BreakingWaves()

amr_wind::BreakingWaves::~BreakingWaves ( )

overridedefault

Member Function Documentation

identifier()

static std::string amr_wind::BreakingWaves::identifier ( )

inlinestatic

initialize_fields()

void amr_wind::BreakingWaves::initialize_fields ( int level, const amrex::Geometry & geom )

override

Initialize the velocity and vof fields at the beginning of the simulation.

post_advance_work()

void amr_wind::BreakingWaves::post_advance_work ( )

inlineoverride

post_init_actions()

void amr_wind::BreakingWaves::post_init_actions ( )

inlineoverride

post_regrid_actions()

void amr_wind::BreakingWaves::post_regrid_actions ( )

inlineoverride

pre_advance_work()

void amr_wind::BreakingWaves::pre_advance_work ( )

inlineoverride

Member Data Documentation

m_air_vel_shear_rate

amrex::Real amr_wind::BreakingWaves::m_air_vel_shear_rate {0.1}

private

m_amplitude

amrex::Real amr_wind::BreakingWaves::m_amplitude {0.1}

private

Initial free surface amplitude magnitude.

m_density

Field& amr_wind::BreakingWaves::m_density

private

m_laminar

bool amr_wind::BreakingWaves::m_laminar {false}

private

m_levelset

Field& amr_wind::BreakingWaves::m_levelset

private

m_sdr0

amrex::Real amr_wind::BreakingWaves::m_sdr0 {1.0}

private

initial sdr value

m_sim

const CFDSim& amr_wind::BreakingWaves::m_sim

private

m_tke0

amrex::Real amr_wind::BreakingWaves::m_tke0 {0.000001}

private

initial tke value

m_velocity

Field& amr_wind::BreakingWaves::m_velocity

private

m_waterlevel

amrex::Real amr_wind::BreakingWaves::m_waterlevel {0.0}

private

Initial zero-level free-surface water depth.

m_wavelength

amrex::Real amr_wind::BreakingWaves::m_wavelength {2.0}

private

Initial free surface wavelength.

---

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

• /home/runner/work/amr-wind/amr-wind/amr-wind/physics/multiphase/BreakingWaves.H
• /home/runner/work/amr-wind/amr-wind/amr-wind/physics/multiphase/BreakingWaves.cpp