amr_wind::ocean_waves::OceanWaves Class Reference

#include <OceanWaves.H>

Inheritance diagram for amr_wind::ocean_waves::OceanWaves:

Collaboration diagram for amr_wind::ocean_waves::OceanWaves:

Public Member Functions
	OceanWaves (CFDSim &)
	~OceanWaves () override
void	initialize_fields (int, const amrex::Geometry &) override
void	pre_init_actions () override
void	post_init_actions () override
void	post_regrid_actions () override
void	pre_advance_work () override
void	pre_predictor_work () override
void	post_advance_work () override
const OceanWavesBoundary &	ow_bndry () const

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

Protected Member Functions
virtual void	prepare_outputs ()

Private Attributes
CFDSim &	m_sim
std::unique_ptr< OceanWavesModel >	m_owm
	Unique pointer to the ocean waves model.
std::unique_ptr< OceanWavesBoundary >	m_ow_bndry
	Ocean waves boundary instance.
Field &	m_ow_levelset
	Ocean waves target free surface levelset function.
Field &	m_ow_vof
	Ocean waves target volume-of-fluid.
Field &	m_ow_velocity
	Ocean waves target velocity.
bool	m_multiphase_mode {true}

Detailed Description

ocean waves modeling

This class provides an interface to model

See also

WaveModel

Constructor & Destructor Documentation

OceanWaves()

amr_wind::ocean_waves::OceanWaves::OceanWaves ( CFDSim & sim )

explicit

~OceanWaves()

amr_wind::ocean_waves::OceanWaves::~OceanWaves ( )

overridedefault

Member Function Documentation

identifier()

static std::string amr_wind::ocean_waves::OceanWaves::identifier ( )

inlinestatic

initialize_fields()

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

override

ow_bndry()

const OceanWavesBoundary & amr_wind::ocean_waves::OceanWaves::ow_bndry ( ) const

inline

post_advance_work()

void amr_wind::ocean_waves::OceanWaves::post_advance_work ( )

override

post_init_actions()

void amr_wind::ocean_waves::OceanWaves::post_init_actions ( )

override

post_regrid_actions()

void amr_wind::ocean_waves::OceanWaves::post_regrid_actions ( )

override

pre_advance_work()

void amr_wind::ocean_waves::OceanWaves::pre_advance_work ( )

override

pre_init_actions()

void amr_wind::ocean_waves::OceanWaves::pre_init_actions ( )

override

pre_predictor_work()

void amr_wind::ocean_waves::OceanWaves::pre_predictor_work ( )

override

prepare_outputs()

void amr_wind::ocean_waves::OceanWaves::prepare_outputs ( )

protectedvirtual

Member Data Documentation

m_multiphase_mode

bool amr_wind::ocean_waves::OceanWaves::m_multiphase_mode {true}

private

Multiphase mode forces the velocity and vof in the domain When off, single-phase mode simply provides the target variables, and forcing is handled in other parts of the code

m_ow_bndry

std::unique_ptr<OceanWavesBoundary> amr_wind::ocean_waves::OceanWaves::m_ow_bndry

private

Ocean waves boundary instance.

m_ow_levelset

Field& amr_wind::ocean_waves::OceanWaves::m_ow_levelset

private

Ocean waves target free surface levelset function.

m_ow_velocity

Field& amr_wind::ocean_waves::OceanWaves::m_ow_velocity

private

Ocean waves target velocity.

m_ow_vof

Field& amr_wind::ocean_waves::OceanWaves::m_ow_vof

private

Ocean waves target volume-of-fluid.

m_owm

std::unique_ptr<OceanWavesModel> amr_wind::ocean_waves::OceanWaves::m_owm

private

Unique pointer to the ocean waves model.

m_sim

CFDSim& amr_wind::ocean_waves::OceanWaves::m_sim

private

---

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

• /home/runner/work/amr-wind/amr-wind/amr-wind/ocean_waves/OceanWaves.H
• /home/runner/work/amr-wind/amr-wind/amr-wind/ocean_waves/OceanWaves.cpp