VortexRing Class Reference

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

#include <VortexRing.H>

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

Public Member Functions

 VortexRing (const CFDSim &sim)
 
 ~VortexRing () override=default
 
void initialize_fields (int level, const amrex::Geometry &geom) override
 
void post_init_actions () override
 
void post_regrid_actions () override
 
void pre_advance_work () override
 
void post_advance_work () override
 
template<typename VortexRingType >
void initialize_velocity (const VortexRingType &vorticity_theta)
 

Static Public Member Functions

static std::string identifier ()
 

Private Attributes

const CFDSimm_sim
 
const FieldRepom_repo
 
Fieldm_velocity
 
Fieldm_density
 
amrex::Real m_rho {1.0}
 initial density value
 
amrex::Real m_R {1.0}
 
amrex::Real m_Gamma {1.0}
 
amrex::Real m_delta {0.2}
 
amrex::Real m_dz {2.0}
 
amrex::Vector< int > m_perturbation_modes
 
amrex::Vector< double > m_perturbation_phases_1
 
amrex::Vector< double > m_perturbation_phases_2
 
amrex::Real m_perturbation_amplitude {1e-4}
 
std::string m_vortexringtype {"fatcore"}
 

Detailed Description

Vortex ring physics

Constructor & Destructor Documentation

◆ VortexRing()

amr_wind::VortexRing::VortexRing ( const CFDSim & sim)
explicit

◆ ~VortexRing()

amr_wind::VortexRing::~VortexRing ( )
overridedefault

Member Function Documentation

◆ identifier()

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

◆ initialize_fields()

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

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

◆ initialize_velocity()

template<typename VortexRingType >
void amr_wind::VortexRing::initialize_velocity ( const VortexRingType & vorticity_theta)

◆ post_advance_work()

void amr_wind::VortexRing::post_advance_work ( )
inlineoverride

◆ post_init_actions()

void amr_wind::VortexRing::post_init_actions ( )
override

◆ post_regrid_actions()

void amr_wind::VortexRing::post_regrid_actions ( )
inlineoverride

◆ pre_advance_work()

void amr_wind::VortexRing::pre_advance_work ( )
inlineoverride

Member Data Documentation

◆ m_delta

amrex::Real amr_wind::VortexRing::m_delta {0.2}
private

◆ m_density

Field& amr_wind::VortexRing::m_density
private

◆ m_dz

amrex::Real amr_wind::VortexRing::m_dz {2.0}
private

◆ m_Gamma

amrex::Real amr_wind::VortexRing::m_Gamma {1.0}
private

◆ m_perturbation_amplitude

amrex::Real amr_wind::VortexRing::m_perturbation_amplitude {1e-4}
private

◆ m_perturbation_modes

amrex::Vector<int> amr_wind::VortexRing::m_perturbation_modes
private

◆ m_perturbation_phases_1

amrex::Vector<double> amr_wind::VortexRing::m_perturbation_phases_1
private

◆ m_perturbation_phases_2

amrex::Vector<double> amr_wind::VortexRing::m_perturbation_phases_2
private

◆ m_R

amrex::Real amr_wind::VortexRing::m_R {1.0}
private

◆ m_repo

const FieldRepo& amr_wind::VortexRing::m_repo
private

◆ m_rho

amrex::Real amr_wind::VortexRing::m_rho {1.0}
private

initial density value

◆ m_sim

const CFDSim& amr_wind::VortexRing::m_sim
private

◆ m_velocity

Field& amr_wind::VortexRing::m_velocity
private

◆ m_vortexringtype

std::string amr_wind::VortexRing::m_vortexringtype {"fatcore"}
private

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