https://mooseframework.inl.gov
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | Private Member Functions | Friends | List of all members
ExpressionBuilder::EBTerm Class Reference

User facing host object for an expression tree. More...

#include <ExpressionBuilder.h>

Public Member Functions

 __attribute__ ((noinline)) EBTerm()
 
 EBTerm (const EBTerm &term)
 
 ~EBTerm ()
 
 EBTerm (int number)
 
 EBTerm (Real number)
 
 EBTerm (const char *symbol)
 
 operator std::string () const
 
EBTerm & operator= (const EBTerm &term)
 
unsigned int substitute (const EBSubstitutionRule &rule)
 
unsigned int substitute (const EBSubstitutionRuleList &rules)
 
const EBTermNode * getRoot () const
 
EBTermNode * cloneRoot () const
 
 UNARY_OP_IMPLEMENT (-, NEG) UNARY_OP_IMPLEMENT(!
 
 BINARY_OP_IMPLEMENT (+, ADD) BINARY_OP_IMPLEMENT(-
 
SUB BINARY_OP_IMPLEMENT MUL BINARY_OP_IMPLEMENT (/, DIV) BINARY_OP_IMPLEMENT(%
 
SUB BINARY_OP_IMPLEMENT MUL MOD BINARY_OP_IMPLEMENT (<, LESS) BINARY_OP_IMPLEMENT(>
 
SUB BINARY_OP_IMPLEMENT MUL MOD GREATER BINARY_OP_IMPLEMENT (<=, LESSEQ) BINARY_OP_IMPLEMENT(>
 
SUB BINARY_OP_IMPLEMENT MUL MOD GREATER GREATEREQ BINARY_OP_IMPLEMENT (==, EQ) BINARY_OP_IMPLEMENT(!
 
 BINARYCOMP_OP_IMPLEMENT (+=, ADD) BINARYCOMP_OP_IMPLEMENT(-
 
SUB BINARYCOMP_OP_IMPLEMENT MUL BINARYCOMP_OP_IMPLEMENT (/=, DIV) BINARYCOMP_OP_IMPLEMENT(%
 

Protected Attributes

EBTermNode * _root
 

Private Member Functions

 EBTerm (EBTermNode *root)
 

Friends

EBTermList operator, (const ExpressionBuilder::EBTerm &larg, const ExpressionBuilder::EBTerm &rarg)
 
EBTermList operator, (const ExpressionBuilder::EBTerm &larg, const ExpressionBuilder::EBTermList &rargs)
 
EBTermList operator, (const ExpressionBuilder::EBTermList &largs, const ExpressionBuilder::EBTerm &rarg)
 
std::ostream & operator<< (std::ostream &os, const EBTerm &term)
 
LOGICNOT friend EBTerm sin (const EBTerm &)
 Unary functions.
 
EBTerm cos (const EBTerm &)
 
EBTerm tan (const EBTerm &)
 
EBTerm abs (const EBTerm &)
 
EBTerm log (const EBTerm &)
 
EBTerm log2 (const EBTerm &)
 
EBTerm log10 (const EBTerm &)
 
EBTerm exp (const EBTerm &)
 
EBTerm sinh (const EBTerm &)
 
EBTerm cosh (const EBTerm &)
 
EBTerm tanh (const EBTerm &)
 
EBTerm conditional (const EBTerm &, const EBTerm &, const EBTerm &)
 Ternary functions.
 
SUB BINARYCOMP_OP_IMPLEMENT MUL MOD friend EBTerm min (const EBTerm &, const EBTerm &)
 Binary functions.
 
EBTerm max (const EBTerm &, const EBTerm &)
 
EBTerm pow (const EBTerm &, const EBTerm &)
 
template<typename T >
EBTerm pow (const EBTerm &, T exponent)
 
EBTerm atan2 (const EBTerm &, const EBTerm &)
 
EBTerm hypot (const EBTerm &, const EBTerm &)
 
EBTerm plog (const EBTerm &, const EBTerm &)
 

Detailed Description

User facing host object for an expression tree.

Each EBTerm contains a _root node pointer to an EBTermNode object. The _root pointer should never be NULL, but it should be safe if it ever is. The default constructor assigns a EBTempIDNode to _root with a unique ID.

Definition at line 370 of file ExpressionBuilder.h.

Constructor & Destructor Documentation

◆ EBTerm() [1/5]

ExpressionBuilder::EBTerm::EBTerm ( const EBTerm &  term)
inline

Definition at line 381 of file ExpressionBuilder.h.

381: _root(term.cloneRoot()) {}

◆ ~EBTerm()

ExpressionBuilder::EBTerm::~EBTerm ( )
inline

Definition at line 382 of file ExpressionBuilder.h.

382{ delete _root; };

◆ EBTerm() [2/5]

ExpressionBuilder::EBTerm::EBTerm ( EBTermNode *  root)
inlineprivate

Definition at line 386 of file ExpressionBuilder.h.

386: _root(root) {}

◆ EBTerm() [3/5]

ExpressionBuilder::EBTerm::EBTerm ( int  number)
inline

Definition at line 390 of file ExpressionBuilder.h.

390: _root(new EBNumberNode<int>(number)) {}

◆ EBTerm() [4/5]

ExpressionBuilder::EBTerm::EBTerm ( Real  number)
inline

Definition at line 391 of file ExpressionBuilder.h.

391: _root(new EBNumberNode<Real>(number)) {}

◆ EBTerm() [5/5]

ExpressionBuilder::EBTerm::EBTerm ( const char *  symbol)
inline

Definition at line 392 of file ExpressionBuilder.h.

392: _root(new EBSymbolNode(symbol)) {}

Member Function Documentation

◆ __attribute__()

ExpressionBuilder::EBTerm::__attribute__ ( (noinline)  )
inline

Definition at line 376 of file ExpressionBuilder.h.

377 : _root(new EBTempIDNode(reinterpret_cast<unsigned long long>(this)))
378 {
379 }

◆ BINARY_OP_IMPLEMENT() [1/5]

ExpressionBuilder::EBTerm::BINARY_OP_IMPLEMENT ( +  ,
ADD   
)

◆ BINARY_OP_IMPLEMENT() [2/5]

SUB BINARY_OP_IMPLEMENT MUL ExpressionBuilder::EBTerm::BINARY_OP_IMPLEMENT ( /  ,
DIV   
)

◆ BINARY_OP_IMPLEMENT() [3/5]

SUB BINARY_OP_IMPLEMENT MUL MOD ExpressionBuilder::EBTerm::BINARY_OP_IMPLEMENT ( )

◆ BINARY_OP_IMPLEMENT() [4/5]

SUB BINARY_OP_IMPLEMENT MUL MOD GREATER ExpressionBuilder::EBTerm::BINARY_OP_IMPLEMENT ( <=  ,
LESSEQ   
)

◆ BINARY_OP_IMPLEMENT() [5/5]

SUB BINARY_OP_IMPLEMENT MUL MOD GREATER GREATEREQ ExpressionBuilder::EBTerm::BINARY_OP_IMPLEMENT ( EQ  )

◆ BINARYCOMP_OP_IMPLEMENT() [1/2]

ExpressionBuilder::EBTerm::BINARYCOMP_OP_IMPLEMENT ( +  ,
ADD   
)

◆ BINARYCOMP_OP_IMPLEMENT() [2/2]

SUB BINARYCOMP_OP_IMPLEMENT MUL ExpressionBuilder::EBTerm::BINARYCOMP_OP_IMPLEMENT ( /  ,
DIV   
)

◆ cloneRoot()

EBTermNode * ExpressionBuilder::EBTerm::cloneRoot ( ) const
inline

Definition at line 420 of file ExpressionBuilder.h.

420{ return _root == NULL ? NULL : _root->clone(); }
ExpressionBuilder::EBTermNode::clone
virtual EBTermNode * clone() const =0

Referenced by BINARY_FUNC_IMPLEMENT(), ExpressionBuilder::EBTermSubstitution::EBTermSubstitution(), and operator=().

◆ getRoot()

const EBTermNode * ExpressionBuilder::EBTerm::getRoot ( ) const
inline

Definition at line 419 of file ExpressionBuilder.h.

419{ return _root; }

Referenced by ExpressionBuilder::EBTermSubstitution::EBTermSubstitution().

◆ operator std::string()

ExpressionBuilder::EBTerm::operator std::string ( ) const
inline

Definition at line 405 of file ExpressionBuilder.h.

405{ return _root->stringify(); }
ExpressionBuilder::EBTermNode::stringify
virtual std::string stringify() const =0

◆ operator=()

EBTerm & ExpressionBuilder::EBTerm::operator= ( const EBTerm &  term)
inline

Definition at line 408 of file ExpressionBuilder.h.

409 {
410 delete _root;
411 _root = term.cloneRoot();
412 return *this;
413 }

◆ substitute() [1/2]

unsigned int ExpressionBuilder::EBTerm::substitute ( const EBSubstitutionRule &  rule)

Definition at line 416 of file ExpressionBuilder.C.

417{
418 EBSubstitutionRuleList rules(1);
419 rules[0] = &rule;
420 return substitute(rules);
421}
ExpressionBuilder::EBTerm::substitute
unsigned int substitute(const EBSubstitutionRule &rule)
Definition ExpressionBuilder.C:416
ExpressionBuilder::EBSubstitutionRuleList
std::vector< const EBSubstitutionRule * > EBSubstitutionRuleList
Definition ExpressionBuilder.h:59

Referenced by ExpressionBuilder::EBSubstitutionRuleTyped< Node_T >::apply(), and ExpressionBuilder::EBFunction::substitute().

◆ substitute() [2/2]

unsigned int ExpressionBuilder::EBTerm::substitute ( const EBSubstitutionRuleList &  rules)

Definition at line 424 of file ExpressionBuilder.C.

425{
426 unsigned int nrule = rules.size();
427
428 if (_root == NULL)
429 return 0;
430
431 for (unsigned int i = 0; i < nrule; ++i)
432 {
433 EBTermNode * replace = rules[i]->apply(_root);
434 if (replace != NULL)
435 {
436 delete _root;
437 _root = replace;
438 return 1;
439 }
440 }
441
442 return _root->substitute(rules);
443}
ExpressionBuilder::EBTermNode::substitute
virtual unsigned int substitute(const EBSubstitutionRuleList &)
Definition ExpressionBuilder.h:69

◆ UNARY_OP_IMPLEMENT()

ExpressionBuilder::EBTerm::UNARY_OP_IMPLEMENT ( -  ,
NEG   
)

Friends And Related Symbol Documentation

◆ abs

EBTerm abs ( const EBTerm &  )
friend

◆ atan2

EBTerm atan2 ( const EBTerm &  ,
const EBTerm &   
)
friend

◆ conditional

EBTerm conditional ( const EBTerm &  ,
const EBTerm &  ,
const EBTerm &   
)
friend

Ternary functions.

◆ cos

EBTerm cos ( const EBTerm &  )
friend

◆ cosh

EBTerm cosh ( const EBTerm &  )
friend

◆ exp

EBTerm exp ( const EBTerm &  )
friend

◆ hypot

EBTerm hypot ( const EBTerm &  ,
const EBTerm &   
)
friend

◆ log

EBTerm log ( const EBTerm &  )
friend

◆ log10

EBTerm log10 ( const EBTerm &  )
friend

◆ log2

EBTerm log2 ( const EBTerm &  )
friend

◆ max

EBTerm max ( const EBTerm &  ,
const EBTerm &   
)
friend

◆ min

SUB BINARYCOMP_OP_IMPLEMENT MUL MOD friend EBTerm min ( const EBTerm &  ,
const EBTerm &   
)
friend

Binary functions.

◆ operator, [1/3]

EBTermList operator, ( const ExpressionBuilder::EBTerm &  larg,
const ExpressionBuilder::EBTerm &  rarg 
)
friend

Definition at line 13 of file ExpressionBuilder.C.

14{
15 return {larg, rarg};
16}

◆ operator, [2/3]

EBTermList operator, ( const ExpressionBuilder::EBTerm &  larg,
const ExpressionBuilder::EBTermList &  rargs 
)
friend

Definition at line 19 of file ExpressionBuilder.C.

20{
21 ExpressionBuilder::EBTermList list = {larg};
22 list.insert(list.end(), rargs.begin(), rargs.end());
23 return list;
24}
ExpressionBuilder::EBTermList
std::vector< EBTerm > EBTermList
Definition ExpressionBuilder.h:57

◆ operator, [3/3]

EBTermList operator, ( const ExpressionBuilder::EBTermList &  largs,
const ExpressionBuilder::EBTerm &  rarg 
)
friend

Definition at line 27 of file ExpressionBuilder.C.

28{
29 ExpressionBuilder::EBTermList list = largs;
30 list.push_back(rarg);
31 return list;
32}

◆ operator<<

std::ostream & operator<< ( std::ostream &  os,
const EBTerm &  term 
)
friend

Definition at line 34 of file ExpressionBuilder.C.

36{
37 if (term._root != NULL)
38 return os << *term._root;
39 else
40 return os << "[NULL]";
41}

◆ plog

EBTerm plog ( const EBTerm &  ,
const EBTerm &   
)
friend

◆ pow [1/2]

EBTerm pow ( const EBTerm &  ,
const EBTerm &   
)
friend

◆ pow [2/2]

template<typename T >
EBTerm pow ( const EBTerm &  left,
T  exponent 
)
friend

Definition at line 690 of file ExpressionBuilder.h.

691{
692 return ExpressionBuilder::EBTerm(
693 new ExpressionBuilder::EBBinaryOpTermNode(left.cloneRoot(),
694 new ExpressionBuilder::EBNumberNode<T>(exponent),
695 ExpressionBuilder::EBBinaryOpTermNode::POW));
696}
ExpressionBuilder::EBBinaryOpTermNode
Node representing a binary operator.
Definition ExpressionBuilder.h:207
ExpressionBuilder::EBNumberNode
Template class for leaf nodes holding numbers in the expression tree.
Definition ExpressionBuilder.h:80
ExpressionBuilder::EBTerm
User facing host object for an expression tree.
Definition ExpressionBuilder.h:371

◆ sin

LOGICNOT friend EBTerm sin ( const EBTerm &  )
friend

Unary functions.

◆ sinh

EBTerm sinh ( const EBTerm &  )
friend

◆ tan

EBTerm tan ( const EBTerm &  )
friend

◆ tanh

EBTerm tanh ( const EBTerm &  )
friend

Member Data Documentation

◆ _root

EBTermNode* ExpressionBuilder::EBTerm::_root
protected

Definition at line 423 of file ExpressionBuilder.h.

Referenced by BINARY_FUNC_IMPLEMENT(), cloneRoot(), getRoot(), operator std::string(), operator=(), and ~EBTerm().

The documentation for this class was generated from the following files:
Generated on Fri Aug 21 2026 13:42:43 for https://mooseframework.inl.gov by doxygen 1.9.8