ExpressionBuilder::EBTermSubstitution Class Reference

Generic Substitution rule to replace all occurences of a given symbol node term with a user defined term. More...

#include <ExpressionBuilder.h>

Inheritance diagram for ExpressionBuilder::EBTermSubstitution:

Public Member Functions
	EBTermSubstitution (const EBTerm &find, const EBTerm &replace)
virtual	~EBTermSubstitution ()
virtual EBTermNode *	apply (const EBTermNode *) const

Protected Member Functions
virtual EBTermNode *	substitute (const EBSymbolNode &) const

Protected Attributes
std::string	_find
EBTermNode *	_replace

Detailed Description

Generic Substitution rule to replace all occurences of a given symbol node term with a user defined term.

This is used by EBFunction.

Definition at line 334 of file ExpressionBuilder.h.

Constructor & Destructor Documentation

EBTermSubstitution()

ExpressionBuilder::EBTermSubstitution::EBTermSubstitution	(	const EBTerm &	find,
		const EBTerm &	replace
	)

Definition at line 445 of file ExpressionBuilder.C.

{
  // the expression we want to substitute (has to be a symbol node)
  const EBSymbolNode * find_root = dynamic_cast<const EBSymbolNode *>(find.getRoot());
  if (find_root == NULL)
    mooseError("Function arguments must be pure symbols.");
  _find = find_root->stringify();
 
  // the term we want to substitute with
  if (replace.getRoot() != NULL)
    _replace = replace.cloneRoot();
  else
    mooseError("Trying to substitute in an empty term for ", _find);
}

~EBTermSubstitution()

virtual ExpressionBuilder::EBTermSubstitution::~EBTermSubstitution ( )

inlinevirtual

Definition at line 338 of file ExpressionBuilder.h.

{ delete _replace; }

Member Function Documentation

apply()

ExpressionBuilder::EBTermNode * ExpressionBuilder::EBSubstitutionRuleTyped< EBSymbolNode >::apply ( const EBTermNode *  node ) const

virtualinherited

Implements ExpressionBuilder::EBSubstitutionRule.

Definition at line 322 of file ExpressionBuilder.h.

{
  const Node_T * match_node = dynamic_cast<const Node_T *>(node);
  if (match_node == NULL)
    return NULL;
  else
    return substitute(*match_node);
}

substitute()

ExpressionBuilder::EBTermNode * ExpressionBuilder::EBTermSubstitution::substitute ( const EBSymbolNode &  node ) const

protectedvirtual

Implements ExpressionBuilder::EBSubstitutionRuleTyped< EBSymbolNode >.

Definition at line 462 of file ExpressionBuilder.C.

{
  if (node.stringify() == _find)
    return _replace->clone();
  else
    return NULL;
}

Member Data Documentation

_find

std::string ExpressionBuilder::EBTermSubstitution::_find

protected

Definition at line 342 of file ExpressionBuilder.h.

_replace

EBTermNode* ExpressionBuilder::EBTermSubstitution::_replace

protected

Definition at line 343 of file ExpressionBuilder.h.

Referenced by ~EBTermSubstitution().

---

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

• phase_field/include/utils/ExpressionBuilder.h
• phase_field/src/utils/ExpressionBuilder.C