SDInitialization Class Reference

Super-droplets initialization structure. More...

#include <ERF_SDInitialization.H>

Inheritance diagram for SDInitialization:

Collaboration diagram for SDInitialization:

Public Member Functions
virtual	~SDInitialization ()=default
void	readInputs (const std::string &, const std::string &, const amrex::Geometry &, const MatVec &, const MatVec &) override
void	readInputs (const std::string &a_prefix, const amrex::Geometry &a_geom, const MatVec &a_species_mat, const MatVec &a_aerosol_mat)
	Read super-droplet initialization parameters from input file. More...
void	printParameters (const MatVec &, const MatVec &) const override
int	numSDPerCell (const amrex::Real a_dv) const override
amrex::Real	numParticlesPerCell (const amrex::Real a_dv) const override
Public Member Functions inherited from SDInitProperties
virtual void	setDefaults (const amrex::Geometry &a_geom, const MatVec &a_species_mat, const MatVec &a_aerosol_mat)
	Set default values for initialization parameters. More...
void	getDistribution (amrex::Vector< amrex::Real > &a_mass, int a_np, amrex::Real a_density, SDDistributionType a_init_type, amrex::Real a_mass_min, amrex::Real a_mass_max, amrex::Real a_mass_mean, amrex::Real a_radius_min, amrex::Real a_radius_max, amrex::Real a_radius_mean, amrex::Real a_radius_gstd, std::mt19937 &a_rng) const
	Get a distribution with constant multiplicity. More...
void	getDistribution (amrex::Vector< amrex::Real > &a_mass, amrex::Vector< amrex::Real > &a_mult, amrex::Real a_dV, int a_np, amrex::Real a_density, SDDistributionType a_init_type, amrex::Real a_mass_min, amrex::Real a_mass_max, amrex::Real a_mass_mean, amrex::Real a_radius_min, amrex::Real a_radius_max, amrex::Real a_radius_mean, amrex::Real a_radius_gstd, std::mt19937 &a_rng) const
	Get a distribution with sampled multiplicity. More...
void	getAerosolDistribution (amrex::Vector< amrex::Real > &a_mass, const int a_idx, const int a_np, const amrex::Real a_density, std::mt19937 &a_rng) const
	Compute the aerosol mass distribution. More...
void	getAerosolDistribution (amrex::Vector< amrex::Real > &a_mass, amrex::Vector< amrex::Real > &a_mult, amrex::Real a_dV, int a_idx, int a_np, amrex::Real a_density, std::mt19937 &a_rng) const
	Compute the aerosol mass distribution with sampled multiplicity. More...
void	getSpeciesDistribution (amrex::Vector< amrex::Real > &a_mass, const int a_idx, const int a_np, const amrex::Real a_density, std::mt19937 &a_rng) const
	Compute the species mass distribution with constant multiplicity. More...
void	getSpeciesDistribution (amrex::Vector< amrex::Real > &a_mass, amrex::Vector< amrex::Real > &a_mult, amrex::Real a_dV, int a_idx, int a_np, amrex::Real a_density, std::mt19937 &a_rng) const
	Compute the species mass distribution with sampled multiplicity. More...
SDDistributionParams	getSpeciesDistParams (int a_idx, amrex::Real a_density, amrex::Real a_cell_volume, bool a_sampled_mult) const
	Get GPU-compatible distribution parameters for a species. More...
SDDistributionParams	getAerosolDistParams (int a_idx, amrex::Real a_density, amrex::Real a_cell_volume, bool a_sampled_mult) const
	Get GPU-compatible distribution parameters for an aerosol. More...
SDDistributionParams	makeDistributionParams (SDDistributionType a_init_type, amrex::Real a_mass_min, amrex::Real a_mass_max, amrex::Real a_mass_mean, amrex::Real a_radius_min, amrex::Real a_radius_max, amrex::Real a_radius_mean, amrex::Real a_radius_gstd, amrex::Real a_density, amrex::Real a_cell_volume, bool a_sampled_mult) const
	Create GPU-compatible distribution parameters structure. More...
bool	sampledMultiplicity () const
	Determine whether multiplicity is sampled or constant. More...
amrex::Real	volume () const
	Calculate the volume of the particle domain. More...

Public Attributes
amrex::Real	m_numdens_sd_init = -1
Public Attributes inherited from SDInitProperties
int	m_ppc = 1
SDInitShape	m_type = SDInitShape::uniform
amrex::Real	m_numdens = -1
amrex::Real	m_max_multiplicity = 1000000
std::vector< amrex::Real >	m_mass_species_min
std::vector< amrex::Real >	m_mass_species_max
std::vector< amrex::Real >	m_mass_species_mean
std::vector< amrex::Real >	m_radius_species_min
std::vector< amrex::Real >	m_radius_species_max
std::vector< amrex::Real >	m_radius_species_mean
std::vector< amrex::Real >	m_radius_species_geom_std
std::vector< SDDistributionType >	m_species_init_type
std::vector< amrex::Real >	m_mass_aerosol_min
std::vector< amrex::Real >	m_mass_aerosol_max
std::vector< amrex::Real >	m_mass_aerosol_mean
std::vector< amrex::Real >	m_radius_aerosol_min
std::vector< amrex::Real >	m_radius_aerosol_max
std::vector< amrex::Real >	m_radius_aerosol_mean
std::vector< amrex::Real >	m_radius_aerosol_geom_std
std::vector< SDDistributionType >	m_aerosol_init_type
int	m_num_species = 0
int	m_num_aerosols = 0
amrex::RealBox	m_particle_domain
amrex::Vector< amrex::Real >	m_init_particle_p1
amrex::Vector< amrex::Real >	m_init_particle_p2
SDMultiplicityType	m_mult_type

Additional Inherited Members
Public Types inherited from SDInitProperties
using	MatVec = std::vector< std::unique_ptr< MaterialProperties > >

Detailed Description

Super-droplets initialization structure.

Constructor & Destructor Documentation

~SDInitialization()

virtual SDInitialization::~SDInitialization ( )

virtualdefault

Initial number density of super-droplets

Member Function Documentation

numParticlesPerCell()

amrex::Real SDInitialization::numParticlesPerCell ( const amrex::Real  a_dv ) const

inlineoverridevirtual

Compute number of physical particles per grid cell

Implements SDInitProperties.

        {
            amrex::Real num_par_per_cell = zero;
            if (this->m_numdens >= 0) {
                num_par_per_cell = std::ceil(this->m_numdens*a_dv);
            } else {
                num_par_per_cell = 1;
            }
            return num_par_per_cell;
        }

numSDPerCell()

int SDInitialization::numSDPerCell ( const amrex::Real  a_dv ) const

inlineoverridevirtual

Compute number of super-droplets per grid cell

Implements SDInitProperties.

        {
            int num_sd_per_cell = 0;
            if (m_numdens_sd_init >= 0) {
                num_sd_per_cell = static_cast<int>(std::ceil(m_numdens_sd_init*a_dv));
            } else {
                num_sd_per_cell = this->m_ppc;
            }
            return num_sd_per_cell;
        }

printParameters()

void SDInitialization::printParameters ( const MatVec &  a_species_mat, const MatVec &  a_aerosol_mat  ) const

overridevirtual

print super-droplets initialization parameters to screen

Reimplemented from SDInitProperties.

{
    using namespace amrex;
    Print() << "    Initial number density: " << this->m_numdens << "\n"
            << "    Initial super-droplets number density: " << m_numdens_sd_init << "\n";
    SDInitProperties::printParameters(a_species_mat, a_aerosol_mat);
}

Here is the call graph for this function:

readInputs() [1/2]

void SDInitialization::readInputs ( const std::string &  , const std::string &  , const amrex::Geometry &  , const MatVec &  , const MatVec &    )

inlineoverridevirtual

read super-droplets initialization parameters

Reimplemented from SDInitProperties.

        {
            amrex::Abort("SDInjection::readInputs(): Do not use this interface");
        }

readInputs() [2/2]

void SDInitialization::readInputs	(	const std::string &	a_prefix,
		const amrex::Geometry &	a_geom,
		const MatVec &	a_species_mat,
		const MatVec &	a_aerosol_mat
	)

Read super-droplet initialization parameters from input file.

This function reads initialization-specific parameters including distribution types, particle counts, and sizing parameters.

Parameters

[in]	a_prefix	Prefix for parameter parser
[in]	a_geom	Simulation geometry information
[in]	a_species_mat	Vector of species material properties
[in]	a_aerosol_mat	Vector of aerosol material properties

{
    BL_PROFILE("SDInitialization::readInputs");
 
    SDInitProperties::readInputs( a_prefix, "initial_", a_geom, a_species_mat, a_aerosol_mat);
 
    amrex::ignore_unused(a_geom);
    using namespace amrex;
 
    amrex::ParmParse pp(a_prefix);
    pp.query("initial_number_density", this->m_numdens);
    pp.query("initial_super_droplet_density", m_numdens_sd_init);
}

Here is the call graph for this function:

Member Data Documentation

m_numdens_sd_init

amrex::Real SDInitialization::m_numdens_sd_init = -1

Referenced by numSDPerCell().

---

The documentation for this class was generated from the following files:

• Source/Particles/ERF_SDInitialization.H
• Source/Particles/ERF_SDInitialization.cpp