inciter::ctr::OutVar struct

Output variable.

Contents

Constructors, destructors, conversion operators

OutVar(char v = 0, ncomp_t f = 0, Centering c = Centering::NODE, const std::string& n = {}, const std::string& a = {}, const std::string& m = {}) explicit

Public functions

auto operator<(const OutVar& outvar) const -> bool
Less-than operator for ordering, used by, e.g., std::set::insert.
auto analytic() const -> bool
auto primitive() const -> bool

Public variables

char var
Variable name.
ncomp_t field
Field ID.
Centering centering
Centering.
std::string name
Human readable name (built-in, code knows it)
std::string alias
Alias (only user knows it)
std::string matvar
Material-based physics label + material id.
tk::GetVarFn getvar
Function to compute variable from numerical solution.

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(char v = 0, ncomp_t f = 0, Centering c = Centering::NODE, const std::string& n = {}, const std::string& a = {}, const std::string& m = {}) explicit

Parameters
v in Variable name
f in Field ID
c in Variable centering
n in Human readable name
a in Alias
m in Material-based physics label + material id

Constructor: initialize all state data

bool inciter::ctr::OutVar::operator<(const OutVar& outvar) const

Less-than operator for ordering, used by, e.g., std::set::insert.

Parameters
outvar in OutVar to compare
Returns Boolean indicating if outvar is less than 'this'

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

Returns True if outvar should be extracted from primitive variable data

Query if outvar is a request for a (multimat) primitive variable

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|