ERF_TurbStruct.H File Reference

#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)
	AMREX_ENUM (RANSType, None, kEqn)
	AMREX_ENUM (PBLType, None, MYJ, MYNN25, MYNNEDMF, YSU, MRF, SHOC)
	AMREX_ENUM (StratType, theta, thetav, thetal)
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)
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)

Function Documentation

AMREX_ENUM() [1/4]

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

AMREX_ENUM() [2/4]

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

AMREX_ENUM() [3/4]

AMREX_ENUM	(	RANSType	,
		None	,
		kEqn
	)

AMREX_ENUM() [4/4]

AMREX_ENUM	(	StratType	,
		theta	,
		thetav	,
		thetal
	)

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
	)

{
  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
	)

{
  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 SolverChoice::init_params().

Here is the call graph for this function:

Here is the caller graph for this function: