ERF_TurbStruct.H File Reference

#include <AMReX_ParallelDescriptor.H>
#include <ERF_MYNNStruct.H>

Include dependency graph for ERF_TurbStruct.H:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	TurbChoice

Functions
	AMREX_ENUM (LESType, None, Smagorinsky, Smagorinsky2D, Deardorff)
	Large-eddy simulation closure type. More...
	AMREX_ENUM (RANSType, None, kEqn)
	Reynolds-averaged turbulence closure type. More...
	AMREX_ENUM (PBLType, None, MYJ, MYNN25, MYNNEDMF, YSU, YSUNew, MRF, SHOC, EAMXX_SHOC, NATIVE_SHOC)
	Planetary boundary-layer closure type. More...
	AMREX_ENUM (StratType, theta, thetav, thetal)
	Thermodynamic variable used for stability stratification. More...
template<typename T >
int	query_one_or_per_level (const amrex::ParmParse &pp, const char *query_string, T &query_var, const int lev, const int maxlev)
	Query a scalar or per-level input value. More...
template<typename T >
int	query_one_or_per_level_enum_case_insensitive (const amrex::ParmParse &pp, const char *query_string, T &query_var, const int lev, const int maxlev)
	Query a scalar or per-level enum input value using case-insensitive matching. More...

Function Documentation

AMREX_ENUM() [1/4]

AMREX_ENUM	(	LESType	,
		None	,
		Smagorinsky	,
		Smagorinsky2D	,
		Deardorff
	)

Large-eddy simulation closure type.

AMREX_ENUM() [2/4]

AMREX_ENUM	(	PBLType	,
		None	,
		MYJ	,
		MYNN25	,
		MYNNEDMF	,
		YSU	,
		YSUNew	,
		MRF	,
		SHOC	,
		EAMXX_SHOC	,
		NATIVE_SHOC
	)

Planetary boundary-layer closure type.

AMREX_ENUM() [3/4]

AMREX_ENUM	(	RANSType	,
		None	,
		kEqn
	)

Reynolds-averaged turbulence closure type.

AMREX_ENUM() [4/4]

AMREX_ENUM	(	StratType	,
		theta	,
		thetav	,
		thetal
	)

Thermodynamic variable used for stability stratification.

query_one_or_per_level()

template<typename T >

int query_one_or_per_level	(	const amrex::ParmParse &	pp,
		const char *	query_string,
		T &	query_var,
		const int	lev,
		const int	maxlev
	)

Query a scalar or per-level input value.

Template Parameters

T	Value type accepted by ParmParse::query.

Parameters

pp	ParmParse object to query.
query_string	Input key to query.
query_var	Destination value for the requested level.
lev	AMR level index.
maxlev	Maximum AMR level configured for the run.

Returns

ParmParse query result, or zero if the key is absent.

{
  int count = pp.countval(query_string);
  if (count == 0) {
    return 0; // nothing to do
  } else if (count == 1) {
    // In this case, we assume the same value is used at every level
    return pp.query(query_string, query_var);
  } else if (count >= maxlev + 1) {
    // In this case, there may be more values than levels so we
    // will just read the number of values we need and ignore the
    // extra levels
    return pp.query(query_string, query_var, lev);
  } else {
    // In this case, there is more than one value AND there
    // are more levels than values; as an example, if max_level = 2
    // but count = 2 so we have three levels but only two values --
    // it is not clear how to interpret this so we abort
    amrex::Error(
      "For parmparse variable " + pp.prefixedName(query_string) +
      ": if specified, specify once total or at least once for each level");
    return 0; // avoid compiler warning
  }
}

Referenced by TurbChoice::init_params().

Here is the call graph for this function:

Here is the caller graph for this function:

query_one_or_per_level_enum_case_insensitive()

template<typename T >

int query_one_or_per_level_enum_case_insensitive	(	const amrex::ParmParse &	pp,
		const char *	query_string,
		T &	query_var,
		const int	lev,
		const int	maxlev
	)

Query a scalar or per-level enum input value using case-insensitive matching.

Template Parameters

T	Enum type accepted by ParmParse::query_enum_case_insensitive.

Parameters

pp	ParmParse object to query.
query_string	Input key to query.
query_var	Destination enum value for the requested level.
lev	AMR level index.
maxlev	Maximum AMR level configured for the run.

Returns

ParmParse query result, or zero if the key is absent.

{
  int count = pp.countval(query_string);
  if (count == 0) {
    return 0; // nothing to do
  } else if (count == 1) {
    // In this case, we assume the same value is used at every level
    return pp.query_enum_case_insensitive(query_string, query_var);
  } else if (count >= maxlev + 1) {
    // In this case, there may be more values than levels so we
    // will just read the number of values we need and ignore the
    // extra levels
    return pp.query_enum_case_insensitive(query_string, query_var, lev);
  } else {
    // In this case, there is more than one value AND there
    // are more levels than values; as an example, if max_level = 2
    // but count = 2 so we have three levels but only two values --
    // it is not clear how to interpret this so we abort
    amrex::Error(
      "For parmparse variable " + pp.prefixedName(query_string) +
      ": if specified, specify once total or at least once for each level");
    return 0; // avoid compiler warning
  }
}

Referenced by TurbChoice::init_params(), and SolverChoice::init_params().

Here is the call graph for this function:

Here is the caller graph for this function: