amr_wind::pde::icns::GeostrophicForcing Class Reference

#include <GeostrophicForcing.H>

Inheritance diagram for amr_wind::pde::icns::GeostrophicForcing:

Collaboration diagram for amr_wind::pde::icns::GeostrophicForcing:

Public Member Functions
	GeostrophicForcing (const CFDSim &)
	~GeostrophicForcing () override
void	operator() (const int lev, const amrex::MFIter &mfi, const amrex::Box &bx, const FieldState fstate, const amrex::Array4< amrex::Real > &src_term) const override

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

Private Attributes
const SimTime &	m_time
const amrex::AmrCore &	m_mesh
std::string	m_vel_timetable
	File name for target velocity time table.
amrex::Vector< amrex::Real >	m_time_table
	Velocity forcing time table.
amrex::Vector< amrex::Real >	m_speed_table
	Velocity forcing speed table.
amrex::Vector< amrex::Real >	m_direction_table
	Velocity forcing direction table.
amrex::Real	m_coriolis_factor
	Coriolis factor.
bool	m_use_phase_ramp {false}
	Activated when water is present in domain.
int	m_n_band {2}
	Number of cells in band to prevent forcing near liquid.
amrex::Vector< amrex::Real >	m_target_vel {0.0, 0.0, 0.0}
	Target velocity.
amrex::Vector< amrex::Real >	m_g_forcing {0.0, 0.0, 0.0}
	Forcing source term (pressure gradient)
bool	m_is_horizontal {false}
amrex::Real	m_forcing_mphase0
	Height from water interface where force is off.
amrex::Real	m_forcing_mphase1
	Height from water interface over which force is ramped.
amrex::Real	m_water_level
	Local storage of interface location.
const Field *	m_vof
	VOF field, to avoid forcing on liquid above force-off height.

Detailed Description

Apply source term equivalent to drive the flow to match given geostrophic wind

Constructor & Destructor Documentation

GeostrophicForcing()

amr_wind::pde::icns::GeostrophicForcing::GeostrophicForcing ( const CFDSim & sim )

explicit

Geostrophic forcing term for ABL

Parameters are read from the GeostrophicWind and CorolisForcing namespace in the input file. The following parameters are available:

• rotational_time_period Time period for planetary rotation (default: 86400 seconds) in the CoriolisForcing namespace
• geostrophic_wind Geostrophic wind above capping inversion in the GeostrophicForcing namespace

~GeostrophicForcing()

amr_wind::pde::icns::GeostrophicForcing::~GeostrophicForcing ( )

overridedefault

Member Function Documentation

identifier()

static std::string amr_wind::pde::icns::GeostrophicForcing::identifier ( )

inlinestatic

operator()()

void amr_wind::pde::icns::GeostrophicForcing::operator() ( const int lev, const amrex::MFIter & mfi, const amrex::Box & bx, const FieldState fstate, const amrex::Array4< amrex::Real > & src_term ) const

override

Member Data Documentation

m_coriolis_factor

amrex::Real amr_wind::pde::icns::GeostrophicForcing::m_coriolis_factor

private

Coriolis factor.

m_direction_table

amrex::Vector<amrex::Real> amr_wind::pde::icns::GeostrophicForcing::m_direction_table

private

Velocity forcing direction table.

m_forcing_mphase0

amrex::Real amr_wind::pde::icns::GeostrophicForcing::m_forcing_mphase0

private

Height from water interface where force is off.

m_forcing_mphase1

amrex::Real amr_wind::pde::icns::GeostrophicForcing::m_forcing_mphase1

private

Height from water interface over which force is ramped.

m_g_forcing

amrex::Vector<amrex::Real> amr_wind::pde::icns::GeostrophicForcing::m_g_forcing {0.0, 0.0, 0.0}

private

Forcing source term (pressure gradient)

m_is_horizontal

bool amr_wind::pde::icns::GeostrophicForcing::m_is_horizontal {false}

private

m_mesh

const amrex::AmrCore& amr_wind::pde::icns::GeostrophicForcing::m_mesh

private

m_n_band

int amr_wind::pde::icns::GeostrophicForcing::m_n_band {2}

private

Number of cells in band to prevent forcing near liquid.

m_speed_table

amrex::Vector<amrex::Real> amr_wind::pde::icns::GeostrophicForcing::m_speed_table

private

Velocity forcing speed table.

m_target_vel

amrex::Vector<amrex::Real> amr_wind::pde::icns::GeostrophicForcing::m_target_vel {0.0, 0.0, 0.0}

private

Target velocity.

m_time

const SimTime& amr_wind::pde::icns::GeostrophicForcing::m_time

private

m_time_table

amrex::Vector<amrex::Real> amr_wind::pde::icns::GeostrophicForcing::m_time_table

private

Velocity forcing time table.

m_use_phase_ramp

bool amr_wind::pde::icns::GeostrophicForcing::m_use_phase_ramp {false}

private

Activated when water is present in domain.

m_vel_timetable

std::string amr_wind::pde::icns::GeostrophicForcing::m_vel_timetable

private

File name for target velocity time table.

m_vof

const Field* amr_wind::pde::icns::GeostrophicForcing::m_vof

private

VOF field, to avoid forcing on liquid above force-off height.

m_water_level

amrex::Real amr_wind::pde::icns::GeostrophicForcing::m_water_level

private

Local storage of interface location.

---

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

• /home/runner/work/amr-wind/amr-wind/amr-wind/equation_systems/icns/source_terms/GeostrophicForcing.H
• /home/runner/work/amr-wind/amr-wind/amr-wind/equation_systems/icns/source_terms/GeostrophicForcing.cpp