axom::runtime_policy Namespace Reference

Enumerations
enum class	Policy { seq = 0 , omp = 1 , cuda = 2 , hip = 3 }
	Execution policies. The supported set depends on Axom's configuration. More...

Functions
Policy	nameToPolicy (const std::string &name)
std::string	policyToName (Policy policy)
static auto	format_as (Policy pol)
	Utility function to allow formating a Policy. More...

Variables
static const std::map< std::string, Policy >	s_nameToPolicy
	Mapping from policy name to policy enum. More...
static const std::map< Policy, std::string >	s_policyToName
	Mapping from policy enum to policy name. More...

Enumeration Type Documentation

Policy

enum axom::runtime_policy::Policy

strong

Execution policies. The supported set depends on Axom's configuration.

Enumerator
seq
omp
cuda
hip

Function Documentation

nameToPolicy()

Policy axom::runtime_policy::nameToPolicy ( const std::string &  name )

inline

References s_nameToPolicy.

policyToName()

std::string axom::runtime_policy::policyToName ( Policy  policy )

inline

References s_policyToName.

format_as()

static auto axom::runtime_policy::format_as ( Policy  pol )

inlinestatic

Utility function to allow formating a Policy.

Variable Documentation

s_nameToPolicy

const std::map<std::string, Policy> axom::runtime_policy::s_nameToPolicy

static

Initial value:

{
    {"seq", Policy::seq}
 
    , {"omp", Policy::omp}
 
 
    , {"cuda", Policy::cuda}
 
 
    , {"hip", Policy::hip}
 
  }

Mapping from policy name to policy enum.

s_policyToName

const std::map<Policy, std::string> axom::runtime_policy::s_policyToName

static

Initial value:

{
    {Policy::seq, "seq"}
 
    , {Policy::omp, "omp"}
 
 
    , {Policy::cuda, "cuda"}
 
 
    , {Policy::hip, "hip"}
 
  }

Mapping from policy enum to policy name.