Reverse Polish Notation (RPN) evaluator. More...

#include <KokkosFunctionParser.h>

Classes
struct	Instruction
	RPN instruction. More...

Public Member Functions
	RPNEvaluator ()=default
	Default constructor. More...

	RPNEvaluator (const RPNEvaluator &evaluator)
	Copy constructor for parallel dispatch. More...

void	init (const RPNBuilder &builder)
	Initialize RPN evaluator from an RPN builder. More...

KOKKOS_FUNCTION Real	eval (const Real t, const Real3 p, const unsigned int qp=0, Datum *datum=nullptr) const
	Evaluate RPN at point (t,x,y,z) More...

Private Types
enum	VariableType { VariableType::SCALAR, VariableType::FIELD, VariableType::MATERIAL, VariableType::FUNCTION }
	Types of variables. More...

using	Opcode = RPNBuilder::Opcode

Private Attributes
Array< Instruction >	_rpn
	RPN sequence. More...

Array< Real >	_numbers
	Numbers used in the function. More...

Array< Real >	_scalars
	Scalar variables used in the function. More...

Array< VariableValue >	_fields
	Field variables used in the function. More...

Array< MaterialProperty< Real > >	_properties
	Material properties used in the function. More...

Array< Function >	_functions
	Functions used in the function. More...

Array<::Kokkos::pair< VariableType, unsigned int > >	_variables
	Types of variables and indices. More...

std::vector< const void * >	_pointers
	Pointers to the associated quantities of variables. More...

unsigned int	_num_scalars = 0
	Number of scalar variables. More...

unsigned int	_num_fields = 0
	Number of field variables. More...

unsigned int	_num_properties = 0
	Number of material properties. More...

unsigned int	_num_functions = 0
	Number of functions. More...

Static Private Attributes
static constexpr unsigned int	_stack_size = 10
	Fixed stack size. More...

static constexpr double	_epsilon = 1.0e-12
	Epsilon for equality comparison. More...

Detailed Description

Reverse Polish Notation (RPN) evaluator.

Definition at line 341 of file KokkosFunctionParser.h.

Member Typedef Documentation

◆ Opcode

using Moose::Kokkos::RPNEvaluator::Opcode = RPNBuilder::Opcode

private

Definition at line 343 of file KokkosFunctionParser.h.

Member Enumeration Documentation

◆ VariableType

enum Moose::Kokkos::RPNEvaluator::VariableType

strongprivate

Types of variables.

Enumerator
SCALAR
FIELD
MATERIAL
FUNCTION

Definition at line 388 of file KokkosFunctionParser.h.

   {
     SCALAR,
     FIELD,
     MATERIAL,
     FUNCTION
   };

Constructor & Destructor Documentation

◆ RPNEvaluator() [1/2]

Moose::Kokkos::RPNEvaluator::RPNEvaluator ( )

default

Default constructor.

◆ RPNEvaluator() [2/2]

Moose::Kokkos::RPNEvaluator::RPNEvaluator ( const RPNEvaluator & evaluator )

Copy constructor for parallel dispatch.

Member Function Documentation

◆ eval()

KOKKOS_FUNCTION Real Moose::Kokkos::RPNEvaluator::eval	(	const Real	t,
		const Real3	p,
		const unsigned int	qp = `0`,
		Datum *	datum = `nullptr`
	)		const

inline

Evaluate RPN at point (t,x,y,z)

Parameters

t	The time
p	The location in space (x,y,z)
qp	The local quadrature point index
datum	The Datum object of the current thread

Returns: The evaluated value

Definition at line 485 of file KokkosFunctionParser.h.

Referenced by KokkosParsedMaterial::computeQpProperties(), KokkosParsedAux::computeValue(), and KokkosParsedFunction::value().

 {
   Real stack[_stack_size];
 
   // Stack head position
   unsigned int head = 0;
 
   for (unsigned int pos = 0; pos < _rpn.size(); ++pos)
   {
     KOKKOS_ASSERT(head < _stack_size);
 
     const auto inst = _rpn[pos];
 
     switch (_rpn[pos].op)
     {
       case Opcode::NUM:
         stack[head] = _numbers[inst.arg];
         ++head;
         break;
       case Opcode::VAR:
         if (inst.arg < 3)
           stack[head] = p(inst.arg);
         else if (inst.arg == 3)
           stack[head] = t;
         else
         {
           const auto type = _variables[inst.arg].first;
           const auto idx = _variables[inst.arg].second;
 
           switch (type)
           {
             case VariableType::SCALAR:
               stack[head] = _scalars[idx];
               break;
             case VariableType::FIELD:
             {
               KOKKOS_ASSERT(datum);
 
               stack[head] = _fields[idx](*datum, qp);
               break;
             }
             case VariableType::MATERIAL:
             {
               KOKKOS_ASSERT(datum);
 
               stack[head] = _properties[idx](*datum, qp);
               break;
             }
             case VariableType::FUNCTION:
               stack[head] = _functions[idx].value(t, p);
               break;
           }
         }
         ++head;
         break;
       case Opcode::NEG:
         stack[head - 1] = -stack[head - 1];
         break;
       case Opcode::NOT:
         stack[head - 1] = !::Kokkos::round(stack[head - 1]);
         break;
       case Opcode::EQ:
         stack[head - 2] = ::Kokkos::abs(stack[head - 2] - stack[head - 1]) <= _epsilon;
         --head;
         break;
       case Opcode::NEQ:
         stack[head - 2] = ::Kokkos::abs(stack[head - 2] - stack[head - 1]) > _epsilon;
         --head;
         break;
       case Opcode::AND:
         stack[head - 2] = ::Kokkos::round(stack[head - 2]) && ::Kokkos::round(stack[head - 1]);
         --head;
         break;
       case Opcode::OR:
         stack[head - 2] = ::Kokkos::round(stack[head - 2]) || ::Kokkos::round(stack[head - 1]);
         --head;
         break;
       case Opcode::IF:
         stack[head - 3] = ::Kokkos::round(stack[head - 3]) ? stack[head - 2] : stack[head - 1];
         head -= 2;
         break;
         KOKKOS_FPARSER_COMPARE(LT, <, -_epsilon);
         KOKKOS_FPARSER_COMPARE(LEQ, <=, _epsilon);
         KOKKOS_FPARSER_COMPARE(GT, >, _epsilon);
         KOKKOS_FPARSER_COMPARE(GEQ, >=, -_epsilon);
         KOKKOS_FPARSER_BINARY(ADD, +);
         KOKKOS_FPARSER_BINARY(SUB, -);
         KOKKOS_FPARSER_BINARY(MUL, *);
         KOKKOS_FPARSER_BINARY(DIV, /);
         KOKKOS_FPARSER_FUNCTION_1(ABS, abs);
         KOKKOS_FPARSER_FUNCTION_1(ACOS, acos);
         KOKKOS_FPARSER_FUNCTION_1(ACOSH, acosh);
         KOKKOS_FPARSER_FUNCTION_1(ASIN, asin);
         KOKKOS_FPARSER_FUNCTION_1(ASINH, asinh);
         KOKKOS_FPARSER_FUNCTION_1(ATAN, atan);
         KOKKOS_FPARSER_FUNCTION_2(ATAN2, atan2);
         KOKKOS_FPARSER_FUNCTION_1(ATANH, atanh);
         KOKKOS_FPARSER_FUNCTION_1(CBRT, cbrt);
         KOKKOS_FPARSER_FUNCTION_1(CEIL, ceil);
         KOKKOS_FPARSER_FUNCTION_1(COS, cos);
         KOKKOS_FPARSER_FUNCTION_1(COSH, cosh);
         KOKKOS_FPARSER_FUNCTION_INV_1(COT, tan);
         KOKKOS_FPARSER_FUNCTION_INV_1(CSC, sin);
         KOKKOS_FPARSER_FUNCTION_1(EXP, exp);
         KOKKOS_FPARSER_FUNCTION_1(EXP2, exp2);
         KOKKOS_FPARSER_FUNCTION_1(FLOOR, floor);
         KOKKOS_FPARSER_FUNCTION_2(HYPOT, hypot);
         KOKKOS_FPARSER_FUNCTION_1(INT, round);
         KOKKOS_FPARSER_FUNCTION_1(LOG, log);
         KOKKOS_FPARSER_FUNCTION_1(LOG2, log2);
         KOKKOS_FPARSER_FUNCTION_1(LOG10, log10);
         KOKKOS_FPARSER_FUNCTION_2(MAX, max);
         KOKKOS_FPARSER_FUNCTION_2(MIN, min);
         KOKKOS_FPARSER_FUNCTION_2(POW, pow);
         KOKKOS_FPARSER_FUNCTION_INV_1(SEC, cos);
         KOKKOS_FPARSER_FUNCTION_1(SIN, sin);
         KOKKOS_FPARSER_FUNCTION_1(SINH, sinh);
         KOKKOS_FPARSER_FUNCTION_1(SQRT, sqrt);
         KOKKOS_FPARSER_FUNCTION_1(TAN, tan);
         KOKKOS_FPARSER_FUNCTION_1(TANH, tanh);
         KOKKOS_FPARSER_FUNCTION_1(TRUNC, trunc);
     }
   }
 
   KOKKOS_ASSERT(head == 1);
 
   return stack[head - 1];
 }

◆ init()

void Moose::Kokkos::RPNEvaluator::init ( const RPNBuilder & builder )

Initialize RPN evaluator from an RPN builder.

Parameters

builder The RPN builder

Member Data Documentation

◆ _epsilon

constexpr double Moose::Kokkos::RPNEvaluator::_epsilon = 1.0e-12

staticprivate

Epsilon for equality comparison.

Definition at line 453 of file KokkosFunctionParser.h.

Referenced by eval().

◆ _fields

Array<VariableValue> Moose::Kokkos::RPNEvaluator::_fields

private

Field variables used in the function.

Definition at line 411 of file KokkosFunctionParser.h.

Referenced by eval().

◆ _functions

Array<Function> Moose::Kokkos::RPNEvaluator::_functions

private

Functions used in the function.

Definition at line 419 of file KokkosFunctionParser.h.

Referenced by eval().

◆ _num_fields

unsigned int Moose::Kokkos::RPNEvaluator::_num_fields = 0

private

Number of field variables.

Definition at line 436 of file KokkosFunctionParser.h.

◆ _num_functions

unsigned int Moose::Kokkos::RPNEvaluator::_num_functions = 0

private

Number of functions.

Definition at line 444 of file KokkosFunctionParser.h.

◆ _num_properties

unsigned int Moose::Kokkos::RPNEvaluator::_num_properties = 0

private

Number of material properties.

Definition at line 440 of file KokkosFunctionParser.h.

◆ _num_scalars

unsigned int Moose::Kokkos::RPNEvaluator::_num_scalars = 0

private

Number of scalar variables.

Definition at line 432 of file KokkosFunctionParser.h.

◆ _numbers

Array<Real> Moose::Kokkos::RPNEvaluator::_numbers

private

Numbers used in the function.

Definition at line 403 of file KokkosFunctionParser.h.

Referenced by eval().

◆ _pointers

std::vector<const void *> Moose::Kokkos::RPNEvaluator::_pointers

private

Pointers to the associated quantities of variables.

Definition at line 427 of file KokkosFunctionParser.h.

◆ _properties

Array<MaterialProperty<Real> > Moose::Kokkos::RPNEvaluator::_properties

private

Material properties used in the function.

Definition at line 415 of file KokkosFunctionParser.h.

Referenced by eval().

◆ _rpn

Array<Instruction> Moose::Kokkos::RPNEvaluator::_rpn

private

RPN sequence.

Definition at line 399 of file KokkosFunctionParser.h.

Referenced by eval().

◆ _scalars

Array<Real> Moose::Kokkos::RPNEvaluator::_scalars

private

Scalar variables used in the function.

Definition at line 407 of file KokkosFunctionParser.h.

Referenced by eval().

◆ _stack_size

constexpr unsigned int Moose::Kokkos::RPNEvaluator::_stack_size = 10

staticprivate

Fixed stack size.

Definition at line 449 of file KokkosFunctionParser.h.

Referenced by eval().

◆ _variables

Array<::Kokkos::pair<VariableType, unsigned int> > Moose::Kokkos::RPNEvaluator::_variables

private

Types of variables and indices.

Definition at line 423 of file KokkosFunctionParser.h.

Referenced by eval().

The documentation for this class was generated from the following file:

include/kokkos/functions/KokkosFunctionParser.h

Classes

Public Member Functions

Private Types

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ Opcode

Member Enumeration Documentation

◆ VariableType

Constructor & Destructor Documentation

◆ RPNEvaluator() [1/2]

◆ RPNEvaluator() [2/2]

Member Function Documentation

◆ eval()

◆ init()

Member Data Documentation

◆ _epsilon

◆ _fields

◆ _functions

◆ _num_fields

◆ _num_functions

◆ _num_properties

◆ _num_scalars

◆ _numbers

◆ _pointers

◆ _properties

◆ _rpn

◆ _scalars

◆ _stack_size

◆ _variables