amr_wind::pde::icns::GravityForcing Class Reference

#include <GravityForcing.H>

Inheritance diagram for amr_wind::pde::icns::GravityForcing:

Collaboration diagram for amr_wind::pde::icns::GravityForcing:

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

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

Private Attributes
amrex::Vector< amrex::Real >	m_gravity {0.0, 0.0, -9.81}
Field *	m_rho {nullptr}
Field *	m_rho0 {nullptr}
bool	m_use_perturb_pressure {false}
bool	m_use_reference_density {false}
amrex::Real	m_rho0_const {1.0}

Detailed Description

Gravity Forcing term

Constructor & Destructor Documentation

GravityForcing()

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

explicit

Gravity Forcing source term

Reads in the following parameters from incflo namespace:

• gravity acceleration due to gravity (m/s)

~GravityForcing()

amr_wind::pde::icns::GravityForcing::~GravityForcing ( )

overridedefault

Member Function Documentation

identifier()

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

inlinestatic

operator()()

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

override

Add the Gravity source term to the forcing array

Parameters

lev	AMR level
mfi	multiFab index
bx	Box to operate on
fstate	FieldState field
vel_forces	Forcing source term

Member Data Documentation

m_gravity

amrex::Vector<amrex::Real> amr_wind::pde::icns::GravityForcing::m_gravity {0.0, 0.0, -9.81}

private

m_rho

Field* amr_wind::pde::icns::GravityForcing::m_rho {nullptr}

private

m_rho0

Field* amr_wind::pde::icns::GravityForcing::m_rho0 {nullptr}

private

m_rho0_const

amrex::Real amr_wind::pde::icns::GravityForcing::m_rho0_const {1.0}

private

m_use_perturb_pressure

bool amr_wind::pde::icns::GravityForcing::m_use_perturb_pressure {false}

private

m_use_reference_density

bool amr_wind::pde::icns::GravityForcing::m_use_reference_density {false}

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