inciter::ctr::OutVar struct

Output variable.

Contents

Constructors, destructors, conversion operators

OutVar(Centering c = Centering::NODE, const std::string& n = {}, const std::string& a = "", tk::ncomp_t f = 0, const std::string& vn = "null") explicit

Public functions

auto analytic() const -> bool
auto primitive(const PDEType& iPDE) const -> bool

Public variables

Centering centering
Centering.
std::string name
Human readable name.
std::string alias
user specified alias to the name
tk::ncomp_t field
Field ID.
std::string varFnIdx
Material-based physics label + material id.

Pack/Unpack: Serialize OutVar object for Charm++

void pup(PUP::er& p)
void operator|(PUP::er& p, OutVar& v)

Function documentation

inciter::ctr::OutVar::OutVar(Centering c = Centering::NODE, const std::string& n = {}, const std::string& a = "", tk::ncomp_t f = 0, const std::string& vn = "null") explicit

Parameters
c in Variable centering
n in Human readable name
a
f in Field ID
vn in Var function name

Constructor: initialize all state data

bool inciter::ctr::OutVar::analytic() const

Returns True if outvar is a request for an analytic solution

Query if outvar is a request for an analytic solution

bool inciter::ctr::OutVar::primitive(const PDEType& iPDE) const

Parameters
iPDE in PDE type
Returns True if outvar should be extracted from primitive variable data

Query if outvar is a request for a primitive variable This function returns whether the requested variable is a part of the vector of primitive variables. This changes according to which system of PDEs is configured.

void inciter::ctr::OutVar::pup(PUP::er& p)

Parameters
p in/out Charm++'s PUP::er serializer object reference

Pack/Unpack serialize member function

void inciter::ctr::OutVar::operator|(PUP::er& p, OutVar& v)

Parameters
p in/out Charm++'s PUP::er serializer object reference
v in/out OutVar object reference

Pack/Unpack serialize operator|