ParticleData Struct Reference

#include <ParticleData.H>

Collaboration diagram for ParticleData:

Public Member Functions
void	init_particle_params ()
void	init_particles (amrex::ParGDBBase *a_gdb, const amrex::Vector< std::unique_ptr< amrex::MultiFab >> &z_phys_nd)
void	Checkpoint (const std::string &filename)
void	Restart (amrex::ParGDBBase *a_gdb, std::string &restart_file)
void	advance_particles (int lev, amrex::Real dt_lev, amrex::MultiFab *xvel, amrex::MultiFab *yvel, amrex::MultiFab *zvel, const amrex::Vector< std::unique_ptr< amrex::MultiFab >> &z_phys_nd)
void	Redistribute ()

Public Attributes
std::string	pp_prefix {"remora"}
int	use_tracer_particles
std::unique_ptr< TracerPC >	tracer_particles
amrex::Vector< std::string >	tracer_particle_varnames = {AMREX_D_DECL("old_x", "old_y", "old_z")}

Detailed Description

Container holding many of the particle-related data and options

Member Function Documentation

advance_particles()

void ParticleData::advance_particles ( int  lev, amrex::Real  dt_lev, amrex::MultiFab *  xvel, amrex::MultiFab *  yvel, amrex::MultiFab *  zvel, const amrex::Vector< std::unique_ptr< amrex::MultiFab >> &  z_phys_nd  )

inline

    {
        // Update tracer particles
        if (use_tracer_particles) {
            amrex::Array<amrex::MultiFab const*, AMREX_SPACEDIM> mac_vel = {xvel, yvel, zvel};
            bool use_terrain = (z_phys_nd[lev] != nullptr);
            if (use_terrain) {
                tracer_particles->AdvectWithUmac(mac_vel, lev, dt_lev, use_terrain, *z_phys_nd[lev]);
            } else {
                amrex::MultiFab dummy;
                tracer_particles->AdvectWithUmac(mac_vel, lev, dt_lev, use_terrain, dummy);
            }
        }
    }

Checkpoint()

void ParticleData::Checkpoint ( const std::string &  filename )

inline

    {
        if (use_tracer_particles) {
            tracer_particles->Checkpoint(filename, "tracer_particles", true, tracer_particle_varnames);
        }
    }

init_particle_params()

void ParticleData::init_particle_params ( )

inline

    {
        amrex::ParmParse pp(pp_prefix);
 
        use_tracer_particles = 0;
        pp.query("use_tracer_particles", use_tracer_particles);
    }

init_particles()

void ParticleData::init_particles ( amrex::ParGDBBase *  a_gdb, const amrex::Vector< std::unique_ptr< amrex::MultiFab >> &  z_phys_nd  )

inline

    {
        // Initialize tracer particles
        if (use_tracer_particles) {
            tracer_particles = std::make_unique<TracerPC>(a_gdb);
            tracer_particles->InitParticles(*z_phys_nd[0]);
            amrex::Print() << "Initialized " << tracer_particles->TotalNumberOfParticles() << " tracer particles." << std::endl;
        }
    }

Redistribute()

void ParticleData::Redistribute ( )

inline

    {
        if (use_tracer_particles) {
            tracer_particles->Redistribute();
        }
    }

Restart()

void ParticleData::Restart ( amrex::ParGDBBase *  a_gdb, std::string &  restart_file  )

inline

    {
        if (use_tracer_particles) {
            // tracer_particles = std::make_unique<TracerPC>(Geom(0), dmap[0], grids[0]);
            tracer_particles = std::make_unique<TracerPC>(a_gdb);
            std::string tracer_file("tracer_particles");
            tracer_particles->Restart(restart_file, tracer_file);
        }
    }

Member Data Documentation

pp_prefix

std::string ParticleData::pp_prefix {"remora"}

Referenced by init_particle_params().

tracer_particle_varnames

amrex::Vector<std::string> ParticleData::tracer_particle_varnames = {AMREX_D_DECL("old_x", "old_y", "old_z")}

Referenced by Checkpoint().

tracer_particles

std::unique_ptr<TracerPC> ParticleData::tracer_particles

Referenced by advance_particles(), Checkpoint(), init_particles(), Redistribute(), and Restart().

use_tracer_particles

int ParticleData::use_tracer_particles

Referenced by advance_particles(), Checkpoint(), init_particle_params(), init_particles(), Redistribute(), and Restart().

---

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

• /home/runner/work/REMORA/REMORA/Source/Particles/ParticleData.H