DNDS::ExprtkWrapperEvaluator Class Reference

Thin RAII wrapper over the exprtk expression library. More...

#include <ExprtkWrapper.hpp>

Public Member Functions
	ExprtkWrapperEvaluator ()=default
	ExprtkWrapperEvaluator (const ExprtkWrapperEvaluator &)=delete
ExprtkWrapperEvaluator &	operator= (const ExprtkWrapperEvaluator &)=delete
	ExprtkWrapperEvaluator (ExprtkWrapperEvaluator &&)=delete
ExprtkWrapperEvaluator &	operator= (ExprtkWrapperEvaluator &&)=delete
void	AddScalar (const std::string &name, real init=0)
	Register a scalar variable. init is accepted for API symmetry but currently ignored (scalars default to 0).
void	AddVector (const std::string &name, int size)
	Register a dense vector variable named name of length size.
real &	Var (const std::string &name)
	Mutable reference to a scalar variable's current value.
real &	VarVec (const std::string &name, int i)
	Mutable reference to element i of a vector variable.
index	VarVecSize (const std::string &name)
	Length of a registered vector variable.
bool	Compiled () const
	Whether Compile has been called and the expression parsed successfully.
void	Compile (const std::string &expr)
	Compile expr. Throws (via DNDS_check_throw) on parse error.
real	Evaluate ()
	Evaluate the compiled expression with the current variable values.
void	Clear ()
	Release the compiled expression and parser. Must be called before re-binding variables.
	~ExprtkWrapperEvaluator ()

Detailed Description

Thin RAII wrapper over the exprtk expression library.

Compiles a user-supplied math expression once (with named scalar and vector variables) and evaluates it many times against variable values set through Var / VarVec. Used for user-defined initial conditions and boundary functions read from config JSON (see docs/guides/array_usage.md and CFV config files).

Typical usage:

ExprtkWrapperEvaluator e;
e.AddScalar("t");
e.AddVector("x", 3);
e.Compile("sin(x[0]) * cos(t)");
e.Var("t") = 0.5;
e.VarVec("x", 0) = 0.1;
real val = e.Evaluate();

The type-erased void* members hide the exprtk symbol_table / expression / parser types so exprtk headers stay out of the public API.

Definition at line 38 of file ExprtkWrapper.hpp.

Constructor & Destructor Documentation

ExprtkWrapperEvaluator() [1/3]

DNDS::ExprtkWrapperEvaluator::ExprtkWrapperEvaluator ( )

default

ExprtkWrapperEvaluator() [2/3]

DNDS::ExprtkWrapperEvaluator::ExprtkWrapperEvaluator ( const ExprtkWrapperEvaluator &  )

delete

ExprtkWrapperEvaluator() [3/3]

DNDS::ExprtkWrapperEvaluator::ExprtkWrapperEvaluator ( ExprtkWrapperEvaluator &&  )

delete

~ExprtkWrapperEvaluator()

DNDS::ExprtkWrapperEvaluator::~ExprtkWrapperEvaluator ( )

inline

Definition at line 97 of file ExprtkWrapper.hpp.

Here is the call graph for this function:

Member Function Documentation

AddScalar()

void DNDS::ExprtkWrapperEvaluator::AddScalar ( const std::string &  name, real  init = 0  )

inline

Register a scalar variable. init is accepted for API symmetry but currently ignored (scalars default to 0).

Note

Calling any Add* invalidates a previously compiled expression.

Definition at line 61 of file ExprtkWrapper.hpp.

Here is the call graph for this function:

AddVector()

void DNDS::ExprtkWrapperEvaluator::AddVector ( const std::string &  name, int  size  )

inline

Register a dense vector variable named name of length size.

Definition at line 68 of file ExprtkWrapper.hpp.

Here is the call graph for this function:

Clear()

void DNDS::ExprtkWrapperEvaluator::Clear

(

)

Release the compiled expression and parser. Must be called before re-binding variables.

Definition at line 78 of file ExprtkWrapper.cpp.

Here is the caller graph for this function:

Compile()

void DNDS::ExprtkWrapperEvaluator::Compile

(

const std::string &

expr

)

Compile expr. Throws (via DNDS_check_throw) on parse error.

Definition at line 16 of file ExprtkWrapper.cpp.

Here is the call graph for this function:

Compiled()

bool DNDS::ExprtkWrapperEvaluator::Compiled ( ) const

inline

Whether Compile has been called and the expression parsed successfully.

Definition at line 82 of file ExprtkWrapper.hpp.

Here is the caller graph for this function:

Evaluate()

real DNDS::ExprtkWrapperEvaluator::Evaluate

(

)

Evaluate the compiled expression with the current variable values.

Definition at line 71 of file ExprtkWrapper.cpp.

Here is the call graph for this function:

operator=() [1/2]

ExprtkWrapperEvaluator & DNDS::ExprtkWrapperEvaluator::operator= ( const ExprtkWrapperEvaluator &  )

delete

operator=() [2/2]

ExprtkWrapperEvaluator & DNDS::ExprtkWrapperEvaluator::operator= ( ExprtkWrapperEvaluator &&  )

delete

Var()

real & DNDS::ExprtkWrapperEvaluator::Var ( const std::string &  name )

inline

Mutable reference to a scalar variable's current value.

Definition at line 75 of file ExprtkWrapper.hpp.

VarVec()

real & DNDS::ExprtkWrapperEvaluator::VarVec ( const std::string &  name, int  i  )

inline

Mutable reference to element i of a vector variable.

Definition at line 77 of file ExprtkWrapper.hpp.

VarVecSize()

index DNDS::ExprtkWrapperEvaluator::VarVecSize ( const std::string &  name )

inline

Length of a registered vector variable.

Definition at line 79 of file ExprtkWrapper.hpp.

---

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

• /home/runner/work/DNDSR/DNDSR/src/DNDS/ExprtkWrapper.hpp
• /home/runner/work/DNDSR/DNDSR/src/DNDS/ExprtkWrapper.cpp