amr_wind::EkmanSpiral Class Reference

#include <EkmanSpiral.H>

Inheritance diagram for amr_wind::EkmanSpiral:

Collaboration diagram for amr_wind::EkmanSpiral:

Public Member Functions
	EkmanSpiral (const CFDSim &sim)
	~EkmanSpiral () override=default
void	initialize_fields (int level, const amrex::Geometry &geom) override
template<typename T >
amrex::Real	compute_error (const Field &)
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 Member Functions
void	output_error ()

Private Attributes
const amr_wind::SimTime &	m_time
const FieldRepo &	m_repo
const amrex::AmrCore &	m_mesh
Field &	m_velocity
Field &	m_density
amrex::Real	m_rho {1.0}
	initial density value
amrex::Real	m_DE {0.0}
	Ekman depth.
amrex::Real	m_vel {15.0}
	velocity magnitude x-direction only
const int	m_w {18}
	output precision
const std::string	m_output_fname {"ekman_spiral.log"}
	error log file

Detailed Description

Ekman Spiral physics

Constructor & Destructor Documentation

EkmanSpiral()

amr_wind::EkmanSpiral::EkmanSpiral ( const CFDSim & sim )

explicit

~EkmanSpiral()

amr_wind::EkmanSpiral::~EkmanSpiral ( )

overridedefault

Member Function Documentation

compute_error()

template<typename T >

amrex::Real amr_wind::EkmanSpiral::compute_error

(

const Field &

field

)

identifier()

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

inlinestatic

initialize_fields()

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

override

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

output_error()

void amr_wind::EkmanSpiral::output_error ( )

private

post_advance_work()

void amr_wind::EkmanSpiral::post_advance_work ( )

override

post_init_actions()

void amr_wind::EkmanSpiral::post_init_actions ( )

override

post_regrid_actions()

void amr_wind::EkmanSpiral::post_regrid_actions ( )

inlineoverride

pre_advance_work()

void amr_wind::EkmanSpiral::pre_advance_work ( )

inlineoverride

Member Data Documentation

m_DE

amrex::Real amr_wind::EkmanSpiral::m_DE {0.0}

private

Ekman depth.

m_density

Field& amr_wind::EkmanSpiral::m_density

private

m_mesh

const amrex::AmrCore& amr_wind::EkmanSpiral::m_mesh

private

m_output_fname

const std::string amr_wind::EkmanSpiral::m_output_fname {"ekman_spiral.log"}

private

error log file

m_repo

const FieldRepo& amr_wind::EkmanSpiral::m_repo

private

m_rho

amrex::Real amr_wind::EkmanSpiral::m_rho {1.0}

private

initial density value

m_time

const amr_wind::SimTime& amr_wind::EkmanSpiral::m_time

private

m_vel

amrex::Real amr_wind::EkmanSpiral::m_vel {15.0}

private

velocity magnitude x-direction only

m_velocity

Field& amr_wind::EkmanSpiral::m_velocity

private

m_w

const int amr_wind::EkmanSpiral::m_w {18}

private

output precision

---

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

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