DiffChoice Struct Reference

#include <ERF_DiffStruct.H>

Collaboration diagram for DiffChoice:

Public Member Functions
void	init_params (std::string pp_prefix)
	Read diffusion options from the input parameter database. More...
void	display ()
	Print the configured diffusion options. More...

Public Attributes
MolecDiffType	molec_diff_type = MolecDiffType::Constant
	Selected molecular transport model. More...
amrex::Real	alpha_T = zero
	Kinematic temperature diffusivity [m2/s]. More...
amrex::Real	alpha_C = zero
	Kinematic scalar diffusivity [m2/s]. More...
amrex::Real	rho0_trans = one
	Reference density used to compute dynamic diffusion coefficients [kg/m3]. More...
amrex::Real	rhoAlpha_T = zero
	Dynamic temperature diffusion coefficient [kg/(m-s)]. More...
amrex::Real	rhoAlpha_C = zero
	Dynamic scalar diffusion coefficient [kg/(m-s)]. More...
amrex::Real	dynamic_viscosity = zero
	Dynamic viscosity for momentum diffusion [kg/(m-s)]. More...
bool	eb_diff_constraint_x = false
	Whether to constrain EB diffusion in the x direction. More...
bool	eb_diff_constraint_y = false
	Whether to constrain EB diffusion in the y direction. More...
bool	eb_diff_constraint_z = false
	Whether to constrain EB diffusion in the z direction. More...

Detailed Description

Container holding diffusion-related choices

Member Function Documentation

display()

void DiffChoice::display ( )

inline

Print the configured diffusion options.

    {
        amrex::Print() << "Diffusion choices: " << std::endl;
        amrex::Print() << "    rho0_trans              : " << rho0_trans << std::endl;
        amrex::Print() << "    alpha_T                 : " << alpha_T << std::endl;
        amrex::Print() << "    alpha_C                 : " << alpha_C << std::endl;
        amrex::Print() << "    dynamic_viscosity       : " << dynamic_viscosity << std::endl;
 
        if (molec_diff_type == MolecDiffType::Constant) {
            amrex::Print() << "Using constant molecular diffusivity (relevant for DNS)" << std::endl;
        } else if (molec_diff_type == MolecDiffType::None) {
            amrex::Print() << "Not using any molecular diffusivity, i.e. using the modeled turbulent diffusivity"
            << std::endl;
        }
    }

Referenced by SolverChoice::display().

Here is the caller graph for this function:

init_params()

void DiffChoice::init_params ( std::string  pp_prefix )

inline

Read diffusion options from the input parameter database.

Parameters

pp_prefix

ParmParse prefix for the ERF input namespace.

    {
        amrex::ParmParse pp(pp_prefix);
 
        static std::string molec_diff_type_string = "None";
        pp.query("molec_diff_type",molec_diff_type_string);
 
        if (!molec_diff_type_string.compare("Constant")) {
            molec_diff_type = MolecDiffType::Constant;
        } else if (!molec_diff_type_string.compare("ConstantAlpha")) {
            molec_diff_type = MolecDiffType::ConstantAlpha;
        } else if (!molec_diff_type_string.compare("None")) {
            molec_diff_type = MolecDiffType::None;
        } else {
            amrex::Error("Don't know this molec_diff_type");
        }
 
        if (molec_diff_type != MolecDiffType::None) {
            pp.query("alpha_T", alpha_T);
            pp.query("alpha_C", alpha_C);
            pp.query("dynamic_viscosity", dynamic_viscosity);
            pp.query("rho0_trans", rho0_trans);
            pp.query("eb_diff_constraint_x", eb_diff_constraint_x);
            pp.query("eb_diff_constraint_y", eb_diff_constraint_y);
            pp.query("eb_diff_constraint_z", eb_diff_constraint_z);
        }
 
        // Compute relevant forms of diffusion parameters
        rhoAlpha_T = rho0_trans * alpha_T;
        rhoAlpha_C = rho0_trans * alpha_C;
 
        if (molec_diff_type == MolecDiffType::ConstantAlpha) {
            amrex::Print() << "Using constant kinematic diffusion coefficients" << std::endl;
            amrex::Print() << "  momentum : " << dynamic_viscosity/rho0_trans << " m^2/s" << std::endl;
            amrex::Print() << "  temperature : " << alpha_T << " m^2/s" << std::endl;
            amrex::Print() << "  scalar : " << alpha_C << " m^2/s" << std::endl;
        }
        else if (molec_diff_type == MolecDiffType::Constant) {
            amrex::Print() << "Using constant dynamic diffusion coefficients" << std::endl;
            amrex::Print() << "  momentum : " << dynamic_viscosity << " kg/(m-s)" << std::endl;
            amrex::Print() << "  temperature : " << rhoAlpha_T << " kg/(m-s)" << std::endl;
            amrex::Print() << "  scalar : " << rhoAlpha_C << " kg/(m-s)" << std::endl;
        }
 
    }

Referenced by SolverChoice::init_params().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

alpha_C

DiffChoice::alpha_C = zero

Kinematic scalar diffusivity [m2/s].

Referenced by display(), erf_slow_rhs_post(), erf_slow_rhs_pre(), and init_params().

alpha_T

DiffChoice::alpha_T = zero

Kinematic temperature diffusivity [m2/s].

Referenced by display(), erf_slow_rhs_post(), erf_slow_rhs_pre(), and init_params().

dynamic_viscosity

DiffChoice::dynamic_viscosity = zero

Dynamic viscosity for momentum diffusion [kg/(m-s)].

Referenced by DiffusionSrcForMom_EB(), display(), erf_make_tau_terms(), ImplicitDiffForMomLU_N(), ImplicitDiffForMomLU_S(), ImplicitDiffForMomLU_T(), init_params(), and ERF::InitData_post().

eb_diff_constraint_x

DiffChoice::eb_diff_constraint_x = false

Whether to constrain EB diffusion in the x direction.

Referenced by DiffusionSrcForMom_EB(), and init_params().

eb_diff_constraint_y

DiffChoice::eb_diff_constraint_y = false

Whether to constrain EB diffusion in the y direction.

Referenced by DiffusionSrcForMom_EB(), and init_params().

eb_diff_constraint_z

DiffChoice::eb_diff_constraint_z = false

Whether to constrain EB diffusion in the z direction.

Referenced by DiffusionSrcForMom_EB(), and init_params().

molec_diff_type

DiffChoice::molec_diff_type = MolecDiffType::Constant

Selected molecular transport model.

Referenced by ERF::advance_dycore(), SolverChoice::check_params(), DiffusionSrcForMom_EB(), display(), erf_make_tau_terms(), erf_slow_rhs_post(), erf_slow_rhs_pre(), ImplicitDiffForMomLU_N(), ImplicitDiffForMomLU_S(), ImplicitDiffForMomLU_T(), init_params(), and ERF::InitData_post().

rho0_trans

DiffChoice::rho0_trans = one

Reference density used to compute dynamic diffusion coefficients [kg/m3].

Referenced by DiffusionSrcForMom_EB(), display(), erf_make_tau_terms(), ImplicitDiffForMomLU_N(), ImplicitDiffForMomLU_S(), ImplicitDiffForMomLU_T(), init_params(), and ERF::InitData_post().

rhoAlpha_C

DiffChoice::rhoAlpha_C = zero

Dynamic scalar diffusion coefficient [kg/(m-s)].

Referenced by init_params().

rhoAlpha_T

DiffChoice::rhoAlpha_T = zero

Dynamic temperature diffusion coefficient [kg/(m-s)].

Referenced by init_params().

---

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

• Source/DataStructs/ERF_DiffStruct.H