#include <ERF_TurbPertStruct.H>

Collaboration diagram for TurbulentPerturbation:

[legend]

Public Member Functions
	~TurbulentPerturbation ()

void	init_tpi (const int lev, const amrex::IntVect &nx, const amrex::GpuArray< amrex::Real, 3 > dx, const amrex::BoxArray &ba, const amrex::DistributionMapping &dm, const int ngrow_state)

void	calc_tpi_update (const int lev, const amrex::Real dt, amrex::MultiFab &mf_xvel, amrex::MultiFab &mf_yvel, amrex::MultiFab &mf_cons)

void	apply_tpi (const int &lev, const amrex::Box &vbx, const int &comp, const amrex::IndexType &m_ixtype, const amrex::Array4< amrex::Real > &src_arr, const amrex::Array4< amrex::Real const > &pert_cell)

void	calc_tpi_amp (const int &boxIdx, const amrex::Real &interval)

void	pseudoRandomPert (const int &boxIdx, const int &lev, const amrex::IndexType &m_ixtype)

void	netZeroBuoyantAdd (const int &boxIdx, const int &lev)

void	netZeroBuoyantAdjust (const int &boxIdx, const int &lev)

void	calc_tpi_meanMag_perBox (const int &boxIdx, const int &lev, amrex::MultiFab &mf_cons, amrex::MultiFab &mf_xvel, amrex::MultiFab &mf_yvel)

amrex::Real *	get_pb_mag ()

amrex::Real *	get_pb_netZero ()

void	debug (amrex::Real)

Public Attributes
std::string	pp_prefix {"erf"}

int	pt_type

amrex::Vector< amrex::BoxArray >	pb_ba

amrex::Vector< amrex::Real >	pb_mag

amrex::MultiFab	pb_cell

Private Member Functions
amrex::Real	RandomReal (const amrex::Real min, const amrex::Real max)

Private Attributes
int	tpi_layers

int	tpi_offset

amrex::Vector< int >	tpi_boxDim

amrex::Vector< int >	tpi_direction

amrex::Real	tpi_nonDim

amrex::Real	tpi_Ti

amrex::Real	tpi_Tinf

amrex::Real	tpi_Hpb

amrex::Real	tpi_Lpb

amrex::Real	tpi_Wpb

amrex::Real	tpi_lref

amrex::Real	tpi_net_buoyant

amrex::Real	tpi_pert_adjust

amrex::Vector< amrex::Real >	pb_interval

amrex::Vector< amrex::Real >	pb_local_etime

amrex::Vector< amrex::Real >	pb_amp

amrex::Vector< amrex::Real >	pb_netZero

Detailed Description

Container holding quantities related to turbulent perturbation parameters

Constructor & Destructor Documentation

◆ ~TurbulentPerturbation()

TurbulentPerturbation::~TurbulentPerturbation ( )

inline

22 {}

Member Function Documentation

◆ apply_tpi()

void TurbulentPerturbation::apply_tpi	(	const int &	lev,
		const amrex::Box &	vbx,
		const int &	comp,
		const amrex::IndexType &	m_ixtype,
		const amrex::Array4< amrex::Real > &	src_arr,
		const amrex::Array4< amrex::Real const > &	pert_cell
	)

inline

     {
         for (int boxIdx = 0; boxIdx < pb_ba[lev].size(); boxIdx++) {
             amrex::Box pbx = amrex::convert(pb_ba[lev][boxIdx], m_ixtype);
             amrex::Box ubx = pbx & vbx;
             if (ubx.ok()) {
                 ParallelFor(ubx, [=] AMREX_GPU_DEVICE(int i, int j, int k) noexcept {
                     src_arr(i,j,k,comp) += pert_cell(i,j,k);
  
                     // For box region debug only
                     #ifdef INDEX_PERTURB
                     src_arr(i,j,k,comp) = (amrex::Real) (boxIdx + 5.);
                     #endif
                 });
             }
         }
     }

Referenced by make_sources().

Here is the caller graph for this function:

◆ calc_tpi_amp()

void TurbulentPerturbation::calc_tpi_amp	(	const int &	boxIdx,
		const amrex::Real &	interval
	)

inline

     {
         amrex::Real Um = pb_mag[boxIdx];
         pb_amp[boxIdx] = 0.; // Safety step
  
         amrex::Real beta = 1./tpi_Tinf; // Thermal expansion coefficient
  
         // Pseudo Random temperature the ignores scale when mechanically tripping turbulence
         amrex::Real g = CONST_GRAV;
         if (tpi_Ti > 0.) g = (tpi_nonDim * Um * Um) / (tpi_Ti * tpi_Hpb);
  
         // Ma and Senocak (2023) Eq. 8, solving for delta phi
         pb_amp[boxIdx] = (tpi_nonDim * Um * Um) / (g * beta * tpi_Hpb);
  
         if (pt_type == 0) {
             // Performing this step converts the perturbation proportionality into
             // the forcing term
             // Ma & Senocak (2023) Eq. 7
             pb_amp[boxIdx] /= interval;
         }
     }

Referenced by calc_tpi_update().

Here is the caller graph for this function:

◆ calc_tpi_meanMag_perBox()

void TurbulentPerturbation::calc_tpi_meanMag_perBox	(	const int &	boxIdx,
		const int &	lev,
		amrex::MultiFab &	mf_cons,
		amrex::MultiFab &	mf_xvel,
		amrex::MultiFab &	mf_yvel
	)

inline

     {
         // Creating local copy of PB box array and magnitude
         const amrex::BoxArray m_pb_ba = pb_ba[lev];
         amrex::Real* m_pb_mag = get_pb_mag();
         m_pb_mag[boxIdx] = 0.; // Safety step
  
         // Storage of averages per PB
         // Index: 0=u (vol/slab_lo), 1=v (vol/slab_lo)
         //        2=u (slab_hi),     3=v (slab_hi)
         int n_avg = 4;
         amrex::Vector<amrex::Real> avg_h(n_avg,0.);
         amrex::Gpu::DeviceVector<amrex::Real> avg_d(n_avg,0.);
         amrex::Real* avg = avg_d.data();
  
         // Averaging u & v components in single MFIter
         for (amrex::MFIter mfi(mf_cons, TileNoZ()); mfi.isValid(); ++mfi) {
  
             // CC valid box (inherited from mf_cons)
             const amrex::Box& vbx = mfi.validbox();
  
             // Box logic for u velocity
             auto ixtype_u    = mf_xvel.boxArray().ixType();
             amrex::Box vbx_u = amrex::convert(vbx,ixtype_u);
             amrex::Box pbx_u = amrex::convert(m_pb_ba[boxIdx], ixtype_u);
             amrex::Box ubx_u = pbx_u & vbx_u;
  
             // Box logic for v velocity
             auto ixtype_v    = mf_yvel.boxArray().ixType();
             amrex::Box vbx_v = amrex::convert(vbx,ixtype_v);
             amrex::Box pbx_v = amrex::convert(m_pb_ba[boxIdx], ixtype_v);
             amrex::Box ubx_v = pbx_v & vbx_v;
  
             // Operation over box union (U)
             if (ubx_u.ok()) {
                 const amrex::Array4<const amrex::Real>& xvel_arry = mf_xvel.const_array(mfi);
  
                 #ifdef USE_VOLUME_AVERAGE
                 int npts = ubx_u.numPts();
                 amrex::Real norm = 1.0 / (amrex::Real) npts;
                 ParallelFor(amrex::Gpu::KernelInfo().setReduction(true), ubx_u, [=]
                 AMREX_GPU_DEVICE(int i, int j, int k, amrex::Gpu::Handler const& handler) noexcept {
                     amrex::Gpu::deviceReduceSum(&avg[0], xvel_arry(i,j,k)*norm, handler);
                 });
                 #endif // USE_VOLUME_AVERAGE
  
                 #ifdef USE_SLAB_AVERAGE
                 amrex::Box ubxSlab_lo = makeSlab(ubx_u,2,ubx_u.smallEnd(2));
                 amrex::Box ubxSlab_hi = makeSlab(ubx_u,2,ubx_u.bigEnd(2));
                 int npts_lo = ubxSlab_lo.numPts();
                 int npts_hi = ubxSlab_hi.numPts();
                 amrex::Real norm_lo = 1.0 / (amrex::Real) npts_lo;
                 amrex::Real norm_hi = 1.0 / (amrex::Real) npts_hi;
  
                 // Average u in the low slab
                 ParallelFor(amrex::Gpu::KernelInfo().setReduction(true), ubxSlab_lo, [=]
                 AMREX_GPU_DEVICE(int i, int j, int k, amrex::Gpu::Handler const& handler) noexcept {
                     amrex::Gpu::deviceReduceSum(&avg[0], xvel_arry(i,j,k)*norm_lo, handler);
                 });
  
                 // Average u in the high slab
                 ParallelFor(amrex::Gpu::KernelInfo().setReduction(true), ubxSlab_hi, [=]
                 AMREX_GPU_DEVICE(int i, int j, int k, amrex::Gpu::Handler const& handler) noexcept {
                     amrex::Gpu::deviceReduceSum(&avg[2], xvel_arry(i,j,k)*norm_hi, handler);
                 });
                 #endif // USE_SLAB_AVERAGE
             } // if
  
             // Operation over box union (V)
             if (ubx_v.ok()) {
                 const amrex::Array4<const amrex::Real>& yvel_arry = mf_yvel.const_array(mfi);
  
                 #ifdef USE_VOLUME_AVERAGE
                 int npts = ubx_v.numPts();
                 amrex::Real norm = 1.0 / (amrex::Real) npts;
                 ParallelFor(amrex::Gpu::KernelInfo().setReduction(true), ubx_v, [=]
                 AMREX_GPU_DEVICE(int i, int j, int k, amrex::Gpu::Handler const& handler) noexcept {
                     amrex::Gpu::deviceReduceSum(&avg[1], yvel_arry(i,j,k)*norm, handler);
                 });
                 #endif // USE_VOLUME_AVERAGE
  
                 #ifdef USE_SLAB_AVERAGE
                 amrex::Box ubxSlab_lo = makeSlab(ubx_v,2,ubx_v.smallEnd(2));
                 amrex::Box ubxSlab_hi = makeSlab(ubx_v,2,ubx_v.bigEnd(2));
                 int npts_lo = ubxSlab_lo.numPts();
                 int npts_hi = ubxSlab_hi.numPts();
                 amrex::Real norm_lo = 1.0 / (amrex::Real) npts_lo;
                 amrex::Real norm_hi = 1.0 / (amrex::Real) npts_hi;
  
                 // Average v in the low slab
                 ParallelFor(amrex::Gpu::KernelInfo().setReduction(true), ubxSlab_lo, [=]
                 AMREX_GPU_DEVICE(int i, int j, int k, amrex::Gpu::Handler const& handler) noexcept {
                     amrex::Gpu::deviceReduceSum(&avg[1], yvel_arry(i,j,k)*norm_lo, handler);
                 });
  
                 // Average v in the high slab
                 ParallelFor(amrex::Gpu::KernelInfo().setReduction(true), ubxSlab_hi, [=]
                 AMREX_GPU_DEVICE(int i, int j, int k, amrex::Gpu::Handler const& handler) noexcept {
                     amrex::Gpu::deviceReduceSum(&avg[3], yvel_arry(i,j,k)*norm_hi, handler);
                 });
                 #endif // USE_SLAB_AVERAGE
             } // if
         } // MFIter
  
         // Copy from device back to host
         amrex::Gpu::copy(amrex::Gpu::deviceToHost, avg_d.begin(), avg_d.end(), avg_h.begin());
  
         // Computing the average magnitude within PB
         #ifdef USE_VOLUME_AVERAGE
         m_pb_mag[boxIdx] = sqrt(avg_h[0]*avg_h[0] + avg_h[1]*avg_h[1]);
         #endif
  
         #ifdef USE_SLAB_AVERAGE
         m_pb_mag[boxIdx] = 0.5*( sqrt(avg_h[0]*avg_h[0] + avg_h[1]*avg_h[1])
                                + sqrt(avg_h[2]*avg_h[2] + avg_h[3]*avg_h[3]));
         #endif
     }

Referenced by calc_tpi_update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calc_tpi_update()

void TurbulentPerturbation::calc_tpi_update	(	const int	lev,
		const amrex::Real	dt,
		amrex::MultiFab &	mf_xvel,
		amrex::MultiFab &	mf_yvel,
		amrex::MultiFab &	mf_cons
	)

inline

     {
         // Resettubg the net buoyant force value
         tpi_net_buoyant = 0.;
  
         // Setting random number generator for update interval
         srand( (unsigned) time(NULL) );
  
         auto m_ixtype = mf_cons.boxArray().ixType(); // safety step
  
         for (int boxIdx = 0; boxIdx < pb_ba[lev].size(); boxIdx++) {
  
             // Check if the local elapsed time is greater than the update interval
             if ( pb_interval[boxIdx] <= pb_local_etime[boxIdx] ) {
  
                 // Compute mean velocity of each perturbation box
                 calc_tpi_meanMag_perBox(boxIdx, lev, mf_cons, mf_xvel, mf_yvel);
  
                 // Only the rank owning the box will be able to access the storage location
                 // Done for parallelism to avoid Inf being stored in array
                 if (pb_mag[boxIdx] !=0.) {
                     amrex::Real interval = tpi_lref / pb_mag[boxIdx];
                     pb_interval[boxIdx] = RandomReal(0.9*interval,1.1*interval); // 10% variation
                 }
  
                 // Trigger amplitude calculation per perturbation box
                 calc_tpi_amp(boxIdx, pb_interval[boxIdx]);
  
                 // Trigger random amplitude storage per cell within perturbation box
                 pseudoRandomPert(boxIdx, lev, m_ixtype);
  
                 // Reset local elapsed time
                 pb_local_etime[boxIdx] = 0.;
             } else {
                 // Increase by timestep of level 0
                 pb_local_etime[boxIdx] += dt;
             } // if
  
             // Per iteration operation of net-zero buoyant force check
             if (pb_mag[boxIdx] !=0.) netZeroBuoyantAdd(boxIdx, lev);
             tpi_net_buoyant += pb_netZero[boxIdx];
         } // for
  
         // Normalizing the adjustment based on how many boxes there are
         // the values within the array is already normalized by the number
         // of cells within each box
         tpi_pert_adjust = tpi_net_buoyant / (amrex::Real) pb_ba[lev].size();
  
         // Per iteration operation of net-zero buoyant force adjustment
         for (int boxIdx = 0; boxIdx < pb_ba[lev].size(); boxIdx++) {
             if (pb_mag[boxIdx] !=0.) netZeroBuoyantAdjust(boxIdx, lev);
         }
     }

Here is the call graph for this function:

◆ debug()

void TurbulentPerturbation::debug ( amrex::Real )

inline

     {
         /*
         amrex::PrintToFile("BoxPerturbationOutput") << "#################### PB output at time = "
             << time << " ####################\n";
         amrex::PrintToFile("BoxPerturbationOutput") << " Using type: " <<  pt_type << "\n";
         amrex::PrintToFile("BoxPerturbationOutput") << " Net: " << tpi_net_buoyant << " Adjust : " <<  tpi_pert_adjust << "\n";
         for (int i = 0; i < pb_mag.size(); i++) {
             amrex::PrintToFile("BoxPerturbationOutput") << "[" << i
                 << "] pb_Umag=" << pb_mag[i]
                 << " | pb_interval=" << pb_interval[i]
                 << " (" << pb_local_etime[i]
                 << ") | pb_amp=" << pb_amp[i] << "\n";
         }
         amrex::PrintToFile("BoxPerturbationOutput") << "\n";
         */
     }

◆ get_pb_mag()

amrex::Real* TurbulentPerturbation::get_pb_mag ( )

inline

504 { return pb_mag.data(); }

Referenced by calc_tpi_meanMag_perBox().

Here is the caller graph for this function:

◆ get_pb_netZero()

amrex::Real* TurbulentPerturbation::get_pb_netZero ( )

inline

505 { return pb_netZero.data(); }

Referenced by netZeroBuoyantAdd().

Here is the caller graph for this function:

◆ init_tpi()

void TurbulentPerturbation::init_tpi	(	const int	lev,
		const amrex::IntVect &	nx,
		const amrex::GpuArray< amrex::Real, 3 >	dx,
		const amrex::BoxArray &	ba,
		const amrex::DistributionMapping &	dm,
		const int	ngrow_state
	)

inline

     {
         // Initialization for some 0 dependent terms
         tpi_Ti = 0.;
         tpi_Tinf = 300.;
  
         amrex::ParmParse pp(pp_prefix);
  
         // Reading inputs, and placing assertion for the perturbation inflow to work
         pp.queryarr("perturbation_box_dims",tpi_boxDim);
         pp.queryarr("perturbation_direction",tpi_direction);
         pp.query("perturbation_layers",tpi_layers);
         pp.query("perturbation_offset",tpi_offset);
  
         pp.query("perturbation_nondimensional",tpi_nonDim);
         pp.query("perturbation_T_infinity",tpi_Tinf);
         pp.query("perturbation_T_intensity",tpi_Ti);
  
         // Check variables message
         if (tpi_layers < 0) { amrex::Abort("Please provide a valid perturbation layer value (ie. 3-5)"); }
         if (tpi_offset < 0) { amrex::Abort("Please provide a valid inflow cell offset value for perturbation region (ie. 0-5)"); }
         for (int i = 0; i < tpi_boxDim.size(); i++) {
             if (tpi_boxDim[i] == 0) { amrex::Abort("Please provide valid dimensions for perturbation boxes."); }
         }
         if (tpi_nonDim < 0.) { amrex::Abort("Please provide a valid nondimensional number (ie. Ri = 0.042)"); }
         if (tpi_Tinf < 0.) { amrex::Abort("Please provide a valid ambient temperature value (ie. T_0 = T_infty)"); }
         if (tpi_Ti < 0.) { amrex::Abort("Please provide a valid temperature intensity value (ie. 0-1.0)"); }
  
         // Creating perturbation regions and initializing with generic size. Temporary size for now
         amrex::Box lo_x_bx(amrex::IntVect(0), amrex::IntVect(1), amrex::IntVect(0));
         amrex::Box hi_x_bx(amrex::IntVect(0), amrex::IntVect(1), amrex::IntVect(0));
         amrex::Box lo_y_bx(amrex::IntVect(0), amrex::IntVect(1), amrex::IntVect(0));
         amrex::Box hi_y_bx(amrex::IntVect(0), amrex::IntVect(1), amrex::IntVect(0));
  
         // Create a temporary box list to accumulate all the perturbation regions after box modification
         amrex::BoxList tmp_bl;
  
         // boxSize for individual boxes
         amrex::IntVect boxSize(tpi_boxDim[0],tpi_boxDim[1],tpi_boxDim[2]);
  
         // Starting logic to set the size of the perturbation region(s)
         //amrex::PrintToFile("BoxPerturbationOutput") << "Setting perturbation region in:";
         // ***** X-direction perturbation *****
         if (tpi_direction[0]) { // West
             lo_x_bx.setSmall(amrex::IntVect(tpi_offset, tpi_direction[1]*tpi_offset, 0));
             lo_x_bx.setBig(amrex::IntVect((tpi_layers*tpi_boxDim[0]-1)+tpi_offset, nx[1]-(tpi_direction[4]*tpi_offset), nx[2]));
             //amrex::PrintToFile("BoxPerturbationOutput") << " West face";
         }
  
         if (tpi_direction[3]) { // East
             hi_x_bx.setSmall(amrex::IntVect(nx[0]-((tpi_layers*tpi_boxDim[0]-1)+tpi_offset), tpi_direction[1]*tpi_offset, 0));
             hi_x_bx.setBig(amrex::IntVect(nx[0]-tpi_offset, nx[1]-(tpi_direction[4]*tpi_offset), nx[2]));
             //amrex::PrintToFile("BoxPerturbationOutput") << " East face";
         }
  
         // ***** Y-direction Perturbation *****
         if (tpi_direction[1]) { // North
             lo_y_bx.setSmall(amrex::IntVect(tpi_direction[0]*tpi_offset, tpi_offset, 0));
             lo_y_bx.setBig(amrex::IntVect(nx[0]-tpi_direction[3]*tpi_offset, ((tpi_layers*tpi_boxDim[1])-1)+tpi_offset, nx[2]));
             //amrex::PrintToFile("BoxPerturbationOutput") << " North face";
         }
  
         if (tpi_direction[4]) { // South
             hi_y_bx.setSmall(amrex::IntVect(tpi_direction[0]*tpi_offset, nx[1]-((tpi_layers*tpi_boxDim[1]-1)+tpi_offset), 0));
             hi_y_bx.setBig(amrex::IntVect(nx[0]-tpi_direction[3]*tpi_offset, nx[1]-tpi_offset, nx[2]));
             //amrex::PrintToFile("BoxPerturbationOutput") << " South face";
         }
  
         if (tpi_direction[2] || tpi_direction[5]) { amrex::Abort("Currently not supporting z-direction flow perturbation"); }
  
         // Performing box union for intersecting perturbation regions to avoid overlapping sections (double counting at corners)
         if (tpi_direction[0] && tpi_direction[1]) {  // Reshaping South smallEnd
             amrex::Box lo_x_lo_y_u = lo_x_bx & lo_y_bx;
             lo_y_bx.setSmall(amrex::IntVect(lo_x_lo_y_u.bigEnd(0)+1, lo_x_lo_y_u.smallEnd(1), lo_x_lo_y_u.smallEnd(2)));
         }
  
         if (tpi_direction[3] && tpi_direction[1]) { // Reshaping South bigEnd
              amrex::Box hi_x_lo_y_u = hi_x_bx & lo_y_bx;
              lo_y_bx.setBig(amrex::IntVect(hi_x_lo_y_u.smallEnd(0)-1, hi_x_lo_y_u.bigEnd(1), hi_x_lo_y_u.bigEnd(2)));
         }
  
         if (tpi_direction[0] && tpi_direction[4]) {  // Reshaping North smallEnd
             amrex::Box lo_x_hi_y_u = lo_x_bx & hi_y_bx;
             hi_y_bx.setSmall(amrex::IntVect(lo_x_hi_y_u.bigEnd(0)+1, lo_x_hi_y_u.smallEnd(1), lo_x_hi_y_u.smallEnd(2)));
         }
  
         if (tpi_direction[3] && tpi_direction[4]) { // Reshaping North bigEnd
              amrex::Box hi_x_hi_y_u = hi_x_bx & hi_y_bx;
              hi_y_bx.setBig(amrex::IntVect(hi_x_hi_y_u.smallEnd(0)-1, hi_x_hi_y_u.bigEnd(1), hi_x_hi_y_u.bigEnd(2)));
         }
  
         // Creating structure box array for conserved quantity
         if (tpi_direction[0]) { tmp_bl.push_back(lo_x_bx); }
         if (tpi_direction[1]) { tmp_bl.push_back(lo_y_bx); }
         if (tpi_direction[3]) { tmp_bl.push_back(hi_x_bx); }
         if (tpi_direction[4]) { tmp_bl.push_back(hi_y_bx); }
         //amrex::PrintToFile("BoxPerturbationOutput") << "\nBoxList: " << tmp_bl << "\n";
         amrex::BoxArray tmp_ba(tmp_bl);
         tmp_ba.maxSize(boxSize);
         pb_ba.push_back(tmp_ba);
  
         // Initializing mean magnitude vector
         pb_mag.resize(pb_ba[lev].size(), 0.);
         pb_netZero.resize(pb_ba[lev].size(), 0.);
  
         // Set size of vector and initialize
         pb_interval.resize(pb_ba[lev].size(), -1.0);
         pb_local_etime.resize(pb_ba[lev].size(), 0.0);
         pb_amp.resize(pb_ba[lev].size(), 0.0);
  
         // Creating data array for perturbation amplitude storage
         pb_cell.define(ba, dm, 1, ngrow_state);
         pb_cell.setVal(0.);
  
         // Computing perturbation reference length
         tpi_Lpb = tpi_boxDim[0]*dx[0];
         tpi_Wpb = tpi_boxDim[1]*dx[1];
         tpi_Hpb = tpi_boxDim[2]*dx[2];
         tpi_lref = sqrt(tpi_Lpb*tpi_Lpb + tpi_Wpb*tpi_Wpb);
  
         tpi_pert_adjust = 0.;
         tpi_net_buoyant = 0.;
  
         /*
         // Function check point message
         amrex::PrintToFile("BoxPerturbationOutput") << "perturbation_box_dims: "
                                                     << tpi_boxDim[0] << " "
                                                     << tpi_boxDim[1] << " "
                                                     << tpi_boxDim[2] << "\n";
         amrex::PrintToFile("BoxPerturbationOutput") << "perturbation_direction: "
                                                     << tpi_direction[0] << " "
                                                     << tpi_direction[1] << " "
                                                     << tpi_direction[2] << "\n\n";
         amrex::PrintToFile("BoxPerturbationOutput") << "perturbation_layers: " << tpi_layers << "\n";
         amrex::PrintToFile("BoxPerturbationOutput") << "perturbation_offset: " << tpi_offset << "\n\n";
         amrex::PrintToFile("BoxPerturbationOutput") << "perturbation_nondimensional: " << tpi_nonDim << "\n";
         amrex::PrintToFile("BoxPerturbationOutput") << "perturbation_T_infinity: " << tpi_Tinf << "\n";
         amrex::PrintToFile("BoxPerturbationOutput") << "perturbation_T_intensity: " << tpi_Ti << "\n";
         amrex::PrintToFile("BoxPerturbationOutput") << "Reference length per box = " << tpi_lref << "\n\n";
         amrex::PrintToFile("BoxPerturbationOutput") << "Turbulent perturbation BoxArray:\n" << pb_ba[lev] << "\n";
         */
     }

Here is the call graph for this function:

◆ netZeroBuoyantAdd()

void TurbulentPerturbation::netZeroBuoyantAdd	(	const int &	boxIdx,
		const int &	lev
	)

inline

     {
         // Creating local copy of PB box array and magnitude
         const amrex::BoxArray m_pb_ba = pb_ba[lev];
         amrex::Real* m_pb_netZero = get_pb_netZero();
  
         // Create device array for summation
         amrex::Vector<amrex::Real> avg_h(1,0.);
         amrex::Gpu::DeviceVector<amrex::Real> avg_d(1,0.);
         amrex::Real* avg = avg_d.data();
  
         // Iterates through the cells of each box and sum the white noise perturbation
         for (amrex::MFIter mfi(pb_cell, TileNoZ()) ; mfi.isValid(); ++mfi) {
             const amrex::Box& vbx = mfi.validbox();
             amrex::Box pbx = amrex::convert(m_pb_ba[boxIdx], vbx.ixType());
             amrex::Box ubx = pbx & vbx;
             if (ubx.ok()) {
                 const amrex::Array4<const amrex::Real>& pert_cell = pb_cell.const_array(mfi);
                 int npts = ubx.numPts();
                 amrex::Real norm = 1.0 / (amrex::Real) npts;
                 ParallelFor(amrex::Gpu::KernelInfo().setReduction(true), ubx, [=]
                 AMREX_GPU_DEVICE(int i, int j, int k, amrex::Gpu::Handler const& handler) noexcept {
                     amrex::Gpu::deviceReduceSum(&avg[0], pert_cell(i,j,k)*norm, handler);
                 });
                 amrex::Gpu::copy(amrex::Gpu::deviceToHost, avg_d.begin(), avg_d.end(), avg_h.begin());
  
                 // Assigning onto storage array
                 m_pb_netZero[boxIdx] = avg_h[0];
             }
         }
     }

Referenced by calc_tpi_update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ netZeroBuoyantAdjust()

void TurbulentPerturbation::netZeroBuoyantAdjust	(	const int &	boxIdx,
		const int &	lev
	)

inline

     {
         // Creating local copy of PB box array and magnitude
         const amrex::BoxArray m_pb_ba = pb_ba[lev];
         for (amrex::MFIter mfi(pb_cell, TileNoZ()) ; mfi.isValid(); ++mfi) {
             const amrex::Box& vbx = mfi.validbox();
             amrex::Box pbx = amrex::convert(m_pb_ba[boxIdx], vbx.ixType());
             amrex::Box ubx = pbx & vbx;
             if (ubx.ok()) {
                const amrex::Real adjust = tpi_pert_adjust;
                const amrex::Array4<amrex::Real>& pert_cell = pb_cell.array(mfi);
                ParallelFor(ubx, [=] AMREX_GPU_DEVICE(int i, int j, int k) noexcept {
                    pert_cell(i,j,k) -= adjust;
                });
             }
         }
     }

Referenced by calc_tpi_update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pseudoRandomPert()

void TurbulentPerturbation::pseudoRandomPert	(	const int &	boxIdx,
		const int &	lev,
		const amrex::IndexType &	m_ixtype
	)

inline

     {
         // Seed the random generator at 1024UL for regression testing
         int fix_random_seed = 0;
         amrex::ParmParse pp("erf"); pp.query("fix_random_seed", fix_random_seed);
         if (fix_random_seed) {
             amrex::InitRandom(1024UL);
         }
  
         for (amrex::MFIter mfi(pb_cell,TileNoZ()); mfi.isValid(); ++mfi) {
             amrex::Box vbx = mfi.validbox();
             amrex::Box pbx = amrex::convert(pb_ba[lev][boxIdx], m_ixtype);
             amrex::Box ubx = pbx & vbx;
             if (ubx.ok()) {
                 amrex::Real amp_copy = pb_amp[boxIdx];
                 const amrex::Array4<amrex::Real>& pert_cell = pb_cell.array(mfi);
                 ParallelForRNG(ubx, [=] AMREX_GPU_DEVICE(int i, int j, int k, const amrex::RandomEngine& engine) noexcept {
                     amrex::Real rand_double = amrex::Random(engine);
                     pert_cell(i,j,k) = (rand_double*2.0 - 1.0) * amp_copy;
                 });
             }
         }
     }

Referenced by calc_tpi_update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RandomReal()

amrex::Real TurbulentPerturbation::RandomReal	(	const amrex::Real	min,
		const amrex::Real	max
	)

inlineprivate

     {
         amrex::Real r = (amrex::Real) rand() / (amrex::Real) RAND_MAX;
         return min + r * (max - min);
     }

Referenced by calc_tpi_update().

Here is the caller graph for this function:

Member Data Documentation

◆ pb_amp

amrex::Vector<amrex::Real> TurbulentPerturbation::pb_amp

private

Referenced by calc_tpi_amp(), init_tpi(), and pseudoRandomPert().

◆ pb_ba

amrex::Vector<amrex::BoxArray> TurbulentPerturbation::pb_ba

Referenced by apply_tpi(), calc_tpi_meanMag_perBox(), calc_tpi_update(), init_tpi(), netZeroBuoyantAdd(), netZeroBuoyantAdjust(), and pseudoRandomPert().

◆ pb_cell

amrex::MultiFab TurbulentPerturbation::pb_cell

Referenced by init_tpi(), make_sources(), netZeroBuoyantAdd(), netZeroBuoyantAdjust(), and pseudoRandomPert().

◆ pb_interval

amrex::Vector<amrex::Real> TurbulentPerturbation::pb_interval

private

Referenced by calc_tpi_update(), and init_tpi().

◆ pb_local_etime

amrex::Vector<amrex::Real> TurbulentPerturbation::pb_local_etime

private

Referenced by calc_tpi_update(), and init_tpi().

◆ pb_mag

amrex::Vector<amrex::Real> TurbulentPerturbation::pb_mag

Referenced by calc_tpi_amp(), calc_tpi_update(), get_pb_mag(), and init_tpi().

◆ pb_netZero

amrex::Vector<amrex::Real> TurbulentPerturbation::pb_netZero

private

Referenced by calc_tpi_update(), get_pb_netZero(), and init_tpi().

◆ pp_prefix

std::string TurbulentPerturbation::pp_prefix {"erf"}

Referenced by init_tpi().

◆ pt_type

int TurbulentPerturbation::pt_type

Referenced by calc_tpi_amp().

◆ tpi_boxDim

amrex::Vector<int> TurbulentPerturbation::tpi_boxDim

private

Referenced by init_tpi().

◆ tpi_direction

amrex::Vector<int> TurbulentPerturbation::tpi_direction

private

Referenced by init_tpi().

◆ tpi_Hpb

amrex::Real TurbulentPerturbation::tpi_Hpb

private

Referenced by calc_tpi_amp(), and init_tpi().

◆ tpi_layers

int TurbulentPerturbation::tpi_layers

private

Referenced by init_tpi().

◆ tpi_Lpb

amrex::Real TurbulentPerturbation::tpi_Lpb

private

Referenced by init_tpi().

◆ tpi_lref

amrex::Real TurbulentPerturbation::tpi_lref

private

Referenced by calc_tpi_update(), and init_tpi().

◆ tpi_net_buoyant

amrex::Real TurbulentPerturbation::tpi_net_buoyant

private

Referenced by calc_tpi_update(), and init_tpi().

◆ tpi_nonDim

amrex::Real TurbulentPerturbation::tpi_nonDim

private

Referenced by calc_tpi_amp(), and init_tpi().

◆ tpi_offset

int TurbulentPerturbation::tpi_offset

private

Referenced by init_tpi().

◆ tpi_pert_adjust

amrex::Real TurbulentPerturbation::tpi_pert_adjust

private

Referenced by calc_tpi_update(), init_tpi(), and netZeroBuoyantAdjust().

◆ tpi_Ti

amrex::Real TurbulentPerturbation::tpi_Ti

private

Referenced by calc_tpi_amp(), and init_tpi().

◆ tpi_Tinf

amrex::Real TurbulentPerturbation::tpi_Tinf

private

Referenced by calc_tpi_amp(), and init_tpi().

◆ tpi_Wpb

amrex::Real TurbulentPerturbation::tpi_Wpb

private

Referenced by init_tpi().

The documentation for this struct was generated from the following file:

Source/DataStructs/ERF_TurbPertStruct.H

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~TurbulentPerturbation()

Member Function Documentation

◆ apply_tpi()

◆ calc_tpi_amp()

◆ calc_tpi_meanMag_perBox()

◆ calc_tpi_update()

◆ debug()

◆ get_pb_mag()

◆ get_pb_netZero()

◆ init_tpi()

◆ netZeroBuoyantAdd()

◆ netZeroBuoyantAdjust()

◆ pseudoRandomPert()

◆ RandomReal()

Member Data Documentation

◆ pb_amp

◆ pb_ba

◆ pb_cell

◆ pb_interval

◆ pb_local_etime

◆ pb_mag

◆ pb_netZero

◆ pp_prefix

◆ pt_type

◆ tpi_boxDim

◆ tpi_direction

◆ tpi_Hpb

◆ tpi_layers

◆ tpi_Lpb

◆ tpi_lref

◆ tpi_net_buoyant

◆ tpi_nonDim

◆ tpi_offset

◆ tpi_pert_adjust

◆ tpi_Ti

◆ tpi_Tinf

◆ tpi_Wpb