amr_wind::OceanWavesBoundary Class Reference

#include <OceanWavesBoundary.H>

Collaboration diagram for amr_wind::OceanWavesBoundary:

Public Member Functions
	OceanWavesBoundary (CFDSim &)
void	post_init_actions ()
void	set_velocity (const int lev, const amrex::Real time, const Field &fld, amrex::MultiFab &mfab, const int dcomp=0, const int orig_comp=0) const
void	set_vof (const int lev, const amrex::Real time, const Field &fld, amrex::MultiFab &mfab) const
void	set_density (const int lev, const amrex::Real time, const Field &fld, amrex::MultiFab &mfab) const
void	set_inflow_sibling_velocity (const int lev, const amrex::Real time, const Field &fld, amrex::Array< amrex::MultiFab *, AMREX_SPACEDIM > mfabs) const
void	record_boundary_data_time (const amrex::Real time)
amrex::Real	get_boundary_data_time () const

Private Attributes
const amr_wind::SimTime &	m_time
const FieldRepo &	m_repo
const amrex::AmrCore &	m_mesh
Field &	m_ow_velocity
Field &	m_ow_vof
IntField *	m_terrain_blank_ptr {nullptr}
bool	m_activate_ow_bndry {true}
bool	m_vof_exists {true}
bool	m_terrain_exists {false}
amrex::Real	m_bndry_time {0.0}
amrex::Real	m_rho1 {-1.0}

Detailed Description

Interface for Ocean Waves boundary data

This class performs the necessary field operations to provide available wave data at the boundaries

Constructor & Destructor Documentation

OceanWavesBoundary()

amr_wind::OceanWavesBoundary::OceanWavesBoundary ( CFDSim & sim )

explicit

Member Function Documentation

get_boundary_data_time()

amrex::Real amr_wind::OceanWavesBoundary::get_boundary_data_time ( ) const

inline

post_init_actions()

void amr_wind::OceanWavesBoundary::post_init_actions

(

)

record_boundary_data_time()

void amr_wind::OceanWavesBoundary::record_boundary_data_time ( const amrex::Real time )

inline

set_density()

void amr_wind::OceanWavesBoundary::set_density	(	const int	lev,
		const amrex::Real	time,
		const Field &	fld,
		amrex::MultiFab &	mfab ) const

set_inflow_sibling_velocity()

void amr_wind::OceanWavesBoundary::set_inflow_sibling_velocity	(	const int	lev,
		const amrex::Real	time,
		const Field &	fld,
		amrex::Array< amrex::MultiFab *, AMREX_SPACEDIM >	mfabs ) const

set_velocity()

void amr_wind::OceanWavesBoundary::set_velocity	(	const int	lev,
		const amrex::Real	time,
		const Field &	fld,
		amrex::MultiFab &	mfab,
		const int	dcomp = 0,
		const int	orig_comp = 0 ) const

set_vof()

void amr_wind::OceanWavesBoundary::set_vof	(	const int	lev,
		const amrex::Real	time,
		const Field &	fld,
		amrex::MultiFab &	mfab ) const

Member Data Documentation

m_activate_ow_bndry

bool amr_wind::OceanWavesBoundary::m_activate_ow_bndry {true}

private

m_bndry_time

amrex::Real amr_wind::OceanWavesBoundary::m_bndry_time {0.0}

private

m_mesh

const amrex::AmrCore& amr_wind::OceanWavesBoundary::m_mesh

private

m_ow_velocity

Field& amr_wind::OceanWavesBoundary::m_ow_velocity

private

m_ow_vof

Field& amr_wind::OceanWavesBoundary::m_ow_vof

private

m_repo

const FieldRepo& amr_wind::OceanWavesBoundary::m_repo

private

m_rho1

amrex::Real amr_wind::OceanWavesBoundary::m_rho1 {-1.0}

private

m_terrain_blank_ptr

IntField* amr_wind::OceanWavesBoundary::m_terrain_blank_ptr {nullptr}

private

m_terrain_exists

bool amr_wind::OceanWavesBoundary::m_terrain_exists {false}

private

m_time

const amr_wind::SimTime& amr_wind::OceanWavesBoundary::m_time

private

m_vof_exists

bool amr_wind::OceanWavesBoundary::m_vof_exists {true}

private

---

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

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