ERF_ShocTransportStruct.H File Reference

#include <AMReX_ParmParse.H>
#include <algorithm>
#include <cctype>
#include <string>

Include dependency graph for ERF_ShocTransportStruct.H:

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

Go to the source code of this file.

Enumerations
enum class	ShocTransportMode { StateUpdate }
enum class	ShocMomentumTransport { None , StateUpdate }

Functions
const char *	shoc_transport_mode_name (ShocTransportMode mode)
const char *	shoc_momentum_transport_name (ShocMomentumTransport mode)
bool	shoc_uses_momentum_state_update (ShocMomentumTransport mode)
bool	shoc_disables_momentum_transport (ShocMomentumTransport mode)
std::string	shoc_to_lower (std::string value)
bool	parse_shoc_transport_mode_string (std::string value, ShocTransportMode &mode, std::string &error_message)
bool	parse_shoc_momentum_transport_string (std::string value, ShocMomentumTransport &mode, std::string &error_message)
void	read_shoc_transport_modes (ShocTransportMode &transport_mode, ShocMomentumTransport &momentum_transport)
	Read the native SHOC transport modes from the erf.shoc input namespace. More...

Enumeration Type Documentation

ShocMomentumTransport

enum ShocMomentumTransport

strong

Enumerator
None
StateUpdate

{
    None,
    StateUpdate
};

ShocTransportMode

enum ShocTransportMode

strong

Enumerator
StateUpdate

{
    StateUpdate
};

Function Documentation

parse_shoc_momentum_transport_string()

bool parse_shoc_momentum_transport_string ( std::string  value, ShocMomentumTransport &  mode, std::string &  error_message  )

inline

{
    value = shoc_to_lower(value);
    if (value == "none") {
        mode = ShocMomentumTransport::None;
        return true;
    }
    if (value == "state_update") {
        mode = ShocMomentumTransport::StateUpdate;
        return true;
    }
    if (value == "host_diffusion") {
        error_message =
            "erf.shoc.momentum_transport = host_diffusion has been removed for native SHOC. Use 'state_update' to retain SHOC momentum transport, or 'none' to disable SHOC momentum transport.";
        return false;
    }
 
    error_message = "erf.shoc.momentum_transport must be 'none' or 'state_update'";
    return false;
}

Referenced by read_shoc_transport_modes().

Here is the call graph for this function:

Here is the caller graph for this function:

parse_shoc_transport_mode_string()

bool parse_shoc_transport_mode_string ( std::string  value, ShocTransportMode &  mode, std::string &  error_message  )

inline

{
    value = shoc_to_lower(value);
    if (value == "state_update") {
        mode = ShocTransportMode::StateUpdate;
        return true;
    }
    if (value == "host_diffusion") {
        error_message =
            "erf.shoc.transport_mode = host_diffusion has been removed for native SHOC. Use erf.shoc.transport_mode = state_update.";
        return false;
    }
    if (value == "tendencies") {
        error_message =
            "erf.shoc.transport_mode = tendencies has been removed for native SHOC. Use erf.shoc.transport_mode = state_update. Native SHOC now applies its coupled column increment before the dycore to avoid splitting theta and momentum from moisture.";
        return false;
    }
 
    error_message = "erf.shoc.transport_mode must be 'state_update'";
    return false;
}

Referenced by read_shoc_transport_modes().

Here is the call graph for this function:

Here is the caller graph for this function:

read_shoc_transport_modes()

void read_shoc_transport_modes ( ShocTransportMode &  transport_mode, ShocMomentumTransport &  momentum_transport  )

inline

Read the native SHOC transport modes from the erf.shoc input namespace.

This is the single parse point shared by SolverChoice and the SHOC runtime options, so the dycore and the SHOC driver can never disagree about which component owns transport. Values that are absent from the inputs leave the incoming modes untouched.

{
    amrex::ParmParse pp("erf.shoc");
 
    std::string transport_mode_string;
    if (pp.query("transport_mode", transport_mode_string)) {
        std::string error_message;
        if (!parse_shoc_transport_mode_string(transport_mode_string,
                                              transport_mode,
                                              error_message)) {
            amrex::Abort(error_message.c_str());
        }
    }
 
    std::string momentum_transport_string;
    if (pp.query("momentum_transport", momentum_transport_string)) {
        std::string error_message;
        if (!parse_shoc_momentum_transport_string(momentum_transport_string,
                                                  momentum_transport,
                                                  error_message)) {
            amrex::Abort(error_message.c_str());
        }
    }
}

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

Here is the call graph for this function:

Here is the caller graph for this function:

shoc_disables_momentum_transport()

bool shoc_disables_momentum_transport ( ShocMomentumTransport  mode )

inline

{
    return (mode == ShocMomentumTransport::None);
}

Referenced by ShocDriver::disables_momentum_transport(), and SolverChoice::host_owns_vertical_momentum_diffusion().

Here is the caller graph for this function:

shoc_momentum_transport_name()

const char* shoc_momentum_transport_name ( ShocMomentumTransport  mode )

inline

{
    switch (mode) {
    case ShocMomentumTransport::None:        return "none";
    case ShocMomentumTransport::StateUpdate: return "state_update";
    }
    return "unknown";
}

Referenced by ShocDriver::print_debug_summary().

Here is the caller graph for this function:

shoc_to_lower()

std::string shoc_to_lower ( std::string  value )

inline

{
    std::transform(value.begin(), value.end(), value.begin(),
                   [] (unsigned char c) { return static_cast<char>(std::tolower(c)); });
    return value;
}

Referenced by parse_shoc_momentum_transport_string(), and parse_shoc_transport_mode_string().

Here is the caller graph for this function:

shoc_transport_mode_name()

const char* shoc_transport_mode_name ( ShocTransportMode  mode )

inline

{
    switch (mode) {
    case ShocTransportMode::StateUpdate: return "state_update";
    }
    return "unknown";
}

Referenced by ShocDriver::print_debug_summary().

Here is the caller graph for this function:

shoc_uses_momentum_state_update()

bool shoc_uses_momentum_state_update ( ShocMomentumTransport  mode )

inline

{
    return (mode == ShocMomentumTransport::StateUpdate);
}

Referenced by ShocImplicit::finalize_from_pdf(), and ShocDriver::uses_momentum_state_update().

Here is the caller graph for this function: