DensityBuoyancy Class Reference

AMR-Wind API: amr_wind::pde::icns::DensityBuoyancy Class Reference
AMR-Wind API v0.1.0
CFD solver for wind plant simulations
Loading...
Searching...
No Matches

#include <DensityBuoyancy.H>

Inheritance diagram for amr_wind::pde::icns::DensityBuoyancy:
[legend]
Collaboration diagram for amr_wind::pde::icns::DensityBuoyancy:
[legend]

Public Member Functions

 DensityBuoyancy (const CFDSim &sim)
 
 ~DensityBuoyancy () 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}
 
amrex::Real m_rho_0 {1.0}
 
Fieldm_density
 

Detailed Description

Buoyancy term from density variations

See also
RayleighTaylor

Constructor & Destructor Documentation

◆ DensityBuoyancy()

amr_wind::pde::icns::DensityBuoyancy::DensityBuoyancy ( const CFDSim & sim)
explicit

Density based buoyancy source term

Reads in the following parameters from incflo namespace:

  • gravity acceleration due to gravity (m/s)
  • reference density Optional, default = 1.0

◆ ~DensityBuoyancy()

amr_wind::pde::icns::DensityBuoyancy::~DensityBuoyancy ( )
overridedefault

Member Function Documentation

◆ identifier()

static std::string amr_wind::pde::icns::DensityBuoyancy::identifier ( )
inlinestatic

◆ operator()()

void amr_wind::pde::icns::DensityBuoyancy::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 Boussinesq source term to the forcing array

Parameters
levAMR level
mfimultiFab index
bxBox to operate on
fstatefield state
vel_forcesForcing source term, activated when density varies from rho_0

Member Data Documentation

◆ m_density

Field& amr_wind::pde::icns::DensityBuoyancy::m_density
private

◆ m_gravity

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

◆ m_rho_0

amrex::Real amr_wind::pde::icns::DensityBuoyancy::m_rho_0 {1.0}
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/DensityBuoyancy.H
  • /home/runner/work/amr-wind/amr-wind/amr-wind/equation_systems/icns/source_terms/DensityBuoyancy.cpp