amr_wind::pde::icns::RayleighDamping Class Reference

#include <RayleighDamping.H>

Inheritance diagram for amr_wind::pde::icns::RayleighDamping:

Collaboration diagram for amr_wind::pde::icns::RayleighDamping:

Public Member Functions
	RayleighDamping (const CFDSim &)
	~RayleighDamping () 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 amrex::AmrCore &	m_mesh
const Field &	m_velocity
amrex::Vector< amrex::Real >	m_ref_vel {15.0, 0.0, 0.0}
	Reference velocity defined as an input.
amrex::Real	m_dRD {500.}
	Full length of the damping layer.
amrex::Real	m_dFull {300.}
	Damping length.
amrex::Real	m_tau {5.0}
	Time scale defined by the user.
amrex::Vector< int >	m_fcoord {1, 1, 1}
	Which coordinate directions are forced.

Detailed Description

Apply Rayleigh damping as a source terms

The implementation is based on a private communication I (G. Deskos) had with Matt Churchfield

Constructor & Destructor Documentation

RayleighDamping()

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

explicit

~RayleighDamping()

amr_wind::pde::icns::RayleighDamping::~RayleighDamping ( )

overridedefault

Member Function Documentation

identifier()

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

inlinestatic

operator()()

void amr_wind::pde::icns::RayleighDamping::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_dFull

amrex::Real amr_wind::pde::icns::RayleighDamping::m_dFull {300.}

private

Damping length.

m_dRD

amrex::Real amr_wind::pde::icns::RayleighDamping::m_dRD {500.}

private

Full length of the damping layer.

m_fcoord

amrex::Vector<int> amr_wind::pde::icns::RayleighDamping::m_fcoord {1, 1, 1}

private

Which coordinate directions are forced.

m_mesh

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

private

m_ref_vel

amrex::Vector<amrex::Real> amr_wind::pde::icns::RayleighDamping::m_ref_vel {15.0, 0.0, 0.0}

private

Reference velocity defined as an input.

m_tau

amrex::Real amr_wind::pde::icns::RayleighDamping::m_tau {5.0}

private

Time scale defined by the user.

m_velocity

const Field& amr_wind::pde::icns::RayleighDamping::m_velocity

private

---

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/RayleighDamping.H
• /home/runner/work/amr-wind/amr-wind/amr-wind/equation_systems/icns/source_terms/RayleighDamping.cpp