DamBreak Class Reference

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

#include <DamBreak.H>

Inheritance diagram for amr_wind::DamBreak:
[legend]
Collaboration diagram for amr_wind::DamBreak:
[legend]

Public Member Functions

 DamBreak (CFDSim &sim)
 
 ~DamBreak () override=default
 
void initialize_fields (int level, const amrex::Geometry &geom) override
 Initialize the levelset and velocity fields for Dam Break simulations.
 
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 Attributes

const CFDSimm_sim
 
Fieldm_velocity
 
Fieldm_levelset
 
Fieldm_density
 
amrex::Vector< amrex::Real > m_loc {0.0, 0.0, 0.0}
 Initial DamBreak location.
 
amrex::Real m_width {0.1}
 dam width value
 
amrex::Real m_height {0.25}
 dam height value
 

Constructor & Destructor Documentation

◆ DamBreak()

amr_wind::DamBreak::DamBreak ( CFDSim & sim)
explicit

◆ ~DamBreak()

amr_wind::DamBreak::~DamBreak ( )
overridedefault

Member Function Documentation

◆ identifier()

static std::string amr_wind::DamBreak::identifier ( )
inlinestatic

◆ initialize_fields()

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

Initialize the levelset and velocity fields for Dam Break simulations.

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

See also
amr_wind::DamBreakFieldInit

◆ post_advance_work()

void amr_wind::DamBreak::post_advance_work ( )
inlineoverride

◆ post_init_actions()

void amr_wind::DamBreak::post_init_actions ( )
inlineoverride

◆ post_regrid_actions()

void amr_wind::DamBreak::post_regrid_actions ( )
inlineoverride

◆ pre_advance_work()

void amr_wind::DamBreak::pre_advance_work ( )
inlineoverride

Member Data Documentation

◆ m_density

Field& amr_wind::DamBreak::m_density
private

◆ m_height

amrex::Real amr_wind::DamBreak::m_height {0.25}
private

dam height value

◆ m_levelset

Field& amr_wind::DamBreak::m_levelset
private

◆ m_loc

amrex::Vector<amrex::Real> amr_wind::DamBreak::m_loc {0.0, 0.0, 0.0}
private

Initial DamBreak location.

◆ m_sim

const CFDSim& amr_wind::DamBreak::m_sim
private

◆ m_velocity

Field& amr_wind::DamBreak::m_velocity
private

◆ m_width

amrex::Real amr_wind::DamBreak::m_width {0.1}
private

dam width value


The documentation for this class was generated from the following files:
  • /home/runner/work/amr-wind/amr-wind/amr-wind/physics/multiphase/DamBreak.H
  • /home/runner/work/amr-wind/amr-wind/amr-wind/physics/multiphase/DamBreak.cpp